Function join

Parameters

• args: {
      childToken?: string;
      customerKey?: string;
      error: Function;
      meetingNumber: string | number;
      obfToken?: string;
      passWord?: string;
      recordingToken?: string;
      sdkKey?: string;
      signature: string;
      success: Function;
      tk?: string;
      userEmail?: string;
      userName: string;
      zak?: string;
  }

  • OptionalchildToken?: string

    Optional. childToken.

  • OptionalcustomerKey?: string

    Optional. An identifier for the user that you can get back from the Meeting API. Max length 36 char.

  • error: Function

    Callback function in the event of an error.

  • meetingNumber: string | number

    Required, the Zoom meeting or webinar number.

  • OptionalobfToken?: string

    Optional. obfToken.

  • OptionalpassWord?: string

    Required. The meeting’s password. Leave as an empty string if the meeting or webinar only requires the waiting room.

  • OptionalrecordingToken?: string

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

  • OptionalsdkKey?: string

    We remove sdkKey from join params since v4.0.0. You can just use signature.

    Deprecated

  • signature: string

    Required. The signature to start or join a meeting. See https://developers.zoom.us/docs/meeting-sdk/auth/ for details. As of v5.0.0, the signature requires the appKey field appKey:sdkKey or appKey:clientId. if not contain appKey, can't join meeting.

  • success: Function

    Callback function on success.

  • Optionaltk?: string

    Required if registration is required; optional if not. The registrant’s token.

  • OptionaluserEmail?: string

    Required for webinar. Required for meeting if registration is required; optional if not. The email of the user starting or joining the meeting or webinar.

  • userName: string

    Required. The name of the user starting or joining the meeting or webinar.

  • Optionalzak?: string

    Required for hosts starting a meeting or webinar; optional otherwise. The host’s Zoom Access Key (ZAK) token.