Now Available: Zoom AI Services Summarizer & Translator APIs.

Invite participants to use apps

View as Markdown

Let meeting participants invite other participants to use your Zoom App. To do this, use the Zoom Apps SDK  to identify the meeting and participants, let the user select invitees, and send the invitations.

1. Get the meeting and participant information

Use the following SDK methods:

  • getMeetingContext to identify the current meeting.
  • getMeetingParticipants to get the participants in the meeting.

2. Let the user select participants

Display the meeting participants in your app. Provide a button or link that lets the user select which participants to invite.

3. Send the invitations

Call sendAppInvitation with the participantIDs selected by the user.

The API response includes a unique invitation ID (iid). You can use this ID to associate the invitation with your app state in your backend.

4. Handle the invitation ID

If your app needs to restore or retrieve state when a recipient opens the invitation, set up a listener for the onSendAppInvitation event.

When a recipient opens or installs your app from the invitation, Zoom includes the iid in the app context header. Use the iid to retrieve the corresponding state from your backend and initialize the app.

Example

let invitationUUID = await zoomSdk.sendAppInvitation();

await zoomSdk.addEventListener("onSendAppInvitation", {
  payload: "invitation UUID"
});