Join

Configuration for automatic meeting exit behavior. The bot uses waiting_room_timeout to wait in the waiting room, then noone_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Applies to Google Meet and Microsoft Teams only.

The image to use for the bot, must be a URL. Recommended ratio is 16:9.

We prevent multiple bots with same API key joining a meeting within 5 mins, unless overridden by deduplication_key.

There are no entry messages on Microsoft Teams as guests outside of an organization do not have access to the chat.

A JSON object that allows you to add custom data to a bot for your convenience, e.g. your end user's ID.

The recording mode for the bot, defaults to 'speaker_view'. Supported values are 'speaker_view' and 'audio_only'. 'gallery_view' is currently under development.

Deprecated, do not use.

The default speech to text provider is Gladia.

Reserved has been deprecated in favour of start_time. Unix timestamp (in seconds) for when the bot should join the meeting. The bot joins eaxctly at the start time.

WebSocket streams for 16 kHz audio. Input stream receives audio sent to the bot. Output stream receives audio from the bot.

For your own transcription parameters

A webhook URL to send events to, overrides the webhook URL set in your account settings.

URL that returns a Zoom ZAK token (short-lived access token) for joining authenticated meetings.

A raw Zoom On Behalf Of (OBF) token for joining external Zoom meetings. Required for meetings that enforce authenticated join after March 2, 2026.

URL that returns a Zoom OBF token. The bot will fetch the token from this URL at join time.

The Zoom user ID associated with a stored OAuth connection. When set, the system will automatically fetch an OBF token using the managed OAuth credentials.

For the Own Zoom Credentials feature, we need your zoom sdk id.

For the Own Zoom Credentials feature, we need your zoom sdk pwd.