Zoom Webinars & Registration-Required Meetings

Recall supports sending bots to registration-required Zoom meetings and webinars.

Few things to note:

• This feature is only supported by web bots
• For Webinars, bots must be added as a panelist

When calling the Create Bot api, you should ensure:

• The meeting URL contains the tk parameter. This parameter is automatically generated by zoom for all webinar and registration-required meetings. Note that this tk parameter can be shared among the bot and another participant
• The zoom.user_email field is set
  • Note: This email does not have to match the email that was registered for the event. For simplicity's sake, you can provide a hard-coded email address such as [email protected]
  • This can be provided regardless of whether the meeting is a registration-required Zoom meeting or not

{
  "meeting_url": "meeting_url", // Includes `tk` param
  "zoom": {
    "user_email": "[email protected]"
  }
}

In order for the bot to automatically request permission to record:

• The bot must join the call authenticated as a panelist using signed-in Zoom bots
• The bot must enter the main room first
• The host must be in the main when the bot enters the call

The bot will not automatically request recording permissions if the bot is backstage or if the host is not in the main room when the bot joins the call. The bot also won't re-prompt for recording permissions automatically when the conditions listed above are fulfilled. You can still request permission for the bot to record using the Request Recording Permission api at a later time in the calll

Troubleshooting

Bot can't join email-required meetings

If a Zoom bot attempts to join one of these calls and isn't configured with an email, it will produce a fatal error with the following sub code: zoom_email_required.

To enable bots to join email-required meetings and webinars, you can provide a user_email in the zoom configuration object of your Create Bot request:

{
  "meeting_url": "meeting_url",
  "zoom": {
    "user_email": "[email protected]"
  }
}

If the meeting or webinar requires registration, this email does not have to match the email of the user that registered. You can use any email address

Why isn't the bot accepting request to be promoted to panelist?

The bot cannot be promoted to panelist. Instead the bot must join the call authenticated as a panelist using signed-in Zoom bots