Inviting Participants to Use Apps

To facilitate collaboration during Zoom meetings, you can use the Zoom Apps SDK to enable participants to invite other participants to use your apps.

  • Call getMeetingContext to identify the meeting in which the app is being used.

  • Call getMeetingParticipants to identify meeting participants.

  • Display the list of participants in your app. Include a button or a link in your app to enable users to view and select which participants to send the invitation.

  • Use sendAppInvitation to send invitations to the list of participantIDs the user selected.

    (Optional)

    The API response contains a unique invitation UUID (iid), which can be used as a unique identifier of the app's state that you can store in the app backend.

    Set up a listener for the onSendAppInvitation event and retrieve the invitation UUID (iid). When the recipient opens the app invitation and opens/installs the app, the iid is included in the context header, which you can then use to fetch the correct state from your app backend and render correctly in your app.

Example request

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

Example app context header json with iid

{
    "act": "action payload supplied in the deeplink",
    "exp": "long, the expiration timestamp of this context",
    "iid": "invitation UUID",
    "mid": "string, the Zoom meeting uuid (if in meeting)",
    "ts": "long, the create timestamp of this context",
    "typ": " 'panel' or 'meeting' ",
    "uid": "string, the Zoom user id who open this app"
}