Join

Have a bot join a meeting, now or in the future. You can provide a webhook_url parameter to receive webhook events specific to this bot, overriding your account's default webhook URL. Events include recording completion, failures, and transcription updates.

Authorization

x-meeting-baas-api-key<token>

API key for authentication

In: header

Request Body

application/jsonRequired

automatic_leaveobject

The bot will leave the meeting automatically after the timeout, defaults to 600 seconds.

bot_imagestring | null

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

Format: "uri"

bot_nameRequiredstring

deduplication_keystring | null

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

entry_messagestring | null

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

extraobject

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

Default: null

meeting_urlRequiredstring

recording_modestring | string | string

The recording mode for the bot, defaults to 'speaker_view'.

reservedRequiredboolean

Whether or not the bot should come from the available pool of bots or be a dedicated bot. Reserved bots come in exactly 4 minutes after the request.

speech_to_textAny properties in object,string

The default speech to text provider is Gladia.

start_timeinteger | null

Unix timestamp (in milliseconds) for when the bot should join the meeting. The bot joins 4 minutes before the start time.

Minimum: 0Format: "uint64"

streamingobject

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

webhook_urlstring | null

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

curl -X POST "https://api.meetingbaas.com/bots/" \
  -H "x-meeting-baas-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "automatic_leave": {
      "noone_joined_timeout": 0,
      "waiting_room_timeout": 0
    },
    "bot_image": "http://example.com",
    "bot_name": "string",
    "deduplication_key": "string",
    "entry_message": "string",
    "extra": null,
    "meeting_url": "string",
    "recording_mode": "speaker_view",
    "reserved": true,
    "speech_to_text": {
      "api_key": "string",
      "provider": "Gladia"
    },
    "start_time": 0,
    "streaming": {
      "audio_frequency": "16khz",
      "input": "string",
      "output": "string"
    },
    "webhook_url": "string"
  }'

{
  "bot_id": "41900e0f-e27a-4863-8321-478ccf15bbd8"
}

Authorization

Request Body

Response

TypeScript