Meetings


The ZoomMtg.join() function is used to start and join Zoom Meetings.

Prerequisites

Each ZoomMtg.join() call needs to be inside the ZoomMtg.init() success callback.

Here are the properties for the ZoomMtg.join() function. You can get the Meeting number, password, and registrant token from the Zoom Meeting APIs.

KeyValue Description
sdkKeyRequired, your SDK Key.
signatureRequired, your SDK JWT signature.
meetingNumberRequired, the Zoom Meeting or Webinar Number.
passWordRequried, leave as empty string if the Meeting or Webinar only requires the waiting room.
userNameRequired, the name of the user starting or joining the Meeting or Webinar.
userEmailRequired for Webinar, optional for Meeting, required for Meeting and Webinar if registration is required. The email of the user starting or joining the Meeting or Webinar.
tkRequired, the registrants token if your Meeting or Webianr requires registration.
zakRequired, the host's Zoom Access Key (ZAK) token if you are starting a Meeting or Webinar.

For the full set of ZoomMtg.init() and ZoomMtg.join() properties, as well as the Web Meeting SDK APIs and event listeners, please see the Client View Reference.

Start Meeting

To start a Zoom Meeting, you must use have a role value of 1 in your SDK Signature, and pass in the Meeting host's zak token. This enables your Web Meeting SDK to start the Meeting.

ZoomMtg.join({
sdkKey: sdkKey,
signature: signature, // role in SDK Signature needs to be 1
meetingNumber: meetingNumber,
passWord: passWord,
userName: userName,
zak: zakToken, // the host's zak token
success: (success) => {
console.log(success)
},
error: (error) => {
console.log(error)
}
})

Join Meeting

To join a Zoom Meeting, you must use have a role value of 0 in your SDK Signature. This enables your Web Meeting SDK to join any Meeting.

ZoomMtg.join({
sdkKey: sdkKey,
signature: signature, // role in SDK Signature needs to be 0
meetingNumber: meetingNumber,
passWord: passWord,
userName: userName,
success: (success) => {
console.log(success)
},
error: (error) => {
console.log(error)
}
})

Join Meeting with Registration Required

Web Meeting SDK Client View v1.9.6 and above enables users to join registered meetings automatically. Your app handles the join process automatically using the registration token retrieved via the Zoom API.

This feature uses the registration token denoted by the tk value in the query parameter in the registrant's join_url:

{
"join_url": "https://example.zoom.us/w/12345?tk=TOKEN"
}

To get a registrant's token and join the meeting

  1. Call Add meeting registrant, List meeting registrants, or Update registrant's status.

  2. Get the tk value from the response:

{
"registrant_id": "ESJWWYqvTDWFGNUqJzB_bQ",
"id": 96231721187,
"topic": "My Registered websdk Meeting",
"start_time": "2021-05-31T14:00:00Z",
"join_url": "https://example.zoom.us/w/12345?tk=JtbsW3pp3KxPLLrE_y7-968kggkV7R5czHM9c0tVvgpM.DQIAAAAWZ9uI4xZFU0pXV1lxdlREV0ZHTlVxSnpCX2JRAzzzzzz&pwd=Ri0TkdxhXeWRUOITyT3ZDZmOOOGwxQT09&uuid=XX_pII1ZlzIQ42xx3zA2zYrrU"
}

The tk value above is JtbsW3pp3KxPLLrE_y7-968kggkV7R5czHM9c0tVvgpM.DQIAAAAWZ9uI4xZFU0pXV1lxdlREV0ZHTlVxSnpCX2JRAzzzzzz

JavaScript Example

var registrantToken = new URL(response.join_url).searchParams.get('tk')
// Let's imagine that the response is the same and the tk value is:
// JtbsW3pp3KxPLLrE_y7-968kggkV7R5czHM9c0tVvgpM.DQIAAAAWZ9uI4xZFU0pXV1lxdlREV0ZHTlVxSnpCX2JRAzzzzzz
  1. Set the registrant token as the value for tk in ZoomMtg.join():
ZoomMtg.join({
sdkKey: sdkKey,
signature: signature,
meetingNumber: meetingNumber,
passWord: passWord,
userName: userName,
userEmail: userEmail, // userEmail property required
tk: registrantToken, //JtbsW3pp3KxPLLrE_y7-968kggkV7R5czHM9c0tVvgpM.DQIAAAAWZ9uI4xZFU0pXV1lxdlREV0ZHTlVxSnpCX2JRAzzzzzz
success: (success) => {
console.log(success)
},
error: (error) => {
console.log(error)
}
})

Join Meeting with Authentication Required

When using the Web SDK, meeting hosts can require their participants to authenticate either through Single-Sign On (SSO) or from specific domains. Follow the steps below to enable authentication on an account and join an authenticated user through the Web SDK.

Configure Account Authentication Settings

Within Account Settings, first enable the setting Only authenticated users can join meetings. Next you'll need to configure whether the meeting requires Single-Sign On or specific domains to authenticate.

Require Single-Sign On

See Single Sign-On for details.

Click Add Configuration. In the Authentication Configuration, select Sign in to external Single Sign-On (SSO) as the authentication method.

Require Specific Domains

Click Add Configuration. In the Authentication Configuration, select Sign in to Zoom with specified domains as the authentication method. Enter your domain, and click Save.

Enable User-level Default Settings

Within a user's Profile Settings, enable the setting Only authenticated users can join meetings. This can be set as the default for the user's hosted meetings.

Scheduling Meetings with Authentication Profiles

When creating a scheduled meeting, ensure authentication is required in Meeting Options. When scheduling, choose Only authenticated users can join and choose an authentication option.

User accepts authorization

A Zoom Meeting Web SDK Helper application will pop up requesting authorization through OAuth. If authorized, a user will then sign in using their Zoom account through email, Google/Facebook, or SSO.

After authorizing, the user will be able to join the meeting.

Users who see an error message “You cannot authorize the app” will need to install the Web SDK Helper app.

Next Steps

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.