Interface ZoomJoinArgs

Arguments to IZoomMeetingSdk.join — what the bot needs to get into a meeting.

interface ZoomJoinArgs {
    BotDisplayName: string;
    MeetingNumber: string;
    Passcode?: string;
    SdkSignature?: string;
    ZakToken?: string;
}

Properties

BotDisplayName: string

The display name the bot appears as in the participant list.

MeetingNumber: string

The Zoom meeting number / id to join (parsed from the join URL or supplied directly).

Passcode?: string

The meeting passcode, when one is required.

SdkSignature?: string

The signed SDK JWT (or equivalent auth payload) authorizing the join. Resolved upstream; never inline secrets.

ZakToken?: string

The ZAK token for joining as an authenticated user / starting on behalf of a host, when applicable.