Interface JoinOptions

Arguments and options for joining a meeting.

interface JoinOptions {
    customerKey?: string;
    error?: Function;
    meetingNumber: string;
    password?: string;
    recordingToken?: string;
    sdkKey?: string;
    signature: string;
    success?: Function;
    tk?: string;
    userEmail?: string;
    userName: string;
    zak?: string;
}

Properties

customerKey? error? meetingNumber password? recordingToken? sdkKey? signature success? tk? userEmail? userName zak?

Properties

Optional customerKey

customerKey?: string

Param: customerKey

The user's customer key.

Optional error

error?: Function

Param: error

Join error callback.

meetingNumber

meetingNumber: string

Param: meetingNumber

The Zoom Meeting number.

Optional password

password?: string

Param: password

The meeting password.

Optional recordingToken

recordingToken?: string

Param: recordingToken

Optional token to allow local recording. See Get a meeting's join token for local recording for details.

Optional sdkKey

sdkKey?: string

The sdkKey is deprecated for the joinOptions() after v4.0.0. You can just use signature.

Param: sdkKey

The Meeting SDK SDK key or client ID.

Deprecated

signature

signature: string

After v5.0.0, the signature is required to have the appKey field appKey:sdkKey or appKey:clientId. if the appKey is not included, you cannot join the meeting.

Param: signature

The generated signature to create or join the meeting. See Generate the SDK JWT for details.

Optional success

success?: Function

Param: success

Join success callback.

Optional tk

tk?: string

Param: tk

Optional 'tk' param to join a webinar with registration.

Optional userEmail

userEmail?: string

Param: userEmail

The user's email address.

userName

userName: string

Param: userName

The user's name.

Optional zak

zak?: string

Param: zak

Optional 'zak' param to start a meeting or webinar with OAuth.

Settings

Member Visibility

Theme

On This Page

customerKeyerrormeetingNumberpasswordrecordingTokensdkKeysignaturesuccesstkuserEmailuserNamezak