Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/docs/api-v2/reference/bots/batchCreateBots.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ _openapi:

Processes each bot creation request sequentially (index 0, 1, 2...). Each item is validated and processed independently. If some bots fail to create, the request still returns 201 with a `data` array containing successful creations and an `errors` array containing failures. Each error includes the `index` of the failed item in the original request array.

**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through the same validation and checks as a single bot creation: platform detection, BYOK transcription check, daily bot cap check, token availability check, and deduplication lock acquisition.
**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through the same validation and checks as a single bot creation: platform detection, transcription key availability, daily bot cap check, token availability check, and deduplication lock acquisition.

**Partial Success:** The response always has `success: true`, even if all items fail. Check the `errors` array to identify failed items. The `data` array contains successfully created bots with their `bot_id` and preserved `extra` metadata. The `errors` array contains failed items with `index`, `code`, `message`, `details`, and preserved `extra` metadata.

Expand Down Expand Up @@ -54,7 +54,7 @@ Create multiple bots in a single request with partial success support.

Processes each bot creation request sequentially (index 0, 1, 2...). Each item is validated and processed independently. If some bots fail to create, the request still returns 201 with a `data` array containing successful creations and an `errors` array containing failures. Each error includes the `index` of the failed item in the original request array.

**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through the same validation and checks as a single bot creation: platform detection, BYOK transcription check, daily bot cap check, token availability check, and deduplication lock acquisition.
**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through the same validation and checks as a single bot creation: platform detection, transcription key availability, daily bot cap check, token availability check, and deduplication lock acquisition.

**Partial Success:** The response always has `success: true`, even if all items fail. Check the `errors` array to identify failed items. The `data` array contains successfully created bots with their `bot_id` and preserved `extra` metadata. The `errors` array contains failed items with `index`, `code`, `message`, `details`, and preserved `extra` metadata.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ _openapi:

Processes each scheduled bot creation request sequentially. Each item is validated and processed independently. Token reservation and daily bot cap checks are NOT performed at creation time - they are performed when each bot actually joins the meeting.

**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through validation: platform detection, BYOK transcription check, and join time validation. Unlike immediate bot creation, daily bot cap and token availability are not checked at creation time.
**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through validation: platform detection, transcription key availability, and join time validation. Unlike immediate bot creation, daily bot cap and token availability are not checked at creation time.

**Partial Success:** The response always has `success: true`, even if all items fail. Check the `errors` array to identify failed items. The `data` array contains successfully scheduled bots with their `bot_id` and preserved `extra` metadata.

Expand All @@ -22,7 +22,6 @@ _openapi:
**Error Scenarios:**
- Validation errors: Invalid join time, invalid meeting URL, invalid configuration
- Platform detection failures: `INVALID_MEETING_PLATFORM`
- BYOK not enabled: `BYOK_TRANSCRIPTION_NOT_ENABLED_ON_PLAN`
- System failures: `BOT_CREATE_FAILED`

**Note:** Daily bot cap and token availability are checked when each bot joins, not at creation time. If these checks fail at join time, the bot will transition to `failed` status and send a failure webhook.
Expand Down Expand Up @@ -59,7 +58,7 @@ Create multiple scheduled bots in a single request with partial success support.

Processes each scheduled bot creation request sequentially. Each item is validated and processed independently. Token reservation and daily bot cap checks are NOT performed at creation time - they are performed when each bot actually joins the meeting.

**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through validation: platform detection, BYOK transcription check, and join time validation. Unlike immediate bot creation, daily bot cap and token availability are not checked at creation time.
**Processing Order:** Items are processed in the order they appear in the request array. Each item goes through validation: platform detection, transcription key availability, and join time validation. Unlike immediate bot creation, daily bot cap and token availability are not checked at creation time.

**Partial Success:** The response always has `success: true`, even if all items fail. Check the `errors` array to identify failed items. The `data` array contains successfully scheduled bots with their `bot_id` and preserved `extra` metadata.

Expand All @@ -68,7 +67,6 @@ Create multiple scheduled bots in a single request with partial success support.
**Error Scenarios:**
- Validation errors: Invalid join time, invalid meeting URL, invalid configuration
- Platform detection failures: `INVALID_MEETING_PLATFORM`
- BYOK not enabled: `BYOK_TRANSCRIPTION_NOT_ENABLED_ON_PLAN`
- System failures: `BOT_CREATE_FAILED`

**Note:** Daily bot cap and token availability are checked when each bot joins, not at creation time. If these checks fail at join time, the bot will transition to `failed` status and send a failure webhook.
Expand Down
30 changes: 23 additions & 7 deletions content/docs/api-v2/reference/bots/createBot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,22 @@ _openapi:
bot_image_config: Configuration for how bot avatar images are
displayed. Only relevant when multiple images are provided in
bot_image.
- content: |-
bot_name: The name of the bot.
- content: >-
bot_name: The name requested for the bot.


