Zoom Webinars & Registration-Required Meetings

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

Webinars where registration is not required

For webinars where registration is not required:

• The zoom.user_email field must be set when calling the Create Bot endpoint.
  • The zoom.user_email field can be any email address (e.g. [email protected]), except the host's email address.

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

If the requirements above are unmet, the bot will fatal with the following sub-codes:

• zoom_email_required - the bot tried to join a meeting without the zoom.user_email field set.
• zoom_invalid_webinar_invite - zoom.user_email was set to the webinar host's email address.
  • The sub-code message will contain more information about the specific action to take.

Registration-required meetings and webinars

For registration-required meetings and webinars:

• The meeting URL must contain the tk parameter.
  • The tk parameter is automatically generated by zoom for all registration-required meetings and webinars.
  • Users must register for the meeting in order to receive a meeting URL that includes the tk parameter.
    • You will not be able to generate this tk parameter yourself.
  • Multiple participants may share the tk parameter to join the same meeting or webinar.
• In registration-required meetings or webinars, the zoom.user_email field is optional.

If the requirements above are unmet, the bot will fatal with the following sub-code:

• zoom_registration_required: bot tried to join a registration-required meeting or webinar without the tk parameter.

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 requesting to record in Zoom webinars?

If you've manually set your bot to request recording permissions before starting to record a Zoom webinar, then your bot needs to be have the panelist role or co-host role in order to request recording permissions. This requires you to use a Zoom Signed-in Bots and have the webinar host add the bot's Zoom user account as a panelist before the bot joins the call.

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