This name is displayed for anonymous joins. For an authenticated
Microsoft Teams join using `teams_config`, Microsoft Teams ignores
this value and displays the signed-in Microsoft 365 account's display
name and profile instead.


This name will be displayed as the bot's name in the meeting.
For a Microsoft Teams meeting the name must be one Teams accepts for a
guest, or the request is rejected: at most 50 characters; only
letters, numbers, spaces and ' ’ . _ @ - · ・; no consecutive spaces;
and no leading, trailing or consecutive periods. This applies to
authenticated joins too, because a failed sign-in falls back to
joining as a guest under this name.
- content: callback_config
- content: >-
callback_enabled: Enable callback for this bot. When enabled, the
Expand Down Expand Up @@ -151,9 +163,13 @@ _openapi:
signed-in Microsoft account.


- credential_id: pin a specific login.
Microsoft Teams displays the selected account's Microsoft 365 name and
profile; `bot_name` is ignored for the authenticated join.

- email_group: pool selector (preferred — takes priority).

- credential_id: pin a specific login and display identity.

- email_group: least-loaded pool selector (takes priority).

- fallback: 'fail' (default) or 'anonymous' on saturation.

Expand All @@ -166,7 +182,7 @@ _openapi:
participants when first joining the meeting, and finally switches to
silence_timeout monitoring once participants are detected. Zoom only
uses waiting_room_timeout. Optional max_recording_duration sets a hard
cap on total recording time (up to 6 hours).
cap on total recording time (up to 12 hours).
- content: >-
timeout_config.grace_period: The grace period in seconds at the start
of the meeting during which no timeout conditions (waiting room, no
Expand All @@ -183,7 +199,7 @@ _openapi:
When null, the default 4-hour internal timeout applies.


Range: 7200–21600 seconds (2–6 hours)
Range: 7200–43200 seconds (2–12 hours)
- content: >-
timeout_config.no_one_joined_timeout: The timeout in seconds for the
bot to wait for participants to join before leaving the meeting.
Expand Down
30 changes: 23 additions & 7 deletions content/docs/api-v2/reference/bots/createScheduledBot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,22 @@ _openapi:
bot_image_config: Configuration for how bot avatar images are
displayed. Only relevant when multiple images are provided in
bot_image.
- content: |-
bot_name: The name of the bot.
- content: >-
bot_name: The name requested for the bot.


This name is displayed for anonymous joins. For an authenticated
Microsoft Teams join using `teams_config`, Microsoft Teams ignores
this value and displays the signed-in Microsoft 365 account's display
name and profile instead.


This name will be displayed as the bot's name in the meeting.
For a Microsoft Teams meeting the name must be one Teams accepts for a
guest, or the request is rejected: at most 50 characters; only
letters, numbers, spaces and ' ’ . _ @ - · ・; no consecutive spaces;
and no leading, trailing or consecutive periods. This applies to
authenticated joins too, because a failed sign-in falls back to
joining as a guest under this name.
- content: callback_config
- content: >-
callback_enabled: Enable callback for this bot. When enabled, the
Expand Down Expand Up @@ -150,9 +162,13 @@ _openapi:
signed-in Microsoft account.


- credential_id: pin a specific login.
Microsoft Teams displays the selected account's Microsoft 365 name and
profile; `bot_name` is ignored for the authenticated join.

- email_group: pool selector (preferred — takes priority).

- credential_id: pin a specific login and display identity.

- email_group: least-loaded pool selector (takes priority).

- fallback: 'fail' (default) or 'anonymous' on saturation.

Expand All @@ -165,7 +181,7 @@ _openapi:
participants when first joining the meeting, and finally switches to
silence_timeout monitoring once participants are detected. Zoom only
uses waiting_room_timeout. Optional max_recording_duration sets a hard
cap on total recording time (up to 6 hours).
cap on total recording time (up to 12 hours).
- content: >-
timeout_config.grace_period: The grace period in seconds at the start
of the meeting during which no timeout conditions (waiting room, no
Expand All @@ -182,7 +198,7 @@ _openapi:
When null, the default 4-hour internal timeout applies.


Range: 7200–21600 seconds (2–6 hours)
Range: 7200–43200 seconds (2–12 hours)
- content: >-
timeout_config.no_one_joined_timeout: The timeout in seconds for the
bot to wait for participants to join before leaving the meeting.
Expand Down
30 changes: 23 additions & 7 deletions content/docs/api-v2/reference/bots/updateScheduledBot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,22 @@ _openapi:
bot_image_config: Configuration for how bot avatar images are
displayed. Only relevant when multiple images are provided in
bot_image.
- content: |-
bot_name: The name of the bot.
- content: >-
bot_name: The name requested for the bot.


This name is displayed for anonymous joins. For an authenticated
Microsoft Teams join using `teams_config`, Microsoft Teams ignores
this value and displays the signed-in Microsoft 365 account's display
name and profile instead.


This name will be displayed as the bot's name in the meeting.
For a Microsoft Teams meeting the name must be one Teams accepts for a
guest, or the request is rejected: at most 50 characters; only
letters, numbers, spaces and ' ’ . _ @ - · ・; no consecutive spaces;
and no leading, trailing or consecutive periods. This applies to
authenticated joins too, because a failed sign-in falls back to
joining as a guest under this name.
- content: callback_config
- content: >-
callback_enabled: Enable callback for this bot. When enabled, the
Expand Down Expand Up @@ -161,9 +173,13 @@ _openapi:
signed-in Microsoft account.


- credential_id: pin a specific login.
Microsoft Teams displays the selected account's Microsoft 365 name and
profile; `bot_name` is ignored for the authenticated join.

- email_group: pool selector (preferred — takes priority).

- credential_id: pin a specific login and display identity.

- email_group: least-loaded pool selector (takes priority).

- fallback: 'fail' (default) or 'anonymous' on saturation.

Expand All @@ -176,7 +192,7 @@ _openapi:
participants when first joining the meeting, and finally switches to
silence_timeout monitoring once participants are detected. Zoom only
uses waiting_room_timeout. Optional max_recording_duration sets a hard
cap on total recording time (up to 6 hours).
cap on total recording time (up to 12 hours).
- content: >-
timeout_config.grace_period: The grace period in seconds at the start
of the meeting during which no timeout conditions (waiting room, no
Expand All @@ -193,7 +209,7 @@ _openapi:
When null, the default 4-hour internal timeout applies.


Range: 7200–21600 seconds (2–6 hours)
Range: 7200–43200 seconds (2–12 hours)
- content: >-
timeout_config.no_one_joined_timeout: The timeout in seconds for the
bot to wait for participants to join before leaving the meeting.
Expand Down
30 changes: 23 additions & 7 deletions content/docs/api-v2/reference/calendars/createCalendarBot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,22 @@ _openapi:
bot_image_config: Configuration for how bot avatar images are
displayed. Only relevant when multiple images are provided in
bot_image.
- content: |-
bot_name: The name of the bot.
- content: >-
bot_name: The name requested for the bot.


This name is displayed for anonymous joins. For an authenticated
Microsoft Teams join using `teams_config`, Microsoft Teams ignores
this value and displays the signed-in Microsoft 365 account's display
name and profile instead.


This name will be displayed as the bot's name in the meeting.
For a Microsoft Teams meeting the name must be one Teams accepts for a
guest, or the request is rejected: at most 50 characters; only
letters, numbers, spaces and ' ’ . _ @ - · ・; no consecutive spaces;
and no leading, trailing or consecutive periods. This applies to
authenticated joins too, because a failed sign-in falls back to
joining as a guest under this name.
- content: callback_config
- content: >-
callback_enabled: Enable callback for this bot. When enabled, the
Expand Down Expand Up @@ -130,9 +142,13 @@ _openapi:
signed-in Microsoft account.


- credential_id: pin a specific login.
Microsoft Teams displays the selected account's Microsoft 365 name and
profile; `bot_name` is ignored for the authenticated join.

- email_group: pool selector (preferred — takes priority).

- credential_id: pin a specific login and display identity.

- email_group: least-loaded pool selector (takes priority).

- fallback: 'fail' (default) or 'anonymous' on saturation.

Expand All @@ -145,7 +161,7 @@ _openapi:
participants when first joining the meeting, and finally switches to
silence_timeout monitoring once participants are detected. Zoom only
uses waiting_room_timeout. Optional max_recording_duration sets a hard
cap on total recording time (up to 6 hours).
cap on total recording time (up to 12 hours).
- content: >-
timeout_config.grace_period: The grace period in seconds at the start
of the meeting during which no timeout conditions (waiting room, no
Expand All @@ -162,7 +178,7 @@ _openapi:
When null, the default 4-hour internal timeout applies.


Range: 7200–21600 seconds (2–6 hours)
Range: 7200–43200 seconds (2–12 hours)
- content: >-
timeout_config.no_one_joined_timeout: The timeout in seconds for the
bot to wait for participants to join before leaving the meeting.
Expand Down
Loading