BaasTypes
@meeting-baas/sdk v7.0.0 - Multi-Provider SDK / BaasTypes
BaasTypes
Interfaces
BatchCreateBotResponse
Properties
success
success:
true
data
data:
BatchCreateBotResponseDataItem[]
Successfully created bots
errors
errors:
BatchCreateBotResponseErrorsItem[]
Bots that failed to create (empty array if all succeeded)
BatchCreateBotResponseInput
Properties
success
success:
true
data
Successfully created bots
errors
errors:
BatchCreateBotResponseInputErrorsItem[]
Bots that failed to create (empty array if all succeeded)
BatchCreateScheduledBotResponse
Properties
success
success:
true
data
Scheduled bots that were successfully created
errors
Scheduled bots that failed to create (empty array if all succeeded)
BatchCreateScheduledBotResponseInput
Properties
success
success:
true
data
Scheduled bots that were successfully created
errors
Scheduled bots that failed to create (empty array if all succeeded)
BotWebhookCompleted
Properties
event
event:
"bot.completed"
The webhook event type
data
data:
BotWebhookCompletedData
extra
extra:
BotWebhookCompletedExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookCompletedInput
Properties
event
event:
"bot.completed"
The webhook event type
data
extra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookFailed
Properties
event
event:
"bot.failed"
The webhook event type
data
data:
BotWebhookFailedData
extra
extra:
BotWebhookFailedExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookFailedInput
Properties
event
event:
"bot.failed"
The webhook event type
data
extra
extra:
BotWebhookFailedInputExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookStatusChange
Properties
event
event:
"bot.status_change"
The webhook event type
data
extra
extra:
BotWebhookStatusChangeExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookStatusChangeInput
Properties
event
event:
"bot.status_change"
The webhook event type
data
extra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CalendarWebhookConnectionCreated
Properties
event
event:
"calendar.connection_created"
The webhook event type
data
CalendarWebhookConnectionCreatedInput
Properties
event
event:
"calendar.connection_created"
The webhook event type
data
CalendarWebhookConnectionDeleted
Properties
event
event:
"calendar.connection_deleted"
The webhook event type
data
CalendarWebhookConnectionDeletedInput
Properties
event
event:
"calendar.connection_deleted"
The webhook event type
data
CalendarWebhookConnectionUpdated
Properties
event
event:
"calendar.connection_updated"
The webhook event type
data
CalendarWebhookConnectionUpdatedInput
Properties
event
event:
"calendar.connection_updated"
The webhook event type
data
CalendarWebhookEventCancelled
Properties
event
event:
"calendar.event_cancelled"
The webhook event type
data
CalendarWebhookEventCancelledInput
Properties
event
event:
"calendar.event_cancelled"
The webhook event type
data
CalendarWebhookEventCreated
Properties
event
event:
"calendar.event_created"
The webhook event type
data
CalendarWebhookEventCreatedInput
Properties
event
event:
"calendar.event_created"
The webhook event type
data
CalendarWebhookEventUpdated
Properties
event
event:
"calendar.event_updated"
The webhook event type
data
CalendarWebhookEventUpdatedInput
Properties
event
event:
"calendar.event_updated"
The webhook event type
data
CalendarWebhookEventsSynced
Properties
event
event:
"calendar.events_synced"
The webhook event type
data
CalendarWebhookEventsSyncedInput
Properties
event
event:
"calendar.events_synced"
The webhook event type
data
CallbackCompleted
Properties
event
event:
"bot.completed"
The webhook event type
data
data:
CallbackCompletedData
extra
extra:
CallbackCompletedExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackCompletedInput
Properties
event
event:
"bot.completed"
The webhook event type
data
extra
extra:
CallbackCompletedInputExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackFailed
Properties
event
event:
"bot.failed"
The webhook event type
data
data:
CallbackFailedData
extra
extra:
CallbackFailedExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackFailedInput
Properties
event
event:
"bot.failed"
The webhook event type
data
data:
CallbackFailedInputData
extra
extra:
CallbackFailedInputExtra
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CreateBotRequestBody
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
CreateBotRequestBodyInput
Properties
bot_name
bot_name:
string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:CreateBotRequestBodyInputBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
meeting_url
meeting_url:
string
The URL of the meeting to join.
Must be a valid HTTPS URL for a Microsoft Teams, Google Meet, or Zoom meeting.
Example: "https://zoom.us/j/123456789" or "https://meet.google.com/abc-defg-hij"
allow_multiple_bots?
optionalallow_multiple_bots:boolean
Whether to allow multiple bots to join the same meeting.
If set to false, only a single bot will be allowed to join using the same meeting URL within the last 5 minutes. This prevents duplicate bots from joining the same meeting.
If set to true (default), multiple bots can join the same meeting URL.
Default: true
recording_mode?
optionalrecording_mode:CreateBotRequestBodyInputRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:CreateBotRequestBodyInputEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:CreateBotRequestBodyInputTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:CreateBotRequestBodyInputZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:CreateBotRequestBodyInputExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.
streaming_config?
optionalstreaming_config:CreateBotRequestBodyInputStreamingConfig
transcription_enabled?
optionaltranscription_enabled:boolean
Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.
transcription_config?
optionaltranscription_config:CreateBotRequestBodyInputTranscriptionConfig
callback_enabled?
optionalcallback_enabled:boolean
Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.
callback_config?
optionalcallback_config:CreateBotRequestBodyInputCallbackConfig
CreateBotResponse
Properties
success
success:
true
data
data:
CreateBotResponseData
CreateBotResponseInput
Properties
success
success:
true
data
CreateCalendarBotResponse
Properties
success
success:
true
data
Event instances that were successfully scheduled for bot recording or had their bots updated/deleted successfully
errors
errors:
CreateCalendarBotResponseErrorsItem[]
Array of errors for event instances that failed to schedule. This array is empty if all event instances were successfully scheduled. Each error object contains information about a specific event instance that could not be scheduled
CreateCalendarBotResponseInput
Properties
success
success:
true
data
Event instances that were successfully scheduled for bot recording or had their bots updated/deleted successfully
errors
errors:
CreateCalendarBotResponseInputErrorsItem[]
Array of errors for event instances that failed to schedule. This array is empty if all event instances were successfully scheduled. Each error object contains information about a specific event instance that could not be scheduled
CreateCalendarConnectionRequestBody
Properties
calendar_platform
calendar_platform:
CreateCalendarConnectionRequestBodyCalendarPlatform
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id
oauth_tenant_id:
string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
raw_calendar_id
raw_calendar_id:
string
The specific calendar ID to connect. Use the 'List Raw Calendars' endpoint to get available calendar IDs. For Google, this is typically the calendar email (e.g., 'primary' or 'user@gmail.com'). For Microsoft, this is the calendar's unique identifier.
Min Length
1
CreateCalendarConnectionRequestBodyInput
Properties
calendar_platform
calendar_platform:
CreateCalendarConnectionRequestBodyInputCalendarPlatform
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id?
optionaloauth_tenant_id:string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
raw_calendar_id
raw_calendar_id:
string
The specific calendar ID to connect. Use the 'List Raw Calendars' endpoint to get available calendar IDs. For Google, this is typically the calendar email (e.g., 'primary' or 'user@gmail.com'). For Microsoft, this is the calendar's unique identifier.
Min Length
1
CreateCalendarConnectionResponse
Properties
success
success:
true
data
CreateCalendarConnectionResponseInput
Properties
success
success:
true
data
CreateScheduledBotResponse
Properties
success
success:
true
data
CreateScheduledBotResponseInput
Properties
success
success:
true
data
DeleteBotDataResponse
Properties
success
success:
true
data
DeleteBotDataResponseInput
Properties
success
success:
true
data
DeleteCalendarBotResponse
Properties
success
success:
true
data
Event instances whose calendar bots were successfully deleted/cancelled
errors
errors:
DeleteCalendarBotResponseErrorsItem[]
Array of errors for event instances whose calendar bots could not be deleted. This array is empty if all requested event instances were successfully deleted
DeleteCalendarBotResponseInput
Properties
success
success:
true
data
Event instances whose calendar bots were successfully deleted/cancelled
errors
errors:
DeleteCalendarBotResponseInputErrorsItem[]
Array of errors for event instances whose calendar bots could not be deleted. This array is empty if all requested event instances were successfully deleted
DeleteCalendarConnectionResponse
Properties
success
success:
true
data
DeleteCalendarConnectionResponseInput
Properties
success
success:
true
data
DeleteScheduledBotResponse
Properties
success
success:
true
data
DeleteScheduledBotResponseInput
Properties
success
success:
true
data
ErrorResponse
Properties
success
success:
false
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ErrorResponseMessage
Human-readable error message
details?
optionaldetails:ErrorResponseDetails
Additional error details (string or null)
ErrorResponseInput
Properties
success?
optionalsuccess:false
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ErrorResponseInputMessage
Human-readable error message
details?
optionaldetails:ErrorResponseInputDetails
Additional error details (string or null)
GetBotDetailsResponse
Properties
success
success:
true
data
GetBotDetailsResponseInput
Properties
success
success:
true
data
GetBotScreenshotsResponse
Properties
success
success:
true
data
cursor
cursor:
GetBotScreenshotsResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
GetBotScreenshotsResponsePrevCursor
Cursor for the previous page (null if on first page)
GetBotScreenshotsResponseInput
Properties
success
success:
true
data
cursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
GetBotScreenshotsResponseInputPrevCursor
Cursor for the previous page (null if on first page)
GetBotStatusResponse
Properties
success
success:
true
data
data:
GetBotStatusResponseData
GetBotStatusResponseInput
Properties
success
success:
true
data
GetCalendarDetailsResponse
Properties
success
success:
true
data
GetCalendarDetailsResponseInput
Properties
success
success:
true
data
GetEventDetailsResponse
Properties
success
success:
true
data
GetEventDetailsResponseInput
Properties
success
success:
true
data
GetScheduledBotResponse
Properties
success
success:
true
data
GetScheduledBotResponseInput
Properties
success
success:
true
data
LeaveBotResponse
Properties
success
success:
true
data
data:
LeaveBotResponseData
LeaveBotResponseInput
Properties
success
success:
true
data
ListBotsResponse
Properties
success
success:
true
data
data:
ListBotsResponseDataItem[]
cursor
cursor:
ListBotsResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListBotsResponsePrevCursor
Cursor for the previous page (null if on first page)
ListBotsResponseInput
Properties
success
success:
true
data
data:
ListBotsResponseInputDataItem[]
cursor
cursor:
ListBotsResponseInputCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListBotsResponseInputPrevCursor
Cursor for the previous page (null if on first page)
ListCalendarsResponse
Properties
success
success:
true
data
data:
ListCalendarsResponseDataItem[]
cursor
cursor:
ListCalendarsResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListCalendarsResponsePrevCursor
Cursor for the previous page (null if on first page)
ListCalendarsResponseInput
Properties
success
success:
true
data
cursor
cursor:
ListCalendarsResponseInputCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListCalendarsResponseInputPrevCursor
Cursor for the previous page (null if on first page)
ListEventSeriesResponse
Properties
success
success:
true
data
data:
ListEventSeriesResponseDataItem[]
cursor
cursor:
ListEventSeriesResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListEventSeriesResponsePrevCursor
Cursor for the previous page (null if on first page)
ListEventSeriesResponseInput
Properties
success
success:
true
data
cursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListEventSeriesResponseInputPrevCursor
Cursor for the previous page (null if on first page)
ListEventsResponse
Properties
success
success:
true
data
data:
ListEventsResponseDataItem[]
cursor
cursor:
ListEventsResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListEventsResponsePrevCursor
Cursor for the previous page (null if on first page)
ListEventsResponseInput
Properties
success
success:
true
data
data:
ListEventsResponseInputDataItem[]
cursor
cursor:
ListEventsResponseInputCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListEventsResponseInputPrevCursor
Cursor for the previous page (null if on first page)
ListRawCalendarsRequestBody
Properties
calendar_platform
calendar_platform:
ListRawCalendarsRequestBodyCalendarPlatform
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id
oauth_tenant_id:
string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
ListRawCalendarsRequestBodyInput
Properties
calendar_platform
calendar_platform:
ListRawCalendarsRequestBodyInputCalendarPlatform
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id?
optionaloauth_tenant_id:string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
ListRawCalendarsResponse
Properties
success
success:
true
data
data:
ListRawCalendarsResponseDataItem[]
ListRawCalendarsResponseInput
Properties
success
success:
true
data
ListScheduledBotsResponse
Properties
success
success:
true
data
cursor
cursor:
ListScheduledBotsResponseCursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListScheduledBotsResponsePrevCursor
Cursor for the previous page (null if on first page)
ListScheduledBotsResponseInput
Properties
success
success:
true
data
cursor
Cursor for the next page (null if no more pages)
prev_cursor
prev_cursor:
ListScheduledBotsResponseInputPrevCursor
Cursor for the previous page (null if on first page)
ResendFinalWebhookResponse
Properties
success
success:
true
data
ResendFinalWebhookResponseInput
Properties
success
success:
true
data
ResubscribeCalendarResponse
Properties
success
success:
true
data
ResubscribeCalendarResponseInput
Properties
success
success:
true
data
RetryCallbackResponse
Properties
success
success:
true
data
RetryCallbackResponseInput
Properties
success
success:
true
data
SyncCalendarResponse
Properties
success
success:
true
data
data:
SyncCalendarResponseData
SyncCalendarResponseInput
Properties
success
success:
true
data
UpdateCalendarBotResponse
Properties
success
success:
true
data
Event instances whose calendar bots were successfully updated
errors
errors:
UpdateCalendarBotResponseErrorsItem[]
Array of errors for event instances whose calendar bots could not be updated. This array is empty if all requested event instances were successfully updated
UpdateCalendarBotResponseInput
Properties
success
success:
true
data
Event instances whose calendar bots were successfully updated
errors
errors:
UpdateCalendarBotResponseInputErrorsItem[]
Array of errors for event instances whose calendar bots could not be updated. This array is empty if all requested event instances were successfully updated
UpdateCalendarConnectionRequestBody
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id
oauth_tenant_id:
string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
UpdateCalendarConnectionRequestBodyInput
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
oauth_client_id
oauth_client_id:
string
Your OAuth 2.0 client ID for the calendar platform.
Min Length
1
oauth_client_secret
oauth_client_secret:
string
Your OAuth 2.0 client secret for the calendar platform.
Min Length
1
oauth_refresh_token
oauth_refresh_token:
string
The OAuth 2.0 refresh token obtained from the user's authorization. Must include 'offline_access' scope (Microsoft) or 'access_type=offline' (Google).
Min Length
1
oauth_tenant_id?
optionaloauth_tenant_id:string
Azure AD tenant ID (required for Microsoft only, defaults to 'common'). Find it in Azure Portal > Azure Active Directory > Overview. Example: '12345678-1234-1234-1234-123456789012'. You can also use 'common', 'organizations', or 'consumers' for multi-tenant scenarios.
UpdateCalendarConnectionResponse
Properties
success
success:
true
data
UpdateCalendarConnectionResponseInput
Properties
success
success:
true
data
UpdateScheduledBotRequestBody
Properties
bot_name?
optionalbot_name:string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:UpdateScheduledBotRequestBodyBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
meeting_url?
optionalmeeting_url:string
The URL of the meeting to join.
Must be a valid HTTPS URL for a Microsoft Teams, Google Meet, or Zoom meeting.
Example: "https://zoom.us/j/123456789" or "https://meet.google.com/abc-defg-hij"
allow_multiple_bots?
optionalallow_multiple_bots:boolean
Whether to allow multiple bots to join the same meeting.
If set to false, only a single bot will be allowed to join using the same meeting URL within the last 5 minutes. This prevents duplicate bots from joining the same meeting.
If set to true (default), multiple bots can join the same meeting URL.
Default: true
recording_mode?
optionalrecording_mode:UpdateScheduledBotRequestBodyRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:UpdateScheduledBotRequestBodyEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:UpdateScheduledBotRequestBodyTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:UpdateScheduledBotRequestBodyZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:UpdateScheduledBotRequestBodyExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.
streaming_config?
optionalstreaming_config:UpdateScheduledBotRequestBodyStreamingConfig
transcription_enabled?
optionaltranscription_enabled:boolean
Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.
transcription_config?
optionaltranscription_config:UpdateScheduledBotRequestBodyTranscriptionConfig
callback_enabled?
optionalcallback_enabled:boolean
Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.
callback_config?
optionalcallback_config:UpdateScheduledBotRequestBodyCallbackConfig
join_at?
optionaljoin_at:string
Update the scheduled join time.
ISO8601 format. Must be at least 4 minutes in the future and cannot be more than 90 days in the future.
Example: "2025-12-25T10:00:00Z"
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
UpdateScheduledBotRequestBodyInput
Properties
bot_name?
optionalbot_name:string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:UpdateScheduledBotRequestBodyInputBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
meeting_url?
optionalmeeting_url:string
The URL of the meeting to join.
Must be a valid HTTPS URL for a Microsoft Teams, Google Meet, or Zoom meeting.
Example: "https://zoom.us/j/123456789" or "https://meet.google.com/abc-defg-hij"
allow_multiple_bots?
optionalallow_multiple_bots:boolean
Whether to allow multiple bots to join the same meeting.
If set to false, only a single bot will be allowed to join using the same meeting URL within the last 5 minutes. This prevents duplicate bots from joining the same meeting.
If set to true (default), multiple bots can join the same meeting URL.
Default: true
recording_mode?
optionalrecording_mode:UpdateScheduledBotRequestBodyInputRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:UpdateScheduledBotRequestBodyInputEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:UpdateScheduledBotRequestBodyInputTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:UpdateScheduledBotRequestBodyInputZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:UpdateScheduledBotRequestBodyInputExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.
streaming_config?
optionalstreaming_config:UpdateScheduledBotRequestBodyInputStreamingConfig
transcription_enabled?
optionaltranscription_enabled:boolean
Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.
transcription_config?
optionaltranscription_config:UpdateScheduledBotRequestBodyInputTranscriptionConfig
callback_enabled?
optionalcallback_enabled:boolean
Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.
callback_config?
optionalcallback_config:UpdateScheduledBotRequestBodyInputCallbackConfig
join_at?
optionaljoin_at:string
Update the scheduled join time.
ISO8601 format. Must be at least 4 minutes in the future and cannot be more than 90 days in the future.
Example: "2025-12-25T10:00:00Z"
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
UpdateScheduledBotResponse
Properties
success
success:
true
data
UpdateScheduledBotResponseInput
Properties
success
success:
true
data
ValidationErrorResponse
Properties
success
success:
false
error
error:
string
Error name
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ValidationErrorResponseMessage
Human-readable error message
ValidationErrorResponseInput
Properties
success?
optionalsuccess:false
error
error:
string
Error name
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ValidationErrorResponseInputMessage
Human-readable error message
Type Aliases
BatchCreateBotResponseDataItem
BatchCreateBotResponseDataItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
bot_id
bot_id:
string
The UUID of the created bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
extra
Custom metadata from the request (for correlation)
BatchCreateBotResponseDataItemExtra
BatchCreateBotResponseDataItemExtra =
BatchCreateBotResponseDataItemExtraAnyOf|null
Custom metadata from the request (for correlation)
BatchCreateBotResponseDataItemExtraAnyOf
BatchCreateBotResponseDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateBotResponseErrorsItem
BatchCreateBotResponseErrorsItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
code
code:
string
Error code for programmatic handling
message
message:
string
Human-readable error message
details
Additional error details (null if no additional details)
extra
Custom metadata from the request (for correlation)
BatchCreateBotResponseErrorsItemDetails
BatchCreateBotResponseErrorsItemDetails =
string|null
Additional error details (null if no additional details)
BatchCreateBotResponseErrorsItemExtra
BatchCreateBotResponseErrorsItemExtra =
BatchCreateBotResponseErrorsItemExtraAnyOf|null
Custom metadata from the request (for correlation)
BatchCreateBotResponseErrorsItemExtraAnyOf
BatchCreateBotResponseErrorsItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateBotResponseInputDataItem
BatchCreateBotResponseInputDataItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
bot_id
bot_id:
string
The UUID of the created bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
extra
Custom metadata from the request (for correlation)
BatchCreateBotResponseInputDataItemExtra
BatchCreateBotResponseInputDataItemExtra =
BatchCreateBotResponseInputDataItemExtraAnyOf|null
Custom metadata from the request (for correlation)
BatchCreateBotResponseInputDataItemExtraAnyOf
BatchCreateBotResponseInputDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateBotResponseInputErrorsItem
BatchCreateBotResponseInputErrorsItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
code
code:
string
Error code for programmatic handling
message
message:
string
Human-readable error message
details
Additional error details (null if no additional details)
extra
Custom metadata from the request (for correlation)
BatchCreateBotResponseInputErrorsItemDetails
BatchCreateBotResponseInputErrorsItemDetails =
string|null
Additional error details (null if no additional details)
BatchCreateBotResponseInputErrorsItemExtra
BatchCreateBotResponseInputErrorsItemExtra =
BatchCreateBotResponseInputErrorsItemExtraAnyOf|null
Custom metadata from the request (for correlation)
BatchCreateBotResponseInputErrorsItemExtraAnyOf
BatchCreateBotResponseInputErrorsItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateBots429
BatchCreateBots429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:BatchCreateBots429Message
Human-readable error message
details?
optionaldetails:BatchCreateBots429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
BatchCreateBots429Details
BatchCreateBots429Details =
string|null
Additional error details (string or null)
BatchCreateBots429Message
BatchCreateBots429Message =
string|null
Human-readable error message
BatchCreateBotsRequestBody
BatchCreateBotsRequestBody =
CreateBotRequestBody[]
Min Items
1
Max Items
100
BatchCreateBotsRequestBodyInput
BatchCreateBotsRequestBodyInput =
CreateBotRequestBodyInput[]
Min Items
1
Max Items
100
BatchCreateScheduledBotResponseDataItem
BatchCreateScheduledBotResponseDataItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
bot_id
bot_id:
string
The UUID of the created scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
extra
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseDataItemExtra
BatchCreateScheduledBotResponseDataItemExtra =
BatchCreateScheduledBotResponseDataItemExtraAnyOf|null
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseDataItemExtraAnyOf
BatchCreateScheduledBotResponseDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateScheduledBotResponseErrorsItem
BatchCreateScheduledBotResponseErrorsItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
code
code:
string
Error code for programmatic handling
message
message:
string
Human-readable error message
details
Additional error details (null if not available)
extra
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseErrorsItemDetails
BatchCreateScheduledBotResponseErrorsItemDetails =
string|null
Additional error details (null if not available)
BatchCreateScheduledBotResponseErrorsItemExtra
BatchCreateScheduledBotResponseErrorsItemExtra =
BatchCreateScheduledBotResponseErrorsItemExtraAnyOf|null
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseErrorsItemExtraAnyOf
BatchCreateScheduledBotResponseErrorsItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateScheduledBotResponseInputDataItem
BatchCreateScheduledBotResponseInputDataItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
bot_id
bot_id:
string
The UUID of the created scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
extra
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseInputDataItemExtra
BatchCreateScheduledBotResponseInputDataItemExtra =
BatchCreateScheduledBotResponseInputDataItemExtraAnyOf|null
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseInputDataItemExtraAnyOf
BatchCreateScheduledBotResponseInputDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateScheduledBotResponseInputErrorsItem
BatchCreateScheduledBotResponseInputErrorsItem =
object
Properties
index
index:
number
0-based index of the item in the request array
Minimum
0
Maximum
9007199254740991
code
code:
string
Error code for programmatic handling
message
message:
string
Human-readable error message
details
details:
BatchCreateScheduledBotResponseInputErrorsItemDetails
Additional error details (null if not available)
extra
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseInputErrorsItemDetails
BatchCreateScheduledBotResponseInputErrorsItemDetails =
string|null
Additional error details (null if not available)
BatchCreateScheduledBotResponseInputErrorsItemExtra
BatchCreateScheduledBotResponseInputErrorsItemExtra =
BatchCreateScheduledBotResponseInputErrorsItemExtraAnyOf|null
Custom metadata from the request (null if not provided)
BatchCreateScheduledBotResponseInputErrorsItemExtraAnyOf
BatchCreateScheduledBotResponseInputErrorsItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BatchCreateScheduledBots429
BatchCreateScheduledBots429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:BatchCreateScheduledBots429Message
Human-readable error message
details?
optionaldetails:BatchCreateScheduledBots429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
BatchCreateScheduledBots429Details
BatchCreateScheduledBots429Details =
string|null
Additional error details (string or null)
BatchCreateScheduledBots429Message
BatchCreateScheduledBots429Message =
string|null
Human-readable error message
BatchCreateScheduledBotsRequestBody
BatchCreateScheduledBotsRequestBody =
CreateScheduledBotRequestBody[]
Min Items
1
Max Items
100
BatchCreateScheduledBotsRequestBodyInput
BatchCreateScheduledBotsRequestBodyInput =
CreateScheduledBotRequestBodyInput[]
Min Items
1
Max Items
100
BotWebhookCompletedData
BotWebhookCompletedData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that completed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookCompletedDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
participants
participants:
BotWebhookCompletedDataParticipants
List of participant names or identifiers who joined the meeting. Null if participant information is not available
speakers
speakers:
BotWebhookCompletedDataSpeakers
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
duration_seconds
duration_seconds:
BotWebhookCompletedDataDurationSeconds
joined_at
joined_at:
BotWebhookCompletedDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
exited_at
exited_at:
BotWebhookCompletedDataExitedAt
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
data_deleted
data_deleted:
boolean
Whether the bot's data (artifacts, recordings) has been deleted. True if data has been permanently removed
video
video:
BotWebhookCompletedDataVideo
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
audio
audio:
BotWebhookCompletedDataAudio
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
diarization
diarization:
BotWebhookCompletedDataDiarization
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
raw_transcription
raw_transcription:
BotWebhookCompletedDataRawTranscription
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
transcription
transcription:
BotWebhookCompletedDataTranscription
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
transcription_provider
transcription_provider:
BotWebhookCompletedDataTranscriptionProvider
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
transcription_ids
transcription_ids:
BotWebhookCompletedDataTranscriptionIds
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
BotWebhookCompletedDataAudio
BotWebhookCompletedDataAudio =
string|null
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
BotWebhookCompletedDataDiarization
BotWebhookCompletedDataDiarization =
string|null
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
BotWebhookCompletedDataDurationSeconds
BotWebhookCompletedDataDurationSeconds =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
BotWebhookCompletedDataEventId
BotWebhookCompletedDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookCompletedDataExitedAt
BotWebhookCompletedDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
BotWebhookCompletedDataJoinedAt
BotWebhookCompletedDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
BotWebhookCompletedDataParticipants
BotWebhookCompletedDataParticipants =
string[] |null
List of participant names or identifiers who joined the meeting. Null if participant information is not available
BotWebhookCompletedDataRawTranscription
BotWebhookCompletedDataRawTranscription =
string|null
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
BotWebhookCompletedDataSpeakers
BotWebhookCompletedDataSpeakers =
string[] |null
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
BotWebhookCompletedDataTranscription
BotWebhookCompletedDataTranscription =
string|null
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
BotWebhookCompletedDataTranscriptionIds
BotWebhookCompletedDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
BotWebhookCompletedDataTranscriptionProvider
BotWebhookCompletedDataTranscriptionProvider =
string|null
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
BotWebhookCompletedDataVideo
BotWebhookCompletedDataVideo =
string|null
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
BotWebhookCompletedExtra
BotWebhookCompletedExtra =
BotWebhookCompletedExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookCompletedExtraAnyOf
BotWebhookCompletedExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BotWebhookCompletedInputData
BotWebhookCompletedInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that completed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookCompletedInputDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
participants
participants:
BotWebhookCompletedInputDataParticipants
List of participant names or identifiers who joined the meeting. Null if participant information is not available
speakers
speakers:
BotWebhookCompletedInputDataSpeakers
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
duration_seconds
duration_seconds:
BotWebhookCompletedInputDataDurationSeconds
joined_at
joined_at:
BotWebhookCompletedInputDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
exited_at
exited_at:
BotWebhookCompletedInputDataExitedAt
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
data_deleted
data_deleted:
boolean
Whether the bot's data (artifacts, recordings) has been deleted. True if data has been permanently removed
video
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
audio
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
diarization
diarization:
BotWebhookCompletedInputDataDiarization
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
raw_transcription
raw_transcription:
BotWebhookCompletedInputDataRawTranscription
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
transcription
transcription:
BotWebhookCompletedInputDataTranscription
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
transcription_provider
transcription_provider:
BotWebhookCompletedInputDataTranscriptionProvider
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
transcription_ids
transcription_ids:
BotWebhookCompletedInputDataTranscriptionIds
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
BotWebhookCompletedInputDataAudio
BotWebhookCompletedInputDataAudio =
string|null
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
BotWebhookCompletedInputDataDiarization
BotWebhookCompletedInputDataDiarization =
string|null
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
BotWebhookCompletedInputDataDurationSeconds
BotWebhookCompletedInputDataDurationSeconds =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
BotWebhookCompletedInputDataEventId
BotWebhookCompletedInputDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookCompletedInputDataExitedAt
BotWebhookCompletedInputDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
BotWebhookCompletedInputDataJoinedAt
BotWebhookCompletedInputDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
BotWebhookCompletedInputDataParticipants
BotWebhookCompletedInputDataParticipants =
string[] |null
List of participant names or identifiers who joined the meeting. Null if participant information is not available
BotWebhookCompletedInputDataRawTranscription
BotWebhookCompletedInputDataRawTranscription =
string|null
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
BotWebhookCompletedInputDataSpeakers
BotWebhookCompletedInputDataSpeakers =
string[] |null
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
BotWebhookCompletedInputDataTranscription
BotWebhookCompletedInputDataTranscription =
string|null
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
BotWebhookCompletedInputDataTranscriptionIds
BotWebhookCompletedInputDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
BotWebhookCompletedInputDataTranscriptionProvider
BotWebhookCompletedInputDataTranscriptionProvider =
string|null
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
BotWebhookCompletedInputDataVideo
BotWebhookCompletedInputDataVideo =
string|null
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
BotWebhookCompletedInputExtra
BotWebhookCompletedInputExtra =
BotWebhookCompletedInputExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookCompletedInputExtraAnyOf
BotWebhookCompletedInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BotWebhookFailedData
BotWebhookFailedData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that failed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookFailedDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
error_message
error_message:
string
Human-readable error message describing why the bot failed
error_code
error_code:
string
Machine-readable error code for programmatic handling. Common codes include 'MEETING_NOT_FOUND', 'MEETING_ENDED', 'BOT_CRASHED', etc.
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
BotWebhookFailedDataEventId
BotWebhookFailedDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookFailedExtra
BotWebhookFailedExtra =
BotWebhookFailedExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookFailedExtraAnyOf
BotWebhookFailedExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BotWebhookFailedInputData
BotWebhookFailedInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that failed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookFailedInputDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
error_message
error_message:
string
Human-readable error message describing why the bot failed
error_code
error_code:
string
Machine-readable error code for programmatic handling. Common codes include 'MEETING_NOT_FOUND', 'MEETING_ENDED', 'BOT_CRASHED', etc.
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
BotWebhookFailedInputDataEventId
BotWebhookFailedInputDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookFailedInputExtra
BotWebhookFailedInputExtra =
BotWebhookFailedInputExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookFailedInputExtraAnyOf
BotWebhookFailedInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BotWebhookStatusChangeData
BotWebhookStatusChangeData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that changed status
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookStatusChangeDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
status
status:
BotWebhookStatusChangeDataStatus
Status information with code, timestamp, and optional status-specific fields
BotWebhookStatusChangeDataEventId
BotWebhookStatusChangeDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookStatusChangeDataStatus
BotWebhookStatusChangeDataStatus =
object
Status information with code, timestamp, and optional status-specific fields
Properties
code
code:
string
The status code (e.g., 'transcribing', 'recording', 'processing')
created_at
created_at:
string
ISO 8601 timestamp when this status change occurred
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
start_time?
optionalstart_time:number
Unix timestamp (seconds) when recording started. Only present for 'in_call_recording' status
Minimum
0
Maximum
9007199254740991
error_message?
optionalerror_message:string
Error message describing what went wrong. Only present for 'recording_failed' status
BotWebhookStatusChangeExtra
BotWebhookStatusChangeExtra =
BotWebhookStatusChangeExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookStatusChangeExtraAnyOf
BotWebhookStatusChangeExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
BotWebhookStatusChangeInputData
BotWebhookStatusChangeInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that changed status
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
BotWebhookStatusChangeInputDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
status
Status information with code, timestamp, and optional status-specific fields
BotWebhookStatusChangeInputDataEventId
BotWebhookStatusChangeInputDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
BotWebhookStatusChangeInputDataStatus
BotWebhookStatusChangeInputDataStatus =
object
Status information with code, timestamp, and optional status-specific fields
Properties
code
code:
string
The status code (e.g., 'transcribing', 'recording', 'processing')
created_at
created_at:
string
ISO 8601 timestamp when this status change occurred
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
start_time?
optionalstart_time:number
Unix timestamp (seconds) when recording started. Only present for 'in_call_recording' status
Minimum
0
Maximum
9007199254740991
error_message?
optionalerror_message:string
Error message describing what went wrong. Only present for 'recording_failed' status
BotWebhookStatusChangeInputExtra
BotWebhookStatusChangeInputExtra =
BotWebhookStatusChangeInputExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
BotWebhookStatusChangeInputExtraAnyOf
BotWebhookStatusChangeInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CalendarWebhookConnectionCreatedData
CalendarWebhookConnectionCreatedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the newly created calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionCreatedDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionCreatedDataCalendarPlatform
CalendarWebhookConnectionCreatedDataCalendarPlatform = typeof
CalendarWebhookConnectionCreatedDataCalendarPlatform[keyof typeofCalendarWebhookConnectionCreatedDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionCreatedDataStatus
CalendarWebhookConnectionCreatedDataStatus = typeof
CalendarWebhookConnectionCreatedDataStatus[keyof typeofCalendarWebhookConnectionCreatedDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CalendarWebhookConnectionCreatedInputData
CalendarWebhookConnectionCreatedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the newly created calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionCreatedInputDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionCreatedInputDataCalendarPlatform
CalendarWebhookConnectionCreatedInputDataCalendarPlatform = typeof
CalendarWebhookConnectionCreatedInputDataCalendarPlatform[keyof typeofCalendarWebhookConnectionCreatedInputDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionCreatedInputDataStatus
CalendarWebhookConnectionCreatedInputDataStatus = typeof
CalendarWebhookConnectionCreatedInputDataStatus[keyof typeofCalendarWebhookConnectionCreatedInputDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CalendarWebhookConnectionDeletedData
CalendarWebhookConnectionDeletedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the deleted calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionDeletedDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
deleted_at
deleted_at:
string
ISO 8601 timestamp when the calendar connection was deleted
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionDeletedDataCalendarPlatform
CalendarWebhookConnectionDeletedDataCalendarPlatform = typeof
CalendarWebhookConnectionDeletedDataCalendarPlatform[keyof typeofCalendarWebhookConnectionDeletedDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionDeletedInputData
CalendarWebhookConnectionDeletedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the deleted calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionDeletedInputDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
deleted_at
deleted_at:
string
ISO 8601 timestamp when the calendar connection was deleted
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionDeletedInputDataCalendarPlatform
CalendarWebhookConnectionDeletedInputDataCalendarPlatform = typeof
CalendarWebhookConnectionDeletedInputDataCalendarPlatform[keyof typeofCalendarWebhookConnectionDeletedInputDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionUpdatedData
CalendarWebhookConnectionUpdatedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the updated calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionUpdatedDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account
status
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was originally created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionUpdatedDataCalendarPlatform
CalendarWebhookConnectionUpdatedDataCalendarPlatform = typeof
CalendarWebhookConnectionUpdatedDataCalendarPlatform[keyof typeofCalendarWebhookConnectionUpdatedDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionUpdatedDataStatus
CalendarWebhookConnectionUpdatedDataStatus = typeof
CalendarWebhookConnectionUpdatedDataStatus[keyof typeofCalendarWebhookConnectionUpdatedDataStatus]
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CalendarWebhookConnectionUpdatedInputData
CalendarWebhookConnectionUpdatedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the updated calendar connection
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account
status
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was originally created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform = typeof
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform[keyof typeofCalendarWebhookConnectionUpdatedInputDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CalendarWebhookConnectionUpdatedInputDataStatus
CalendarWebhookConnectionUpdatedInputDataStatus = typeof
CalendarWebhookConnectionUpdatedInputDataStatus[keyof typeofCalendarWebhookConnectionUpdatedInputDataStatus]
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CalendarWebhookEventCancelledData
CalendarWebhookEventCancelledData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was cancelled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventCancelledDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventCancelledDataSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
cancelled_instances
cancelled_instances:
CalendarWebhookEventCancelledDataCancelledInstancesItem[]
Array of event instances that were cancelled. For one-off events, this contains a single instance. For recurring events, this contains all instances that were cancelled
CalendarWebhookEventCancelledDataCancelledInstancesItem
CalendarWebhookEventCancelledDataCancelledInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingPlatform
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingUrl
CalendarWebhookEventCancelledDataCancelledInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus = typeof
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus[keyof typeofCalendarWebhookEventCancelledDataCancelledInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventCancelledDataEventType
CalendarWebhookEventCancelledDataEventType = typeof
CalendarWebhookEventCancelledDataEventType[keyof typeofCalendarWebhookEventCancelledDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventCancelledDataSeriesId
CalendarWebhookEventCancelledDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventCancelledInputData
CalendarWebhookEventCancelledInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was cancelled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventCancelledInputDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
The UUID of the event series. Null only in rare cases where the series relationship could not be established
cancelled_instances
cancelled_instances:
CalendarWebhookEventCancelledInputDataCancelledInstancesItem[]
Array of event instances that were cancelled. For one-off events, this contains a single instance. For recurring events, this contains all instances that were cancelled
CalendarWebhookEventCancelledInputDataCancelledInstancesItem
CalendarWebhookEventCancelledInputDataCancelledInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingPlatform
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingUrl
CalendarWebhookEventCancelledInputDataCancelledInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus = typeof
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus[keyof typeofCalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventCancelledInputDataEventType
CalendarWebhookEventCancelledInputDataEventType = typeof
CalendarWebhookEventCancelledInputDataEventType[keyof typeofCalendarWebhookEventCancelledInputDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventCancelledInputDataSeriesId
CalendarWebhookEventCancelledInputDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventCreatedData
CalendarWebhookEventCreatedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was created
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventCreatedDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventCreatedDataSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
instances
instances:
CalendarWebhookEventCreatedDataInstancesItem[]
Array of event instances that were created. For one-off events, this contains a single instance. For recurring events, this contains all instances that were created
CalendarWebhookEventCreatedDataEventType
CalendarWebhookEventCreatedDataEventType = typeof
CalendarWebhookEventCreatedDataEventType[keyof typeofCalendarWebhookEventCreatedDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventCreatedDataInstancesItem
CalendarWebhookEventCreatedDataInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventCreatedDataInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventCreatedDataInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCreatedDataInstancesItemMeetingPlatform
CalendarWebhookEventCreatedDataInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCreatedDataInstancesItemMeetingUrl
CalendarWebhookEventCreatedDataInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventCreatedDataInstancesItemStatus
CalendarWebhookEventCreatedDataInstancesItemStatus = typeof
CalendarWebhookEventCreatedDataInstancesItemStatus[keyof typeofCalendarWebhookEventCreatedDataInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventCreatedDataSeriesId
CalendarWebhookEventCreatedDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventCreatedInputData
CalendarWebhookEventCreatedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was created
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventCreatedInputDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventCreatedInputDataSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
instances
instances:
CalendarWebhookEventCreatedInputDataInstancesItem[]
Array of event instances that were created. For one-off events, this contains a single instance. For recurring events, this contains all instances that were created
CalendarWebhookEventCreatedInputDataEventType
CalendarWebhookEventCreatedInputDataEventType = typeof
CalendarWebhookEventCreatedInputDataEventType[keyof typeofCalendarWebhookEventCreatedInputDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventCreatedInputDataInstancesItem
CalendarWebhookEventCreatedInputDataInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventCreatedInputDataInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventCreatedInputDataInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventCreatedInputDataInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCreatedInputDataInstancesItemMeetingPlatform
CalendarWebhookEventCreatedInputDataInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventCreatedInputDataInstancesItemMeetingUrl
CalendarWebhookEventCreatedInputDataInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventCreatedInputDataInstancesItemStatus
CalendarWebhookEventCreatedInputDataInstancesItemStatus = typeof
CalendarWebhookEventCreatedInputDataInstancesItemStatus[keyof typeofCalendarWebhookEventCreatedInputDataInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventCreatedInputDataSeriesId
CalendarWebhookEventCreatedInputDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventUpdatedData
CalendarWebhookEventUpdatedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was updated
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventUpdatedDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventUpdatedDataSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
is_exception
is_exception:
boolean
Whether the updated instance is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
affected_instances
affected_instances:
CalendarWebhookEventUpdatedDataAffectedInstancesItem[]
Array of event instances that were affected by the update. This includes the instance that was directly updated and any related instances
CalendarWebhookEventUpdatedDataAffectedInstancesItem
CalendarWebhookEventUpdatedDataAffectedInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingPlatform
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingUrl
CalendarWebhookEventUpdatedDataAffectedInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus = typeof
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus[keyof typeofCalendarWebhookEventUpdatedDataAffectedInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventUpdatedDataEventType
CalendarWebhookEventUpdatedDataEventType = typeof
CalendarWebhookEventUpdatedDataEventType[keyof typeofCalendarWebhookEventUpdatedDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventUpdatedDataSeriesId
CalendarWebhookEventUpdatedDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventUpdatedInputData
CalendarWebhookEventUpdatedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection where the event was updated
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
CalendarWebhookEventUpdatedInputDataEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventUpdatedInputDataSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
is_exception
is_exception:
boolean
Whether the updated instance is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
affected_instances
affected_instances:
CalendarWebhookEventUpdatedInputDataAffectedInstancesItem[]
Array of event instances that were affected by the update. This includes the instance that was directly updated and any related instances
CalendarWebhookEventUpdatedInputDataAffectedInstancesItem
CalendarWebhookEventUpdatedInputDataAffectedInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingPlatform
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingUrl
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus = typeof
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus[keyof typeofCalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventUpdatedInputDataEventType
CalendarWebhookEventUpdatedInputDataEventType = typeof
CalendarWebhookEventUpdatedInputDataEventType[keyof typeofCalendarWebhookEventUpdatedInputDataEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventUpdatedInputDataSeriesId
CalendarWebhookEventUpdatedInputDataSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventsSyncedData
CalendarWebhookEventsSyncedData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection that was synced
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
events
Array of event series that were synced. Each series contains its event instances
CalendarWebhookEventsSyncedDataEventsItem
CalendarWebhookEventsSyncedDataEventsItem =
object
Properties
event_type
event_type:
CalendarWebhookEventsSyncedDataEventsItemEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventsSyncedDataEventsItemSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
instances
instances:
CalendarWebhookEventsSyncedDataEventsItemInstancesItem[]
Array of event instances that were synced. For one-off events, this contains a single instance. For recurring events, this contains all instances that were synced
CalendarWebhookEventsSyncedDataEventsItemEventType
CalendarWebhookEventsSyncedDataEventsItemEventType = typeof
CalendarWebhookEventsSyncedDataEventsItemEventType[keyof typeofCalendarWebhookEventsSyncedDataEventsItemEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventsSyncedDataEventsItemInstancesItem
CalendarWebhookEventsSyncedDataEventsItemInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingPlatform
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingUrl
CalendarWebhookEventsSyncedDataEventsItemInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus = typeof
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus[keyof typeofCalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventsSyncedDataEventsItemSeriesId
CalendarWebhookEventsSyncedDataEventsItemSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CalendarWebhookEventsSyncedInputData
CalendarWebhookEventsSyncedInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection that was synced
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
events
Array of event series that were synced. Each series contains its event instances
CalendarWebhookEventsSyncedInputDataEventsItem
CalendarWebhookEventsSyncedInputDataEventsItem =
object
Properties
event_type
event_type:
CalendarWebhookEventsSyncedInputDataEventsItemEventType
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
series_id
series_id:
CalendarWebhookEventsSyncedInputDataEventsItemSeriesId
The UUID of the event series. Null only in rare cases where the series relationship could not be established
series_bot_scheduled
series_bot_scheduled:
boolean
Whether a bot has been scheduled for all occurrences of this series. True if a calendar bot schedule exists for the entire series
instances
instances:
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItem[]
Array of event instances that were synced. For one-off events, this contains a single instance. For recurring events, this contains all instances that were synced
CalendarWebhookEventsSyncedInputDataEventsItemEventType
CalendarWebhookEventsSyncedInputDataEventsItemEventType = typeof
CalendarWebhookEventsSyncedInputDataEventsItemEventType[keyof typeofCalendarWebhookEventsSyncedInputDataEventsItemEventType]
The type of event. 'one_off' for single events, 'recurring' for events that are part of a recurring series
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItem
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
start
start:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end
end:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
title
title:
string
The title of the event
status
status:
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
meeting_url
meeting_url:
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingPlatform
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingUrl
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus = typeof
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus[keyof typeofCalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
CalendarWebhookEventsSyncedInputDataEventsItemSeriesId
CalendarWebhookEventsSyncedInputDataEventsItemSeriesId =
string|null
The UUID of the event series. Null only in rare cases where the series relationship could not be established
CallbackCompletedData
CallbackCompletedData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that completed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
CallbackCompletedDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
participants
participants:
CallbackCompletedDataParticipants
List of participant names or identifiers who joined the meeting. Null if participant information is not available
speakers
speakers:
CallbackCompletedDataSpeakers
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
duration_seconds
duration_seconds:
CallbackCompletedDataDurationSeconds
joined_at
joined_at:
CallbackCompletedDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
exited_at
exited_at:
CallbackCompletedDataExitedAt
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
data_deleted
data_deleted:
boolean
Whether the bot's data (artifacts, recordings) has been deleted. True if data has been permanently removed
video
video:
CallbackCompletedDataVideo
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
audio
audio:
CallbackCompletedDataAudio
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
diarization
diarization:
CallbackCompletedDataDiarization
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
raw_transcription
raw_transcription:
CallbackCompletedDataRawTranscription
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
transcription
transcription:
CallbackCompletedDataTranscription
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
transcription_provider
transcription_provider:
CallbackCompletedDataTranscriptionProvider
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
transcription_ids
transcription_ids:
CallbackCompletedDataTranscriptionIds
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CallbackCompletedDataAudio
CallbackCompletedDataAudio =
string|null
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
CallbackCompletedDataDiarization
CallbackCompletedDataDiarization =
string|null
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
CallbackCompletedDataDurationSeconds
CallbackCompletedDataDurationSeconds =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
CallbackCompletedDataEventId
CallbackCompletedDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
CallbackCompletedDataExitedAt
CallbackCompletedDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
CallbackCompletedDataJoinedAt
CallbackCompletedDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
CallbackCompletedDataParticipants
CallbackCompletedDataParticipants =
string[] |null
List of participant names or identifiers who joined the meeting. Null if participant information is not available
CallbackCompletedDataRawTranscription
CallbackCompletedDataRawTranscription =
string|null
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
CallbackCompletedDataSpeakers
CallbackCompletedDataSpeakers =
string[] |null
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
CallbackCompletedDataTranscription
CallbackCompletedDataTranscription =
string|null
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
CallbackCompletedDataTranscriptionIds
CallbackCompletedDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
CallbackCompletedDataTranscriptionProvider
CallbackCompletedDataTranscriptionProvider =
string|null
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
CallbackCompletedDataVideo
CallbackCompletedDataVideo =
string|null
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
CallbackCompletedExtra
CallbackCompletedExtra =
CallbackCompletedExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackCompletedExtraAnyOf
CallbackCompletedExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CallbackCompletedInputData
CallbackCompletedInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that completed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
CallbackCompletedInputDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
participants
participants:
CallbackCompletedInputDataParticipants
List of participant names or identifiers who joined the meeting. Null if participant information is not available
speakers
speakers:
CallbackCompletedInputDataSpeakers
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
duration_seconds
duration_seconds:
CallbackCompletedInputDataDurationSeconds
joined_at
joined_at:
CallbackCompletedInputDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
exited_at
exited_at:
CallbackCompletedInputDataExitedAt
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
data_deleted
data_deleted:
boolean
Whether the bot's data (artifacts, recordings) has been deleted. True if data has been permanently removed
video
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
audio
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
diarization
diarization:
CallbackCompletedInputDataDiarization
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
raw_transcription
raw_transcription:
CallbackCompletedInputDataRawTranscription
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
transcription
transcription:
CallbackCompletedInputDataTranscription
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
transcription_provider
transcription_provider:
CallbackCompletedInputDataTranscriptionProvider
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
transcription_ids
transcription_ids:
CallbackCompletedInputDataTranscriptionIds
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CallbackCompletedInputDataAudio
CallbackCompletedInputDataAudio =
string|null
Signed URL to download the audio recording. Valid for 4 hours. Null if audio recording is not available or has been deleted
CallbackCompletedInputDataDiarization
CallbackCompletedInputDataDiarization =
string|null
Signed URL to download the speaker diarization data. Valid for 4 hours. Null if diarization is not available or has been deleted
CallbackCompletedInputDataDurationSeconds
CallbackCompletedInputDataDurationSeconds =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
CallbackCompletedInputDataEventId
CallbackCompletedInputDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
CallbackCompletedInputDataExitedAt
CallbackCompletedInputDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting. Null if exit time is not available
CallbackCompletedInputDataJoinedAt
CallbackCompletedInputDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting. Null if join time is not available
CallbackCompletedInputDataParticipants
CallbackCompletedInputDataParticipants =
string[] |null
List of participant names or identifiers who joined the meeting. Null if participant information is not available
CallbackCompletedInputDataRawTranscription
CallbackCompletedInputDataRawTranscription =
string|null
Signed URL to download the raw transcription file. Valid for 4 hours. Null if raw transcription is not available or has been deleted
CallbackCompletedInputDataSpeakers
CallbackCompletedInputDataSpeakers =
string[] |null
List of speaker names or identifiers detected in the meeting. Null if speaker information is not available
CallbackCompletedInputDataTranscription
CallbackCompletedInputDataTranscription =
string|null
Signed URL to download the processed transcription file. Valid for 4 hours. Null if transcription is not available or has been deleted
CallbackCompletedInputDataTranscriptionIds
CallbackCompletedInputDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider. Null if transcription was not enabled or if IDs are not available
CallbackCompletedInputDataTranscriptionProvider
CallbackCompletedInputDataTranscriptionProvider =
string|null
The transcription provider used (e.g., 'gladia'). Null if transcription was not enabled or if provider information is not available
CallbackCompletedInputDataVideo
CallbackCompletedInputDataVideo =
string|null
Signed URL to download the video recording. Valid for 4 hours. Null if video recording is not available or has been deleted
CallbackCompletedInputExtra
CallbackCompletedInputExtra =
CallbackCompletedInputExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackCompletedInputExtraAnyOf
CallbackCompletedInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CallbackFailedData
CallbackFailedData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that failed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
CallbackFailedDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
error_message
error_message:
string
Human-readable error message describing why the bot failed
error_code
error_code:
string
Machine-readable error code for programmatic handling. Common codes include 'MEETING_NOT_FOUND', 'MEETING_ENDED', 'BOT_CRASHED', etc.
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CallbackFailedDataEventId
CallbackFailedDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
CallbackFailedExtra
CallbackFailedExtra =
CallbackFailedExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackFailedExtraAnyOf
CallbackFailedExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CallbackFailedInputData
CallbackFailedInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot that failed
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_id
event_id:
CallbackFailedInputDataEventId
The UUID of the calendar event associated with this bot. Null for non-calendar bots
error_message
error_message:
string
Human-readable error message describing why the bot failed
error_code
error_code:
string
Machine-readable error code for programmatic handling. Common codes include 'MEETING_NOT_FOUND', 'MEETING_ENDED', 'BOT_CRASHED', etc.
sent_at
sent_at:
string
ISO 8601 timestamp when this webhook was sent
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CallbackFailedInputDataEventId
CallbackFailedInputDataEventId =
string|null
The UUID of the calendar event associated with this bot. Null for non-calendar bots
CallbackFailedInputExtra
CallbackFailedInputExtra =
CallbackFailedInputExtraAnyOf|null
Additional metadata provided when creating the bot. This is user-defined data that can be used for correlation or tracking
CallbackFailedInputExtraAnyOf
CallbackFailedInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateBot429
CreateBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:CreateBot429Message
Human-readable error message
details?
optionaldetails:CreateBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
CreateBot429Details
CreateBot429Details =
string|null
Additional error details (string or null)
CreateBot429Message
CreateBot429Message =
string|null
Human-readable error message
CreateBotRequestBodyInputBotImage
CreateBotRequestBodyInputBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
CreateBotRequestBodyInputCallbackConfig
CreateBotRequestBodyInputCallbackConfig =
CreateBotRequestBodyInputCallbackConfigAnyOf|null
CreateBotRequestBodyInputCallbackConfigAnyOf
CreateBotRequestBodyInputCallbackConfigAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret?
optionalsecret:CreateBotRequestBodyInputCallbackConfigAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method?
optionalmethod:CreateBotRequestBodyInputCallbackConfigAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateBotRequestBodyInputCallbackConfigAnyOfMethod
CreateBotRequestBodyInputCallbackConfigAnyOfMethod = typeof
CreateBotRequestBodyInputCallbackConfigAnyOfMethod[keyof typeofCreateBotRequestBodyInputCallbackConfigAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateBotRequestBodyInputCallbackConfigAnyOfSecret
CreateBotRequestBodyInputCallbackConfigAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
CreateBotRequestBodyInputEntryMessage
CreateBotRequestBodyInputEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
CreateBotRequestBodyInputExtra
CreateBotRequestBodyInputExtra =
CreateBotRequestBodyInputExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
CreateBotRequestBodyInputExtraAnyOf
CreateBotRequestBodyInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateBotRequestBodyInputRecordingMode
CreateBotRequestBodyInputRecordingMode = typeof
CreateBotRequestBodyInputRecordingMode[keyof typeofCreateBotRequestBodyInputRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
CreateBotRequestBodyInputStreamingConfig
CreateBotRequestBodyInputStreamingConfig =
CreateBotRequestBodyInputStreamingConfigAnyOf|null
CreateBotRequestBodyInputStreamingConfigAnyOf
CreateBotRequestBodyInputStreamingConfigAnyOf =
object
Properties
input_url?
optionalinput_url:CreateBotRequestBodyInputStreamingConfigAnyOfInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url?
optionaloutput_url:CreateBotRequestBodyInputStreamingConfigAnyOfOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency?
optionalaudio_frequency:CreateBotRequestBodyInputStreamingConfigAnyOfAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
CreateBotRequestBodyInputStreamingConfigAnyOfAudioFrequency
CreateBotRequestBodyInputStreamingConfigAnyOfAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
CreateBotRequestBodyInputStreamingConfigAnyOfInputUrl
CreateBotRequestBodyInputStreamingConfigAnyOfInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
CreateBotRequestBodyInputStreamingConfigAnyOfOutputUrl
CreateBotRequestBodyInputStreamingConfigAnyOfOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
CreateBotRequestBodyInputTimeoutConfig
CreateBotRequestBodyInputTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout?
optionalwaiting_room_timeout:number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout?
optionalno_one_joined_timeout:number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout?
optionalsilence_timeout:number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
CreateBotRequestBodyInputTranscriptionConfig
CreateBotRequestBodyInputTranscriptionConfig =
CreateBotRequestBodyInputTranscriptionConfigAnyOf|null
CreateBotRequestBodyInputTranscriptionConfigAnyOf
CreateBotRequestBodyInputTranscriptionConfigAnyOf =
object
Properties
provider?
optionalprovider:CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key?
optionalapi_key:CreateBotRequestBodyInputTranscriptionConfigAnyOfApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params?
optionalcustom_params:CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateBotRequestBodyInputTranscriptionConfigAnyOfApiKey
CreateBotRequestBodyInputTranscriptionConfigAnyOfApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParams
CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParams =
CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf
CreateBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider
CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider = typeof
CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider[keyof typeofCreateBotRequestBodyInputTranscriptionConfigAnyOfProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
CreateBotRequestBodyInputZoomAccessTokenUrl
CreateBotRequestBodyInputZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
CreateBotResponseData
CreateBotResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
bot_id
bot_id:
string
The UUID of the created bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateBotResponseInputData
CreateBotResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
bot_id
bot_id:
string
The UUID of the created bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateCalendarBot429
CreateCalendarBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:CreateCalendarBot429Message
Human-readable error message
details?
optionaldetails:CreateCalendarBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
CreateCalendarBot429Details
CreateCalendarBot429Details =
string|null
Additional error details (string or null)
CreateCalendarBot429Message
CreateCalendarBot429Message =
string|null
Human-readable error message
CreateCalendarBotRequestBody
CreateCalendarBotRequestBody =
CreateCalendarBotRequestBodyAllOf&CreateCalendarBotRequestBodyAllOfTwofour
CreateCalendarBotRequestBodyAllOf
CreateCalendarBotRequestBodyAllOf =
object
Properties
bot_name
bot_name:
string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image
bot_image:
CreateCalendarBotRequestBodyAllOfBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
recording_mode
recording_mode:
CreateCalendarBotRequestBodyAllOfRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message
entry_message:
CreateCalendarBotRequestBodyAllOfEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config
timeout_config:
CreateCalendarBotRequestBodyAllOfTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url
zoom_access_token_url:
CreateCalendarBotRequestBodyAllOfZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled
streaming_enabled:
boolean
Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.
streaming_config
streaming_config:
CreateCalendarBotRequestBodyAllOfStreamingConfig
transcription_enabled
transcription_enabled:
boolean
Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.
transcription_config
transcription_config:
CreateCalendarBotRequestBodyAllOfTranscriptionConfig
callback_enabled
callback_enabled:
boolean
Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.
callback_config
callback_config:
CreateCalendarBotRequestBodyAllOfCallbackConfig
CreateCalendarBotRequestBodyAllOfBotImage
CreateCalendarBotRequestBodyAllOfBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
CreateCalendarBotRequestBodyAllOfCallbackConfig
CreateCalendarBotRequestBodyAllOfCallbackConfig =
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOf|null
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOf
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret
secret:
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method
method:
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod = typeof
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod[keyof typeofCreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfSecret
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
CreateCalendarBotRequestBodyAllOfEntryMessage
CreateCalendarBotRequestBodyAllOfEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
CreateCalendarBotRequestBodyAllOfExtra
CreateCalendarBotRequestBodyAllOfExtra =
CreateCalendarBotRequestBodyAllOfExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
CreateCalendarBotRequestBodyAllOfExtraAnyOf
CreateCalendarBotRequestBodyAllOfExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateCalendarBotRequestBodyAllOfRecordingMode
CreateCalendarBotRequestBodyAllOfRecordingMode = typeof
CreateCalendarBotRequestBodyAllOfRecordingMode[keyof typeofCreateCalendarBotRequestBodyAllOfRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
CreateCalendarBotRequestBodyAllOfStreamingConfig
CreateCalendarBotRequestBodyAllOfStreamingConfig =
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOf|null
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOf
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOf =
object
Properties
input_url
input_url:
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url
output_url:
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency
audio_frequency:
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfAudioFrequency
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfInputUrl
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfOutputUrl
CreateCalendarBotRequestBodyAllOfStreamingConfigAnyOfOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
CreateCalendarBotRequestBodyAllOfTimeoutConfig
CreateCalendarBotRequestBodyAllOfTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout
waiting_room_timeout:
number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout
no_one_joined_timeout:
number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout
silence_timeout:
number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
CreateCalendarBotRequestBodyAllOfTranscriptionConfig
CreateCalendarBotRequestBodyAllOfTranscriptionConfig =
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOf|null
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOf
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOf =
object
Properties
provider
provider:
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key
api_key:
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params
custom_params:
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfApiKey
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParams
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParams =
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParamsAnyOf
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider = typeof
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider[keyof typeofCreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
CreateCalendarBotRequestBodyAllOfTwofour
CreateCalendarBotRequestBodyAllOfTwofour =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
series_id
series_id:
string
The UUID of the event series to schedule bots for.
Both one-off and recurring events have a series_id. For recurring events, use 'all_occurrences' to schedule bots for all future occurrences.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
all_occurrences
all_occurrences:
boolean
Whether to schedule bots for all occurrences of the event series.
If true, bots will be scheduled for all future event instances in the series. If false, event_id must be provided to schedule a bot for a specific event instance.
Default: false
event_id?
optionalevent_id:string
The UUID of a specific event instance to schedule a bot for.
Required when all_occurrences is false. Use this to schedule a bot for a single occurrence of a recurring event or a specific one-off event. If all_occurrences is true, this parameter is ignored.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateCalendarBotRequestBodyAllOfZoomAccessTokenUrl
CreateCalendarBotRequestBodyAllOfZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
CreateCalendarBotRequestBodyInput
CreateCalendarBotRequestBodyInput =
CreateCalendarBotRequestBodyInputAllOf&CreateCalendarBotRequestBodyInputAllOfTwofour
CreateCalendarBotRequestBodyInputAllOf
CreateCalendarBotRequestBodyInputAllOf =
object
Properties
bot_name
bot_name:
string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:CreateCalendarBotRequestBodyInputAllOfBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
recording_mode?
optionalrecording_mode:CreateCalendarBotRequestBodyInputAllOfRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:CreateCalendarBotRequestBodyInputAllOfEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:CreateCalendarBotRequestBodyInputAllOfTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:CreateCalendarBotRequestBodyInputAllOfZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:CreateCalendarBotRequestBodyInputAllOfExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable audio streaming for this bot. When enabled, the streaming_config property is used to provide the configuration.
streaming_config?
optionalstreaming_config:CreateCalendarBotRequestBodyInputAllOfStreamingConfig
transcription_enabled?
optionaltranscription_enabled:boolean
Enable transcription for this bot. When enabled, the transcription_config property is used to customise the transcription provider and parameters.
transcription_config?
optionaltranscription_config:CreateCalendarBotRequestBodyInputAllOfTranscriptionConfig
callback_enabled?
optionalcallback_enabled:boolean
Enable callback for this bot. When enabled, the callback_config property is used to provide the configuration.
callback_config?
optionalcallback_config:CreateCalendarBotRequestBodyInputAllOfCallbackConfig
CreateCalendarBotRequestBodyInputAllOfBotImage
CreateCalendarBotRequestBodyInputAllOfBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
CreateCalendarBotRequestBodyInputAllOfCallbackConfig
CreateCalendarBotRequestBodyInputAllOfCallbackConfig =
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOf|null
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOf
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret?
optionalsecret:CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method?
optionalmethod:CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod = typeof
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod[keyof typeofCreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfSecret
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
CreateCalendarBotRequestBodyInputAllOfEntryMessage
CreateCalendarBotRequestBodyInputAllOfEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
CreateCalendarBotRequestBodyInputAllOfExtra
CreateCalendarBotRequestBodyInputAllOfExtra =
CreateCalendarBotRequestBodyInputAllOfExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
CreateCalendarBotRequestBodyInputAllOfExtraAnyOf
CreateCalendarBotRequestBodyInputAllOfExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateCalendarBotRequestBodyInputAllOfRecordingMode
CreateCalendarBotRequestBodyInputAllOfRecordingMode = typeof
CreateCalendarBotRequestBodyInputAllOfRecordingMode[keyof typeofCreateCalendarBotRequestBodyInputAllOfRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
CreateCalendarBotRequestBodyInputAllOfStreamingConfig
CreateCalendarBotRequestBodyInputAllOfStreamingConfig =
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOf|null
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOf
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOf =
object
Properties
input_url?
optionalinput_url:CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url?
optionaloutput_url:CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency?
optionalaudio_frequency:CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfAudioFrequency
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfInputUrl
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfOutputUrl
CreateCalendarBotRequestBodyInputAllOfStreamingConfigAnyOfOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
CreateCalendarBotRequestBodyInputAllOfTimeoutConfig
CreateCalendarBotRequestBodyInputAllOfTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout?
optionalwaiting_room_timeout:number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout?
optionalno_one_joined_timeout:number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout?
optionalsilence_timeout:number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfig
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfig =
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOf|null
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOf
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOf =
object
Properties
provider?
optionalprovider:CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key?
optionalapi_key:CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params?
optionalcustom_params:CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfApiKey
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParams
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParams =
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParamsAnyOf
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider = typeof
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider[keyof typeofCreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
CreateCalendarBotRequestBodyInputAllOfTwofour
CreateCalendarBotRequestBodyInputAllOfTwofour =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
series_id
series_id:
string
The UUID of the event series to schedule bots for.
Both one-off and recurring events have a series_id. For recurring events, use 'all_occurrences' to schedule bots for all future occurrences.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
all_occurrences
all_occurrences:
boolean
Whether to schedule bots for all occurrences of the event series.
If true, bots will be scheduled for all future event instances in the series. If false, event_id must be provided to schedule a bot for a specific event instance.
Default: false
event_id?
optionalevent_id:string
The UUID of a specific event instance to schedule a bot for.
Required when all_occurrences is false. Use this to schedule a bot for a single occurrence of a recurring event or a specific one-off event. If all_occurrences is true, this parameter is ignored.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateCalendarBotRequestBodyInputAllOfZoomAccessTokenUrl
CreateCalendarBotRequestBodyInputAllOfZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
CreateCalendarBotResponseDataItem
CreateCalendarBotResponseDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateCalendarBotResponseErrorsItem
CreateCalendarBotResponseErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
CreateCalendarBotResponseErrorsItemDetails
CreateCalendarBotResponseErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
CreateCalendarBotResponseInputDataItem
CreateCalendarBotResponseInputDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateCalendarBotResponseInputErrorsItem
CreateCalendarBotResponseInputErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
CreateCalendarBotResponseInputErrorsItemDetails
CreateCalendarBotResponseInputErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
CreateCalendarConnection429
CreateCalendarConnection429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:CreateCalendarConnection429Message
Human-readable error message
details?
optionaldetails:CreateCalendarConnection429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
CreateCalendarConnection429Details
CreateCalendarConnection429Details =
string|null
Additional error details (string or null)
CreateCalendarConnection429Message
CreateCalendarConnection429Message =
string|null
Human-readable error message
CreateCalendarConnectionRequestBodyCalendarPlatform
CreateCalendarConnectionRequestBodyCalendarPlatform = typeof
CreateCalendarConnectionRequestBodyCalendarPlatform[keyof typeofCreateCalendarConnectionRequestBodyCalendarPlatform]
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
CreateCalendarConnectionRequestBodyInputCalendarPlatform
CreateCalendarConnectionRequestBodyInputCalendarPlatform = typeof
CreateCalendarConnectionRequestBodyInputCalendarPlatform[keyof typeofCreateCalendarConnectionRequestBodyInputCalendarPlatform]
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
CreateCalendarConnectionResponseData
CreateCalendarConnectionResponseData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the newly created calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CreateCalendarConnectionResponseDataCalendarPlatform
The calendar platform where this connection was established. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CreateCalendarConnectionResponseDataCalendarPlatform
CreateCalendarConnectionResponseDataCalendarPlatform = typeof
CreateCalendarConnectionResponseDataCalendarPlatform[keyof typeofCreateCalendarConnectionResponseDataCalendarPlatform]
The calendar platform where this connection was established. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CreateCalendarConnectionResponseDataStatus
CreateCalendarConnectionResponseDataStatus = typeof
CreateCalendarConnectionResponseDataStatus[keyof typeofCreateCalendarConnectionResponseDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CreateCalendarConnectionResponseInputData
CreateCalendarConnectionResponseInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the newly created calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
CreateCalendarConnectionResponseInputDataCalendarPlatform
The calendar platform where this connection was established. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CreateCalendarConnectionResponseInputDataCalendarPlatform
CreateCalendarConnectionResponseInputDataCalendarPlatform = typeof
CreateCalendarConnectionResponseInputDataCalendarPlatform[keyof typeofCreateCalendarConnectionResponseInputDataCalendarPlatform]
The calendar platform where this connection was established. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
CreateCalendarConnectionResponseInputDataStatus
CreateCalendarConnectionResponseInputDataStatus = typeof
CreateCalendarConnectionResponseInputDataStatus[keyof typeofCreateCalendarConnectionResponseInputDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
CreateScheduledBot429
CreateScheduledBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:CreateScheduledBot429Message
Human-readable error message
details?
optionaldetails:CreateScheduledBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
CreateScheduledBot429Details
CreateScheduledBot429Details =
string|null
Additional error details (string or null)
CreateScheduledBot429Message
CreateScheduledBot429Message =
string|null
Human-readable error message
CreateScheduledBotRequestBody
CreateScheduledBotRequestBody =
CreateBotRequestBody&CreateScheduledBotRequestBodyAllOf
CreateScheduledBotRequestBodyAllOf
CreateScheduledBotRequestBodyAllOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
join_at
join_at:
string
ISO8601 timestamp when the bot should join the meeting.
Cannot be in the past (with 1 minute leeway) and cannot be more than 90 days in the future.
Example: "2025-12-25T10:00:00Z"
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CreateScheduledBotRequestBodyInput
CreateScheduledBotRequestBodyInput =
CreateBotRequestBodyInput&CreateScheduledBotRequestBodyInputAllOf
CreateScheduledBotRequestBodyInputAllOf
CreateScheduledBotRequestBodyInputAllOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
join_at
join_at:
string
ISO8601 timestamp when the bot should join the meeting.
Cannot be in the past (with 1 minute leeway) and cannot be more than 90 days in the future.
Example: "2025-12-25T10:00:00Z"
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
CreateScheduledBotResponseData
CreateScheduledBotResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
bot_id
bot_id:
string
The UUID of the created scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
CreateScheduledBotResponseInputData
CreateScheduledBotResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
bot_id
bot_id:
string
The UUID of the created scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
DeleteBotData429
DeleteBotData429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:DeleteBotData429Message
Human-readable error message
details?
optionaldetails:DeleteBotData429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
DeleteBotData429Details
DeleteBotData429Details =
string|null
Additional error details (string or null)
DeleteBotData429Message
DeleteBotData429Message =
string|null
Human-readable error message
DeleteBotDataParams
DeleteBotDataParams =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
delete_from_provider?
optionaldelete_from_provider:boolean
Whether to delete transcription data from the transcription provider.
If true (default), the transcription data will be deleted from the transcription provider's servers in addition to deleting artifacts from S3. This ensures complete data deletion.
If false, only S3 artifacts will be deleted, and transcription data will remain on the transcription provider's servers.
Note: If the bot was created with a BYOK (Bring Your Own Key) transcription API key, the deletion will use that key to authenticate with the transcription provider.
Default: true
DeleteBotDataResponseData
DeleteBotDataResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
DeleteBotDataResponseInputData
DeleteBotDataResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
DeleteCalendarBot429
DeleteCalendarBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:DeleteCalendarBot429Message
Human-readable error message
details?
optionaldetails:DeleteCalendarBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
DeleteCalendarBot429Details
DeleteCalendarBot429Details =
string|null
Additional error details (string or null)
DeleteCalendarBot429Message
DeleteCalendarBot429Message =
string|null
Human-readable error message
DeleteCalendarBotBody
DeleteCalendarBotBody =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
series_id
series_id:
string
The UUID of the event series to schedule bots for.
Both one-off and recurring events have a series_id. For recurring events, use 'all_occurrences' to schedule bots for all future occurrences.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
all_occurrences
all_occurrences:
boolean
Whether to schedule bots for all occurrences of the event series.
If true, bots will be scheduled for all future event instances in the series. If false, event_id must be provided to schedule a bot for a specific event instance.
Default: false
event_id?
optionalevent_id:string
The UUID of a specific event instance to schedule a bot for.
Required when all_occurrences is false. Use this to schedule a bot for a single occurrence of a recurring event or a specific one-off event. If all_occurrences is true, this parameter is ignored.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
DeleteCalendarBotResponseDataItem
DeleteCalendarBotResponseDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
DeleteCalendarBotResponseErrorsItem
DeleteCalendarBotResponseErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
DeleteCalendarBotResponseErrorsItemDetails
DeleteCalendarBotResponseErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
DeleteCalendarBotResponseInputDataItem
DeleteCalendarBotResponseInputDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
DeleteCalendarBotResponseInputErrorsItem
DeleteCalendarBotResponseInputErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
DeleteCalendarBotResponseInputErrorsItemDetails
DeleteCalendarBotResponseInputErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
DeleteCalendarConnection429
DeleteCalendarConnection429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:DeleteCalendarConnection429Message
Human-readable error message
details?
optionaldetails:DeleteCalendarConnection429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
DeleteCalendarConnection429Details
DeleteCalendarConnection429Details =
string|null
Additional error details (string or null)
DeleteCalendarConnection429Message
DeleteCalendarConnection429Message =
string|null
Human-readable error message
DeleteCalendarConnectionResponseData
DeleteCalendarConnectionResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message confirming that the calendar connection has been deleted. All associated event instances, series, and bot schedules have also been removed
DeleteCalendarConnectionResponseInputData
DeleteCalendarConnectionResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message confirming that the calendar connection has been deleted. All associated event instances, series, and bot schedules have also been removed
DeleteScheduledBot429
DeleteScheduledBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:DeleteScheduledBot429Message
Human-readable error message
details?
optionaldetails:DeleteScheduledBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
DeleteScheduledBot429Details
DeleteScheduledBot429Details =
string|null
Additional error details (string or null)
DeleteScheduledBot429Message
DeleteScheduledBot429Message =
string|null
Human-readable error message
DeleteScheduledBotResponseData
DeleteScheduledBotResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
DeleteScheduledBotResponseInputData
DeleteScheduledBotResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
ErrorResponseDetails
ErrorResponseDetails =
string|null
Additional error details (string or null)
ErrorResponseInputDetails
ErrorResponseInputDetails =
string|null
Additional error details (string or null)
ErrorResponseInputMessage
ErrorResponseInputMessage =
string|null
Human-readable error message
ErrorResponseMessage
ErrorResponseMessage =
string|null
Human-readable error message
GetBotDetails429
GetBotDetails429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetBotDetails429Message
Human-readable error message
details?
optionaldetails:GetBotDetails429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetBotDetails429Details
GetBotDetails429Details =
string|null
Additional error details (string or null)
GetBotDetails429Message
GetBotDetails429Message =
string|null
Human-readable error message
GetBotDetailsResponseData
GetBotDetailsResponseData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
GetBotDetailsResponseDataMeetingPlatform
The platform of the meeting
recording_mode
recording_mode:
GetBotDetailsResponseDataRecordingMode
The recording mode used by the bot
status
status:
GetBotDetailsResponseDataStatus
The current status of the bot
created_at
created_at:
string
ISO 8601 timestamp when the bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
joined_at
joined_at:
GetBotDetailsResponseDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
exited_at
exited_at:
GetBotDetailsResponseDataExitedAt
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
duration_seconds
duration_seconds:
GetBotDetailsResponseDataDurationSeconds
Duration of the meeting in seconds (null if meeting hasn't ended)
participants
participants:
GetBotDetailsResponseDataParticipantsItem[]
List of participants who joined the meeting
speakers
speakers:
GetBotDetailsResponseDataSpeakersItem[]
List of speakers identified in the meeting
artifacts_deleted
artifacts_deleted:
boolean
Whether the artifacts have been deleted
video
Signed URL to the video recording (valid for 4 hours, null if not available)
audio
Signed URL to the audio recording (valid for 4 hours, null if not available)
diarization
diarization:
GetBotDetailsResponseDataDiarization
Signed URL to the diarization file (valid for 4 hours, null if not available)
raw_transcription
raw_transcription:
GetBotDetailsResponseDataRawTranscription
Signed URL to the raw transcription file (valid for 4 hours, null if not available)
transcription
transcription:
GetBotDetailsResponseDataTranscription
Signed URL to the transcription file (valid for 4 hours, null if not available)
transcription_ids
transcription_ids:
GetBotDetailsResponseDataTranscriptionIds
Array of transcription job IDs from the transcription provider
transcription_provider
transcription_provider:
GetBotDetailsResponseDataTranscriptionProvider
The transcription provider used (null if transcription is disabled or provider is 'none')
error_code
error_code:
GetBotDetailsResponseDataErrorCode
Error code if the bot failed (null if no error)
error_message
error_message:
GetBotDetailsResponseDataErrorMessage
Human-readable error message if the bot failed (null if no error)
extra
Custom metadata associated with the bot
GetBotDetailsResponseDataAudio
GetBotDetailsResponseDataAudio =
string|null
Signed URL to the audio recording (valid for 4 hours, null if not available)
GetBotDetailsResponseDataDiarization
GetBotDetailsResponseDataDiarization =
string|null
Signed URL to the diarization file (valid for 4 hours, null if not available)
GetBotDetailsResponseDataDurationSeconds
GetBotDetailsResponseDataDurationSeconds =
number|null
Duration of the meeting in seconds (null if meeting hasn't ended)
GetBotDetailsResponseDataErrorCode
GetBotDetailsResponseDataErrorCode =
string|null
Error code if the bot failed (null if no error)
GetBotDetailsResponseDataErrorMessage
GetBotDetailsResponseDataErrorMessage =
string|null
Human-readable error message if the bot failed (null if no error)
GetBotDetailsResponseDataExitedAt
GetBotDetailsResponseDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
GetBotDetailsResponseDataExtra
GetBotDetailsResponseDataExtra =
GetBotDetailsResponseDataExtraAnyOf|null
Custom metadata associated with the bot
GetBotDetailsResponseDataExtraAnyOf
GetBotDetailsResponseDataExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetBotDetailsResponseDataJoinedAt
GetBotDetailsResponseDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
GetBotDetailsResponseDataMeetingPlatform
GetBotDetailsResponseDataMeetingPlatform = typeof
GetBotDetailsResponseDataMeetingPlatform[keyof typeofGetBotDetailsResponseDataMeetingPlatform]
The platform of the meeting
GetBotDetailsResponseDataParticipantsItem
GetBotDetailsResponseDataParticipantsItem =
object
Properties
name
name:
string
id
GetBotDetailsResponseDataParticipantsItemId
GetBotDetailsResponseDataParticipantsItemId =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
GetBotDetailsResponseDataRawTranscription
GetBotDetailsResponseDataRawTranscription =
string|null
Signed URL to the raw transcription file (valid for 4 hours, null if not available)
GetBotDetailsResponseDataRecordingMode
GetBotDetailsResponseDataRecordingMode = typeof
GetBotDetailsResponseDataRecordingMode[keyof typeofGetBotDetailsResponseDataRecordingMode]
The recording mode used by the bot
GetBotDetailsResponseDataSpeakersItem
GetBotDetailsResponseDataSpeakersItem =
object
Properties
name
name:
string
id
GetBotDetailsResponseDataSpeakersItemId
GetBotDetailsResponseDataSpeakersItemId =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
GetBotDetailsResponseDataStatus
GetBotDetailsResponseDataStatus = typeof
GetBotDetailsResponseDataStatus[keyof typeofGetBotDetailsResponseDataStatus]
The current status of the bot
GetBotDetailsResponseDataTranscription
GetBotDetailsResponseDataTranscription =
string|null
Signed URL to the transcription file (valid for 4 hours, null if not available)
GetBotDetailsResponseDataTranscriptionIds
GetBotDetailsResponseDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider
GetBotDetailsResponseDataTranscriptionProvider
GetBotDetailsResponseDataTranscriptionProvider =
"gladia"|null
The transcription provider used (null if transcription is disabled or provider is 'none')
GetBotDetailsResponseDataVideo
GetBotDetailsResponseDataVideo =
string|null
Signed URL to the video recording (valid for 4 hours, null if not available)
GetBotDetailsResponseInputData
GetBotDetailsResponseInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
GetBotDetailsResponseInputDataMeetingPlatform
The platform of the meeting
recording_mode
recording_mode:
GetBotDetailsResponseInputDataRecordingMode
The recording mode used by the bot
status
The current status of the bot
created_at
created_at:
string
ISO 8601 timestamp when the bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
joined_at
joined_at:
GetBotDetailsResponseInputDataJoinedAt
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
exited_at
exited_at:
GetBotDetailsResponseInputDataExitedAt
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
duration_seconds
duration_seconds:
GetBotDetailsResponseInputDataDurationSeconds
Duration of the meeting in seconds (null if meeting hasn't ended)
participants
participants:
GetBotDetailsResponseInputDataParticipantsItem[]
List of participants who joined the meeting
speakers
speakers:
GetBotDetailsResponseInputDataSpeakersItem[]
List of speakers identified in the meeting
artifacts_deleted
artifacts_deleted:
boolean
Whether the artifacts have been deleted
video
Signed URL to the video recording (valid for 4 hours, null if not available)
audio
Signed URL to the audio recording (valid for 4 hours, null if not available)
diarization
diarization:
GetBotDetailsResponseInputDataDiarization
Signed URL to the diarization file (valid for 4 hours, null if not available)
raw_transcription
raw_transcription:
GetBotDetailsResponseInputDataRawTranscription
Signed URL to the raw transcription file (valid for 4 hours, null if not available)
transcription
transcription:
GetBotDetailsResponseInputDataTranscription
Signed URL to the transcription file (valid for 4 hours, null if not available)
transcription_ids
transcription_ids:
GetBotDetailsResponseInputDataTranscriptionIds
Array of transcription job IDs from the transcription provider
transcription_provider
transcription_provider:
GetBotDetailsResponseInputDataTranscriptionProvider
The transcription provider used (null if transcription is disabled or provider is 'none')
error_code
error_code:
GetBotDetailsResponseInputDataErrorCode
Error code if the bot failed (null if no error)
error_message
error_message:
GetBotDetailsResponseInputDataErrorMessage
Human-readable error message if the bot failed (null if no error)
extra
Custom metadata associated with the bot
GetBotDetailsResponseInputDataAudio
GetBotDetailsResponseInputDataAudio =
string|null
Signed URL to the audio recording (valid for 4 hours, null if not available)
GetBotDetailsResponseInputDataDiarization
GetBotDetailsResponseInputDataDiarization =
string|null
Signed URL to the diarization file (valid for 4 hours, null if not available)
GetBotDetailsResponseInputDataDurationSeconds
GetBotDetailsResponseInputDataDurationSeconds =
number|null
Duration of the meeting in seconds (null if meeting hasn't ended)
GetBotDetailsResponseInputDataErrorCode
GetBotDetailsResponseInputDataErrorCode =
string|null
Error code if the bot failed (null if no error)
GetBotDetailsResponseInputDataErrorMessage
GetBotDetailsResponseInputDataErrorMessage =
string|null
Human-readable error message if the bot failed (null if no error)
GetBotDetailsResponseInputDataExitedAt
GetBotDetailsResponseInputDataExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
GetBotDetailsResponseInputDataExtra
GetBotDetailsResponseInputDataExtra =
GetBotDetailsResponseInputDataExtraAnyOf|null
Custom metadata associated with the bot
GetBotDetailsResponseInputDataExtraAnyOf
GetBotDetailsResponseInputDataExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetBotDetailsResponseInputDataJoinedAt
GetBotDetailsResponseInputDataJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
GetBotDetailsResponseInputDataMeetingPlatform
GetBotDetailsResponseInputDataMeetingPlatform = typeof
GetBotDetailsResponseInputDataMeetingPlatform[keyof typeofGetBotDetailsResponseInputDataMeetingPlatform]
The platform of the meeting
GetBotDetailsResponseInputDataParticipantsItem
GetBotDetailsResponseInputDataParticipantsItem =
object
Properties
name
name:
string
id
GetBotDetailsResponseInputDataParticipantsItemId
GetBotDetailsResponseInputDataParticipantsItemId =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
GetBotDetailsResponseInputDataRawTranscription
GetBotDetailsResponseInputDataRawTranscription =
string|null
Signed URL to the raw transcription file (valid for 4 hours, null if not available)
GetBotDetailsResponseInputDataRecordingMode
GetBotDetailsResponseInputDataRecordingMode = typeof
GetBotDetailsResponseInputDataRecordingMode[keyof typeofGetBotDetailsResponseInputDataRecordingMode]
The recording mode used by the bot
GetBotDetailsResponseInputDataSpeakersItem
GetBotDetailsResponseInputDataSpeakersItem =
object
Properties
name
name:
string
id
GetBotDetailsResponseInputDataSpeakersItemId
GetBotDetailsResponseInputDataSpeakersItemId =
number|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
GetBotDetailsResponseInputDataStatus
GetBotDetailsResponseInputDataStatus = typeof
GetBotDetailsResponseInputDataStatus[keyof typeofGetBotDetailsResponseInputDataStatus]
The current status of the bot
GetBotDetailsResponseInputDataTranscription
GetBotDetailsResponseInputDataTranscription =
string|null
Signed URL to the transcription file (valid for 4 hours, null if not available)
GetBotDetailsResponseInputDataTranscriptionIds
GetBotDetailsResponseInputDataTranscriptionIds =
string[] |null
Array of transcription job IDs from the transcription provider
GetBotDetailsResponseInputDataTranscriptionProvider
GetBotDetailsResponseInputDataTranscriptionProvider =
"gladia"|null
The transcription provider used (null if transcription is disabled or provider is 'none')
GetBotDetailsResponseInputDataVideo
GetBotDetailsResponseInputDataVideo =
string|null
Signed URL to the video recording (valid for 4 hours, null if not available)
GetBotScreenshots429
GetBotScreenshots429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetBotScreenshots429Message
Human-readable error message
details?
optionaldetails:GetBotScreenshots429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetBotScreenshots429Details
GetBotScreenshots429Details =
string|null
Additional error details (string or null)
GetBotScreenshots429Message
GetBotScreenshots429Message =
string|null
Human-readable error message
GetBotScreenshotsParams
GetBotScreenshotsParams =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
limit?
optionallimit:number
Maximum number of screenshots to return (default: 50, max: 250).
Maximum
250
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing the screenshot index. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MQ==" (for index 1) or "-MTA=" (for backward pagination from index 10)
GetBotScreenshotsResponseCursor
GetBotScreenshotsResponseCursor =
string|null
Cursor for the next page (null if no more pages)
GetBotScreenshotsResponseDataItem
GetBotScreenshotsResponseDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
screenshot_id
screenshot_id:
number
The index of the screenshot (1-based)
Maximum
9007199254740991
url
url:
string
Signed URL to the screenshot (valid for 4 hours)
GetBotScreenshotsResponseInputCursor
GetBotScreenshotsResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
GetBotScreenshotsResponseInputDataItem
GetBotScreenshotsResponseInputDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
screenshot_id
screenshot_id:
number
The index of the screenshot (1-based)
Maximum
9007199254740991
url
url:
string
Signed URL to the screenshot (valid for 4 hours)
GetBotScreenshotsResponseInputPrevCursor
GetBotScreenshotsResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
GetBotScreenshotsResponsePrevCursor
GetBotScreenshotsResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
GetBotStatus429
GetBotStatus429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetBotStatus429Message
Human-readable error message
details?
optionaldetails:GetBotStatus429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetBotStatus429Details
GetBotStatus429Details =
string|null
Additional error details (string or null)
GetBotStatus429Message
GetBotStatus429Message =
string|null
Human-readable error message
GetBotStatusResponseData
GetBotStatusResponseData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
status:
GetBotStatusResponseDataStatus
The current status of the bot
transcription_status
transcription_status:
GetBotStatusResponseDataTranscriptionStatus
The current transcription status
updated_at
updated_at:
string
ISO 8601 timestamp when the status was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetBotStatusResponseDataStatus
GetBotStatusResponseDataStatus = typeof
GetBotStatusResponseDataStatus[keyof typeofGetBotStatusResponseDataStatus]
The current status of the bot
GetBotStatusResponseDataTranscriptionStatus
GetBotStatusResponseDataTranscriptionStatus = typeof
GetBotStatusResponseDataTranscriptionStatus[keyof typeofGetBotStatusResponseDataTranscriptionStatus]
The current transcription status
GetBotStatusResponseInputData
GetBotStatusResponseInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
The current status of the bot
transcription_status
transcription_status:
GetBotStatusResponseInputDataTranscriptionStatus
The current transcription status
updated_at
updated_at:
string
ISO 8601 timestamp when the status was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetBotStatusResponseInputDataStatus
GetBotStatusResponseInputDataStatus = typeof
GetBotStatusResponseInputDataStatus[keyof typeofGetBotStatusResponseInputDataStatus]
The current status of the bot
GetBotStatusResponseInputDataTranscriptionStatus
GetBotStatusResponseInputDataTranscriptionStatus = typeof
GetBotStatusResponseInputDataTranscriptionStatus[keyof typeofGetBotStatusResponseInputDataTranscriptionStatus]
The current transcription status
GetCalendarDetails429
GetCalendarDetails429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetCalendarDetails429Message
Human-readable error message
details?
optionaldetails:GetCalendarDetails429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetCalendarDetails429Details
GetCalendarDetails429Details =
string|null
Additional error details (string or null)
GetCalendarDetails429Message
GetCalendarDetails429Message =
string|null
Human-readable error message
GetCalendarDetailsResponseData
GetCalendarDetailsResponseData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
GetCalendarDetailsResponseDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
status_message
status_message:
GetCalendarDetailsResponseDataStatusMessage
A human-readable message providing additional context about the connection status. Null if there is no additional status message to display
subscription_id
subscription_id:
GetCalendarDetailsResponseDataSubscriptionId
The subscription ID assigned by the calendar provider (Google or Microsoft). This ID is used to manage the webhook subscription. Null if no subscription exists
subscription_expires_at
subscription_expires_at:
GetCalendarDetailsResponseDataSubscriptionExpiresAt
ISO 8601 timestamp when the webhook subscription expires. Subscriptions typically expire after a certain period (e.g., 7 days for Google, 3 days for Microsoft) and need to be renewed. Null if no subscription exists
synced_at
synced_at:
GetCalendarDetailsResponseDataSyncedAt
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced. Syncs fetch events from the calendar platform and update the local database
sync_status
sync_status:
GetCalendarDetailsResponseDataSyncStatus
The status of the last sync operation. Null if no sync has been performed yet. Possible values when not null: 'success' (sync completed successfully), 'failed' (sync failed completely), 'partial' (sync completed but some events could not be processed)
sync_error
sync_error:
GetCalendarDetailsResponseDataSyncError
Error message from the last sync operation if it failed. This provides details about what went wrong during the sync. Null if the last sync was successful or if no sync has been performed
provider_metadata
provider_metadata:
GetCalendarDetailsResponseDataProviderMetadata
Additional metadata returned by the calendar provider about this calendar. This may include calendar-specific settings, permissions, or other platform-specific information. Null if the provider did not return metadata or if metadata is not available
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and initially synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was last updated. This updates when connection settings change, credentials are refreshed, or subscription details are updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetCalendarDetailsResponseDataCalendarPlatform
GetCalendarDetailsResponseDataCalendarPlatform = typeof
GetCalendarDetailsResponseDataCalendarPlatform[keyof typeofGetCalendarDetailsResponseDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
GetCalendarDetailsResponseDataProviderMetadata
GetCalendarDetailsResponseDataProviderMetadata =
GetCalendarDetailsResponseDataProviderMetadataAnyOf|null
Additional metadata returned by the calendar provider about this calendar. This may include calendar-specific settings, permissions, or other platform-specific information. Null if the provider did not return metadata or if metadata is not available
GetCalendarDetailsResponseDataProviderMetadataAnyOf
GetCalendarDetailsResponseDataProviderMetadataAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetCalendarDetailsResponseDataStatus
GetCalendarDetailsResponseDataStatus = typeof
GetCalendarDetailsResponseDataStatus[keyof typeofGetCalendarDetailsResponseDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
GetCalendarDetailsResponseDataStatusMessage
GetCalendarDetailsResponseDataStatusMessage =
string|null
A human-readable message providing additional context about the connection status. Null if there is no additional status message to display
GetCalendarDetailsResponseDataSubscriptionExpiresAt
GetCalendarDetailsResponseDataSubscriptionExpiresAt =
string|null
ISO 8601 timestamp when the webhook subscription expires. Subscriptions typically expire after a certain period (e.g., 7 days for Google, 3 days for Microsoft) and need to be renewed. Null if no subscription exists
GetCalendarDetailsResponseDataSubscriptionId
GetCalendarDetailsResponseDataSubscriptionId =
string|null
The subscription ID assigned by the calendar provider (Google or Microsoft). This ID is used to manage the webhook subscription. Null if no subscription exists
GetCalendarDetailsResponseDataSyncError
GetCalendarDetailsResponseDataSyncError =
string|null
Error message from the last sync operation if it failed. This provides details about what went wrong during the sync. Null if the last sync was successful or if no sync has been performed
GetCalendarDetailsResponseDataSyncStatus
GetCalendarDetailsResponseDataSyncStatus =
"success"|"failed"|"partial"|null
The status of the last sync operation. Null if no sync has been performed yet. Possible values when not null: 'success' (sync completed successfully), 'failed' (sync failed completely), 'partial' (sync completed but some events could not be processed)
GetCalendarDetailsResponseDataSyncedAt
GetCalendarDetailsResponseDataSyncedAt =
string|null
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced. Syncs fetch events from the calendar platform and update the local database
GetCalendarDetailsResponseInputData
GetCalendarDetailsResponseInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
GetCalendarDetailsResponseInputDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
status_message
status_message:
GetCalendarDetailsResponseInputDataStatusMessage
A human-readable message providing additional context about the connection status. Null if there is no additional status message to display
subscription_id
subscription_id:
GetCalendarDetailsResponseInputDataSubscriptionId
The subscription ID assigned by the calendar provider (Google or Microsoft). This ID is used to manage the webhook subscription. Null if no subscription exists
subscription_expires_at
subscription_expires_at:
GetCalendarDetailsResponseInputDataSubscriptionExpiresAt
ISO 8601 timestamp when the webhook subscription expires. Subscriptions typically expire after a certain period (e.g., 7 days for Google, 3 days for Microsoft) and need to be renewed. Null if no subscription exists
synced_at
synced_at:
GetCalendarDetailsResponseInputDataSyncedAt
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced. Syncs fetch events from the calendar platform and update the local database
sync_status
sync_status:
GetCalendarDetailsResponseInputDataSyncStatus
The status of the last sync operation. Null if no sync has been performed yet. Possible values when not null: 'success' (sync completed successfully), 'failed' (sync failed completely), 'partial' (sync completed but some events could not be processed)
sync_error
sync_error:
GetCalendarDetailsResponseInputDataSyncError
Error message from the last sync operation if it failed. This provides details about what went wrong during the sync. Null if the last sync was successful or if no sync has been performed
provider_metadata
provider_metadata:
GetCalendarDetailsResponseInputDataProviderMetadata
Additional metadata returned by the calendar provider about this calendar. This may include calendar-specific settings, permissions, or other platform-specific information. Null if the provider did not return metadata or if metadata is not available
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and initially synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was last updated. This updates when connection settings change, credentials are refreshed, or subscription details are updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetCalendarDetailsResponseInputDataCalendarPlatform
GetCalendarDetailsResponseInputDataCalendarPlatform = typeof
GetCalendarDetailsResponseInputDataCalendarPlatform[keyof typeofGetCalendarDetailsResponseInputDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
GetCalendarDetailsResponseInputDataProviderMetadata
GetCalendarDetailsResponseInputDataProviderMetadata =
GetCalendarDetailsResponseInputDataProviderMetadataAnyOf|null
Additional metadata returned by the calendar provider about this calendar. This may include calendar-specific settings, permissions, or other platform-specific information. Null if the provider did not return metadata or if metadata is not available
GetCalendarDetailsResponseInputDataProviderMetadataAnyOf
GetCalendarDetailsResponseInputDataProviderMetadataAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetCalendarDetailsResponseInputDataStatus
GetCalendarDetailsResponseInputDataStatus = typeof
GetCalendarDetailsResponseInputDataStatus[keyof typeofGetCalendarDetailsResponseInputDataStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
GetCalendarDetailsResponseInputDataStatusMessage
GetCalendarDetailsResponseInputDataStatusMessage =
string|null
A human-readable message providing additional context about the connection status. Null if there is no additional status message to display
GetCalendarDetailsResponseInputDataSubscriptionExpiresAt
GetCalendarDetailsResponseInputDataSubscriptionExpiresAt =
string|null
ISO 8601 timestamp when the webhook subscription expires. Subscriptions typically expire after a certain period (e.g., 7 days for Google, 3 days for Microsoft) and need to be renewed. Null if no subscription exists
GetCalendarDetailsResponseInputDataSubscriptionId
GetCalendarDetailsResponseInputDataSubscriptionId =
string|null
The subscription ID assigned by the calendar provider (Google or Microsoft). This ID is used to manage the webhook subscription. Null if no subscription exists
GetCalendarDetailsResponseInputDataSyncError
GetCalendarDetailsResponseInputDataSyncError =
string|null
Error message from the last sync operation if it failed. This provides details about what went wrong during the sync. Null if the last sync was successful or if no sync has been performed
GetCalendarDetailsResponseInputDataSyncStatus
GetCalendarDetailsResponseInputDataSyncStatus =
"success"|"failed"|"partial"|null
The status of the last sync operation. Null if no sync has been performed yet. Possible values when not null: 'success' (sync completed successfully), 'failed' (sync failed completely), 'partial' (sync completed but some events could not be processed)
GetCalendarDetailsResponseInputDataSyncedAt
GetCalendarDetailsResponseInputDataSyncedAt =
string|null
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced. Syncs fetch events from the calendar platform and update the local database
GetEventDetails429
GetEventDetails429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetEventDetails429Message
Human-readable error message
details?
optionaldetails:GetEventDetails429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetEventDetails429Details
GetEventDetails429Details =
string|null
Additional error details (string or null)
GetEventDetails429Message
GetEventDetails429Message =
string|null
Human-readable error message
GetEventDetailsResponseData
GetEventDetailsResponseData =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
series_id
series_id:
string
The UUID of the event series this instance belongs to. Every event instance (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
GetEventDetailsResponseDataEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
title
title:
string
The title of the event as stored in the calendar
description
description:
GetEventDetailsResponseDataDescription
The description of the event as returned by the calendar platform. Null if the calendar platform did not include a description for this event
location
location:
GetEventDetailsResponseDataLocation
The location of the event as returned by the calendar platform. Null if the calendar platform did not include a location for this event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
timezone
timezone:
GetEventDetailsResponseDataTimezone
The IANA timezone identifier for the event (e.g., 'America/New_York', 'Europe/London'). Null if the calendar platform did not provide timezone information or if the event is all-day
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
status
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
organizer_email
organizer_email:
GetEventDetailsResponseDataOrganizerEmail
The email address of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer information
organizer_name
organizer_name:
GetEventDetailsResponseDataOrganizerName
The display name of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer name information
attendees
attendees:
GetEventDetailsResponseDataAttendees
List of event attendees as returned by the calendar platform. Null if the calendar platform did not provide attendee information or if the event has no attendees
meeting_url
meeting_url:
GetEventDetailsResponseDataMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
GetEventDetailsResponseDataMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
GetEventDetailsResponseDataCalendarPlatform
The calendar platform where this event originates. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when this event instance was last updated (either from a sync or from a webhook notification)
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetEventDetailsResponseDataAttendees
GetEventDetailsResponseDataAttendees =
GetEventDetailsResponseDataAttendeesAnyOfItem[] |null
List of event attendees as returned by the calendar platform. Null if the calendar platform did not provide attendee information or if the event has no attendees
GetEventDetailsResponseDataAttendeesAnyOfItem
GetEventDetailsResponseDataAttendeesAnyOfItem =
object
Properties
email:
string
The email address of the attendee
name
The display name of the attendee as returned by the calendar platform. Null if the calendar platform did not provide a display name for this attendee
response_status
response_status:
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus
The attendee's response status to the event invitation. Defaults to 'needsAction' if the calendar platform did not provide response status information. Possible values: 'accepted' (attendee accepted the invitation), 'declined' (attendee declined the invitation), 'tentative' (attendee responded as tentative), 'needsAction' (attendee has not responded yet)
organizer?
optionalorganizer:boolean
Whether this attendee is the organizer of the event. Only present if the calendar platform provides this information
self?
optionalself:boolean
Whether this attendee represents the authenticated user who owns the calendar connection. Only present if the calendar platform provides this information
GetEventDetailsResponseDataAttendeesAnyOfItemName
GetEventDetailsResponseDataAttendeesAnyOfItemName =
string|null
The display name of the attendee as returned by the calendar platform. Null if the calendar platform did not provide a display name for this attendee
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus = typeof
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus[keyof typeofGetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus]
The attendee's response status to the event invitation. Defaults to 'needsAction' if the calendar platform did not provide response status information. Possible values: 'accepted' (attendee accepted the invitation), 'declined' (attendee declined the invitation), 'tentative' (attendee responded as tentative), 'needsAction' (attendee has not responded yet)
GetEventDetailsResponseDataCalendarPlatform
GetEventDetailsResponseDataCalendarPlatform = typeof
GetEventDetailsResponseDataCalendarPlatform[keyof typeofGetEventDetailsResponseDataCalendarPlatform]
The calendar platform where this event originates. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
GetEventDetailsResponseDataDescription
GetEventDetailsResponseDataDescription =
string|null
The description of the event as returned by the calendar platform. Null if the calendar platform did not include a description for this event
GetEventDetailsResponseDataEventType
GetEventDetailsResponseDataEventType = typeof
GetEventDetailsResponseDataEventType[keyof typeofGetEventDetailsResponseDataEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
GetEventDetailsResponseDataLocation
GetEventDetailsResponseDataLocation =
string|null
The location of the event as returned by the calendar platform. Null if the calendar platform did not include a location for this event
GetEventDetailsResponseDataMeetingPlatform
GetEventDetailsResponseDataMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
GetEventDetailsResponseDataMeetingUrl
GetEventDetailsResponseDataMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
GetEventDetailsResponseDataOrganizerEmail
GetEventDetailsResponseDataOrganizerEmail =
string|null
The email address of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer information
GetEventDetailsResponseDataOrganizerName
GetEventDetailsResponseDataOrganizerName =
string|null
The display name of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer name information
GetEventDetailsResponseDataStatus
GetEventDetailsResponseDataStatus = typeof
GetEventDetailsResponseDataStatus[keyof typeofGetEventDetailsResponseDataStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
GetEventDetailsResponseDataTimezone
GetEventDetailsResponseDataTimezone =
string|null
The IANA timezone identifier for the event (e.g., 'America/New_York', 'Europe/London'). Null if the calendar platform did not provide timezone information or if the event is all-day
GetEventDetailsResponseInputData
GetEventDetailsResponseInputData =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
series_id
series_id:
string
The UUID of the event series this instance belongs to. Every event instance (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
GetEventDetailsResponseInputDataEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
title
title:
string
The title of the event as stored in the calendar
description
description:
GetEventDetailsResponseInputDataDescription
The description of the event as returned by the calendar platform. Null if the calendar platform did not include a description for this event
location
location:
GetEventDetailsResponseInputDataLocation
The location of the event as returned by the calendar platform. Null if the calendar platform did not include a location for this event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
timezone
timezone:
GetEventDetailsResponseInputDataTimezone
The IANA timezone identifier for the event (e.g., 'America/New_York', 'Europe/London'). Null if the calendar platform did not provide timezone information or if the event is all-day
is_all_day
is_all_day:
boolean
Whether this is an all-day event. True if the event spans entire days without specific start/end times
status
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
organizer_email
organizer_email:
GetEventDetailsResponseInputDataOrganizerEmail
The email address of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer information
organizer_name
organizer_name:
GetEventDetailsResponseInputDataOrganizerName
The display name of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer name information
attendees
attendees:
GetEventDetailsResponseInputDataAttendees
List of event attendees as returned by the calendar platform. Null if the calendar platform did not provide attendee information or if the event has no attendees
meeting_url
meeting_url:
GetEventDetailsResponseInputDataMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
GetEventDetailsResponseInputDataMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
GetEventDetailsResponseInputDataCalendarPlatform
The calendar platform where this event originates. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when this event instance was last updated (either from a sync or from a webhook notification)
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
GetEventDetailsResponseInputDataAttendees
GetEventDetailsResponseInputDataAttendees =
GetEventDetailsResponseInputDataAttendeesAnyOfItem[] |null
List of event attendees as returned by the calendar platform. Null if the calendar platform did not provide attendee information or if the event has no attendees
GetEventDetailsResponseInputDataAttendeesAnyOfItem
GetEventDetailsResponseInputDataAttendeesAnyOfItem =
object
Properties
email:
string
The email address of the attendee
name
name:
GetEventDetailsResponseInputDataAttendeesAnyOfItemName
The display name of the attendee as returned by the calendar platform. Null if the calendar platform did not provide a display name for this attendee
response_status
response_status:
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus
The attendee's response status to the event invitation. Defaults to 'needsAction' if the calendar platform did not provide response status information. Possible values: 'accepted' (attendee accepted the invitation), 'declined' (attendee declined the invitation), 'tentative' (attendee responded as tentative), 'needsAction' (attendee has not responded yet)
organizer?
optionalorganizer:boolean
Whether this attendee is the organizer of the event. Only present if the calendar platform provides this information
self?
optionalself:boolean
Whether this attendee represents the authenticated user who owns the calendar connection. Only present if the calendar platform provides this information
GetEventDetailsResponseInputDataAttendeesAnyOfItemName
GetEventDetailsResponseInputDataAttendeesAnyOfItemName =
string|null
The display name of the attendee as returned by the calendar platform. Null if the calendar platform did not provide a display name for this attendee
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus = typeof
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus[keyof typeofGetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus]
The attendee's response status to the event invitation. Defaults to 'needsAction' if the calendar platform did not provide response status information. Possible values: 'accepted' (attendee accepted the invitation), 'declined' (attendee declined the invitation), 'tentative' (attendee responded as tentative), 'needsAction' (attendee has not responded yet)
GetEventDetailsResponseInputDataCalendarPlatform
GetEventDetailsResponseInputDataCalendarPlatform = typeof
GetEventDetailsResponseInputDataCalendarPlatform[keyof typeofGetEventDetailsResponseInputDataCalendarPlatform]
The calendar platform where this event originates. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
GetEventDetailsResponseInputDataDescription
GetEventDetailsResponseInputDataDescription =
string|null
The description of the event as returned by the calendar platform. Null if the calendar platform did not include a description for this event
GetEventDetailsResponseInputDataEventType
GetEventDetailsResponseInputDataEventType = typeof
GetEventDetailsResponseInputDataEventType[keyof typeofGetEventDetailsResponseInputDataEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
GetEventDetailsResponseInputDataLocation
GetEventDetailsResponseInputDataLocation =
string|null
The location of the event as returned by the calendar platform. Null if the calendar platform did not include a location for this event
GetEventDetailsResponseInputDataMeetingPlatform
GetEventDetailsResponseInputDataMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
GetEventDetailsResponseInputDataMeetingUrl
GetEventDetailsResponseInputDataMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
GetEventDetailsResponseInputDataOrganizerEmail
GetEventDetailsResponseInputDataOrganizerEmail =
string|null
The email address of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer information
GetEventDetailsResponseInputDataOrganizerName
GetEventDetailsResponseInputDataOrganizerName =
string|null
The display name of the event organizer as returned by the calendar platform. Null if the calendar platform did not provide organizer name information
GetEventDetailsResponseInputDataStatus
GetEventDetailsResponseInputDataStatus = typeof
GetEventDetailsResponseInputDataStatus[keyof typeofGetEventDetailsResponseInputDataStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
GetEventDetailsResponseInputDataTimezone
GetEventDetailsResponseInputDataTimezone =
string|null
The IANA timezone identifier for the event (e.g., 'America/New_York', 'Europe/London'). Null if the calendar platform did not provide timezone information or if the event is all-day
GetScheduledBotDetails429
GetScheduledBotDetails429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:GetScheduledBotDetails429Message
Human-readable error message
details?
optionaldetails:GetScheduledBotDetails429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
GetScheduledBotDetails429Details
GetScheduledBotDetails429Details =
string|null
Additional error details (string or null)
GetScheduledBotDetails429Message
GetScheduledBotDetails429Message =
string|null
Human-readable error message
GetScheduledBotResponseData
GetScheduledBotResponseData =
object
Properties
bot_id
bot_id:
string
The UUID of the scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the scheduled bot
bot_image
bot_image:
GetScheduledBotResponseDataBotImage
The image URL for the bot (null if not set)
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
GetScheduledBotResponseDataMeetingPlatform
The platform of the meeting
recording_mode
recording_mode:
GetScheduledBotResponseDataRecordingMode
The recording mode for the bot
join_at
join_at:
string
ISO 8601 timestamp when the bot should join the meeting
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The current status of the scheduled bot
created_at
created_at:
string
ISO 8601 timestamp when the scheduled bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the scheduled bot was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
cancelled_at
cancelled_at:
GetScheduledBotResponseDataCancelledAt
ISO 8601 timestamp when the scheduled bot was cancelled (null if not cancelled)
allow_multiple_bots
allow_multiple_bots:
boolean
Whether multiple bots are allowed in the meeting
entry_message
entry_message:
GetScheduledBotResponseDataEntryMessage
Custom message to send when bot joins (null if not set)
timeout_config
timeout_config:
GetScheduledBotResponseDataTimeoutConfig
transcription_config
transcription_config:
GetScheduledBotResponseDataTranscriptionConfig
Transcription configuration (null if transcription is disabled)
streaming_config
streaming_config:
GetScheduledBotResponseDataStreamingConfig
Streaming configuration (null if streaming is disabled)
callback_config
callback_config:
GetScheduledBotResponseDataCallbackConfig
Callback configuration (null if callback is disabled)
extra
Custom metadata associated with the scheduled bot
GetScheduledBotResponseDataBotImage
GetScheduledBotResponseDataBotImage =
string|null
The image URL for the bot (null if not set)
GetScheduledBotResponseDataCallbackConfig
GetScheduledBotResponseDataCallbackConfig =
GetScheduledBotResponseDataCallbackConfigAnyOf|null
Callback configuration (null if callback is disabled)
GetScheduledBotResponseDataCallbackConfigAnyOf
GetScheduledBotResponseDataCallbackConfigAnyOf =
object
Properties
enabled
enabled:
true
url
url:
string
Callback URL
secret
secret:
GetScheduledBotResponseDataCallbackConfigAnyOfSecret
Secret for validating callbacks (null if not set)
method
method:
GetScheduledBotResponseDataCallbackConfigAnyOfMethod
HTTP method for callback
GetScheduledBotResponseDataCallbackConfigAnyOfMethod
GetScheduledBotResponseDataCallbackConfigAnyOfMethod = typeof
GetScheduledBotResponseDataCallbackConfigAnyOfMethod[keyof typeofGetScheduledBotResponseDataCallbackConfigAnyOfMethod]
HTTP method for callback
GetScheduledBotResponseDataCallbackConfigAnyOfSecret
GetScheduledBotResponseDataCallbackConfigAnyOfSecret =
string|null
Secret for validating callbacks (null if not set)
GetScheduledBotResponseDataCancelledAt
GetScheduledBotResponseDataCancelledAt =
string|null
ISO 8601 timestamp when the scheduled bot was cancelled (null if not cancelled)
GetScheduledBotResponseDataEntryMessage
GetScheduledBotResponseDataEntryMessage =
string|null
Custom message to send when bot joins (null if not set)
GetScheduledBotResponseDataExtra
GetScheduledBotResponseDataExtra =
GetScheduledBotResponseDataExtraAnyOf|null
Custom metadata associated with the scheduled bot
GetScheduledBotResponseDataExtraAnyOf
GetScheduledBotResponseDataExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetScheduledBotResponseDataMeetingPlatform
GetScheduledBotResponseDataMeetingPlatform = typeof
GetScheduledBotResponseDataMeetingPlatform[keyof typeofGetScheduledBotResponseDataMeetingPlatform]
The platform of the meeting
GetScheduledBotResponseDataRecordingMode
GetScheduledBotResponseDataRecordingMode = typeof
GetScheduledBotResponseDataRecordingMode[keyof typeofGetScheduledBotResponseDataRecordingMode]
The recording mode for the bot
GetScheduledBotResponseDataStatus
GetScheduledBotResponseDataStatus = typeof
GetScheduledBotResponseDataStatus[keyof typeofGetScheduledBotResponseDataStatus]
The current status of the scheduled bot
GetScheduledBotResponseDataStreamingConfig
GetScheduledBotResponseDataStreamingConfig =
GetScheduledBotResponseDataStreamingConfigAnyOf|null
Streaming configuration (null if streaming is disabled)
GetScheduledBotResponseDataStreamingConfigAnyOf
GetScheduledBotResponseDataStreamingConfigAnyOf =
object
Properties
enabled
enabled:
true
input_url
input_url:
GetScheduledBotResponseDataStreamingConfigAnyOfInputUrl
Websocket URL for receiving audio (null if not set)
output_url
output_url:
GetScheduledBotResponseDataStreamingConfigAnyOfOutputUrl
Websocket URL for sending audio (null if not set)
audio_frequency
audio_frequency:
GetScheduledBotResponseDataStreamingConfigAnyOfAudioFrequency
Audio frequency in Hz (null if not set)
GetScheduledBotResponseDataStreamingConfigAnyOfAudioFrequency
GetScheduledBotResponseDataStreamingConfigAnyOfAudioFrequency =
number|null
Audio frequency in Hz (null if not set)
GetScheduledBotResponseDataStreamingConfigAnyOfInputUrl
GetScheduledBotResponseDataStreamingConfigAnyOfInputUrl =
string|null
Websocket URL for receiving audio (null if not set)
GetScheduledBotResponseDataStreamingConfigAnyOfOutputUrl
GetScheduledBotResponseDataStreamingConfigAnyOfOutputUrl =
string|null
Websocket URL for sending audio (null if not set)
GetScheduledBotResponseDataTimeoutConfig
GetScheduledBotResponseDataTimeoutConfig =
object
Properties
waiting_room_timeout
waiting_room_timeout:
GetScheduledBotResponseDataTimeoutConfigWaitingRoomTimeout
Timeout in seconds for waiting room (null if not set)
no_one_joined_timeout
no_one_joined_timeout:
GetScheduledBotResponseDataTimeoutConfigNoOneJoinedTimeout
Timeout in seconds if no one joins (null if not set)
GetScheduledBotResponseDataTimeoutConfigNoOneJoinedTimeout
GetScheduledBotResponseDataTimeoutConfigNoOneJoinedTimeout =
number|null
Timeout in seconds if no one joins (null if not set)
GetScheduledBotResponseDataTimeoutConfigWaitingRoomTimeout
GetScheduledBotResponseDataTimeoutConfigWaitingRoomTimeout =
number|null
Timeout in seconds for waiting room (null if not set)
GetScheduledBotResponseDataTranscriptionConfig
GetScheduledBotResponseDataTranscriptionConfig =
GetScheduledBotResponseDataTranscriptionConfigAnyOf|null
Transcription configuration (null if transcription is disabled)
GetScheduledBotResponseDataTranscriptionConfigAnyOf
GetScheduledBotResponseDataTranscriptionConfigAnyOf =
object
Properties
enabled
enabled:
true
provider
provider:
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider
custom_params
custom_params:
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParams
Custom parameters for transcription (null if not set)
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParams
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParams =
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for transcription (null if not set)
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParamsAnyOf
GetScheduledBotResponseDataTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider = typeof
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider[keyof typeofGetScheduledBotResponseDataTranscriptionConfigAnyOfProvider]
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
GetScheduledBotResponseInputData
GetScheduledBotResponseInputData =
object
Properties
bot_id
bot_id:
string
The UUID of the scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the scheduled bot
bot_image
bot_image:
GetScheduledBotResponseInputDataBotImage
The image URL for the bot (null if not set)
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
GetScheduledBotResponseInputDataMeetingPlatform
The platform of the meeting
recording_mode
recording_mode:
GetScheduledBotResponseInputDataRecordingMode
The recording mode for the bot
join_at
join_at:
string
ISO 8601 timestamp when the bot should join the meeting
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The current status of the scheduled bot
created_at
created_at:
string
ISO 8601 timestamp when the scheduled bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the scheduled bot was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
cancelled_at
cancelled_at:
GetScheduledBotResponseInputDataCancelledAt
ISO 8601 timestamp when the scheduled bot was cancelled (null if not cancelled)
allow_multiple_bots
allow_multiple_bots:
boolean
Whether multiple bots are allowed in the meeting
entry_message
entry_message:
GetScheduledBotResponseInputDataEntryMessage
Custom message to send when bot joins (null if not set)
timeout_config
timeout_config:
GetScheduledBotResponseInputDataTimeoutConfig
transcription_config
transcription_config:
GetScheduledBotResponseInputDataTranscriptionConfig
Transcription configuration (null if transcription is disabled)
streaming_config
streaming_config:
GetScheduledBotResponseInputDataStreamingConfig
Streaming configuration (null if streaming is disabled)
callback_config
callback_config:
GetScheduledBotResponseInputDataCallbackConfig
Callback configuration (null if callback is disabled)
extra
Custom metadata associated with the scheduled bot
GetScheduledBotResponseInputDataBotImage
GetScheduledBotResponseInputDataBotImage =
string|null
The image URL for the bot (null if not set)
GetScheduledBotResponseInputDataCallbackConfig
GetScheduledBotResponseInputDataCallbackConfig =
GetScheduledBotResponseInputDataCallbackConfigAnyOf|null
Callback configuration (null if callback is disabled)
GetScheduledBotResponseInputDataCallbackConfigAnyOf
GetScheduledBotResponseInputDataCallbackConfigAnyOf =
object
Properties
enabled
enabled:
true
url
url:
string
Callback URL
secret
secret:
GetScheduledBotResponseInputDataCallbackConfigAnyOfSecret
Secret for validating callbacks (null if not set)
method
method:
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod
HTTP method for callback
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod = typeof
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod[keyof typeofGetScheduledBotResponseInputDataCallbackConfigAnyOfMethod]
HTTP method for callback
GetScheduledBotResponseInputDataCallbackConfigAnyOfSecret
GetScheduledBotResponseInputDataCallbackConfigAnyOfSecret =
string|null
Secret for validating callbacks (null if not set)
GetScheduledBotResponseInputDataCancelledAt
GetScheduledBotResponseInputDataCancelledAt =
string|null
ISO 8601 timestamp when the scheduled bot was cancelled (null if not cancelled)
GetScheduledBotResponseInputDataEntryMessage
GetScheduledBotResponseInputDataEntryMessage =
string|null
Custom message to send when bot joins (null if not set)
GetScheduledBotResponseInputDataExtra
GetScheduledBotResponseInputDataExtra =
GetScheduledBotResponseInputDataExtraAnyOf|null
Custom metadata associated with the scheduled bot
GetScheduledBotResponseInputDataExtraAnyOf
GetScheduledBotResponseInputDataExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetScheduledBotResponseInputDataMeetingPlatform
GetScheduledBotResponseInputDataMeetingPlatform = typeof
GetScheduledBotResponseInputDataMeetingPlatform[keyof typeofGetScheduledBotResponseInputDataMeetingPlatform]
The platform of the meeting
GetScheduledBotResponseInputDataRecordingMode
GetScheduledBotResponseInputDataRecordingMode = typeof
GetScheduledBotResponseInputDataRecordingMode[keyof typeofGetScheduledBotResponseInputDataRecordingMode]
The recording mode for the bot
GetScheduledBotResponseInputDataStatus
GetScheduledBotResponseInputDataStatus = typeof
GetScheduledBotResponseInputDataStatus[keyof typeofGetScheduledBotResponseInputDataStatus]
The current status of the scheduled bot
GetScheduledBotResponseInputDataStreamingConfig
GetScheduledBotResponseInputDataStreamingConfig =
GetScheduledBotResponseInputDataStreamingConfigAnyOf|null
Streaming configuration (null if streaming is disabled)
GetScheduledBotResponseInputDataStreamingConfigAnyOf
GetScheduledBotResponseInputDataStreamingConfigAnyOf =
object
Properties
enabled
enabled:
true
input_url
input_url:
GetScheduledBotResponseInputDataStreamingConfigAnyOfInputUrl
Websocket URL for receiving audio (null if not set)
output_url
output_url:
GetScheduledBotResponseInputDataStreamingConfigAnyOfOutputUrl
Websocket URL for sending audio (null if not set)
audio_frequency
audio_frequency:
GetScheduledBotResponseInputDataStreamingConfigAnyOfAudioFrequency
Audio frequency in Hz (null if not set)
GetScheduledBotResponseInputDataStreamingConfigAnyOfAudioFrequency
GetScheduledBotResponseInputDataStreamingConfigAnyOfAudioFrequency =
number|null
Audio frequency in Hz (null if not set)
GetScheduledBotResponseInputDataStreamingConfigAnyOfInputUrl
GetScheduledBotResponseInputDataStreamingConfigAnyOfInputUrl =
string|null
Websocket URL for receiving audio (null if not set)
GetScheduledBotResponseInputDataStreamingConfigAnyOfOutputUrl
GetScheduledBotResponseInputDataStreamingConfigAnyOfOutputUrl =
string|null
Websocket URL for sending audio (null if not set)
GetScheduledBotResponseInputDataTimeoutConfig
GetScheduledBotResponseInputDataTimeoutConfig =
object
Properties
waiting_room_timeout
waiting_room_timeout:
GetScheduledBotResponseInputDataTimeoutConfigWaitingRoomTimeout
Timeout in seconds for waiting room (null if not set)
no_one_joined_timeout
no_one_joined_timeout:
GetScheduledBotResponseInputDataTimeoutConfigNoOneJoinedTimeout
Timeout in seconds if no one joins (null if not set)
GetScheduledBotResponseInputDataTimeoutConfigNoOneJoinedTimeout
GetScheduledBotResponseInputDataTimeoutConfigNoOneJoinedTimeout =
number|null
Timeout in seconds if no one joins (null if not set)
GetScheduledBotResponseInputDataTimeoutConfigWaitingRoomTimeout
GetScheduledBotResponseInputDataTimeoutConfigWaitingRoomTimeout =
number|null
Timeout in seconds for waiting room (null if not set)
GetScheduledBotResponseInputDataTranscriptionConfig
GetScheduledBotResponseInputDataTranscriptionConfig =
GetScheduledBotResponseInputDataTranscriptionConfigAnyOf|null
Transcription configuration (null if transcription is disabled)
GetScheduledBotResponseInputDataTranscriptionConfigAnyOf
GetScheduledBotResponseInputDataTranscriptionConfigAnyOf =
object
Properties
enabled
enabled:
true
provider
provider:
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider
custom_params
custom_params:
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParams
Custom parameters for transcription (null if not set)
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParams
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParams =
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for transcription (null if not set)
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParamsAnyOf
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider = typeof
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider[keyof typeofGetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider]
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
LeaveBot429
LeaveBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:LeaveBot429Message
Human-readable error message
details?
optionaldetails:LeaveBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
LeaveBot429Details
LeaveBot429Details =
string|null
Additional error details (string or null)
LeaveBot429Message
LeaveBot429Message =
string|null
Human-readable error message
LeaveBotResponseData
LeaveBotResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
LeaveBotResponseInputData
LeaveBotResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
ListBots429
ListBots429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListBots429Message
Human-readable error message
details?
optionaldetails:ListBots429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListBots429Details
ListBots429Details =
string|null
Additional error details (string or null)
ListBots429Message
ListBots429Message =
string|null
Human-readable error message
ListBotsMeetingPlatformAnyOf
ListBotsMeetingPlatformAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListBotsParams
ListBotsParams =
object
Properties
bot_name?
optionalbot_name:string|null
Filter bots by name containing this string.
Performs a case-insensitive partial match on the bot's name. Useful for finding bots with specific naming conventions or to locate a particular bot when you don't have its ID.
Example: "Sales" would match "Sales Meeting", "Quarterly Sales", etc.
bot_id?
optionalbot_id:string|null
Filter bots by ID containing this string.
Performs a case-insensitive partial match on the bot's ID. Useful for finding bots with specific IDs or to locate a particular bot when you don't have its ID.
Example: "1234567890" would match "1234567890-1234-1234-1234-123456789012"
created_before?
optionalcreated_before:string|null
Filter bots created before this date.
ISO8601 format (e.g., "2025-01-15T10:30:00Z").
Cannot be more than 90 days before today and cannot be in the future.
Use this in combination with created_after to filter bots within a specific date range.
Example: "2025-01-15T23:59:59Z"
created_after?
optionalcreated_after:string|null
Filter bots created after this date.
ISO8601 format (e.g., "2025-01-01T00:00:00Z").
Cannot be more than 90 days before today and cannot be in the future.
Use this in combination with created_before to filter bots within a specific date range.
Example: "2025-01-01T00:00:00Z"
limit?
optionallimit:number
Maximum number of bots to return in a single request.
Limits the number of results returned in a single API call.
Default: 50 Minimum: 1 Maximum: 250
Maximum
250
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing <isoDate>::\<id\>. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MjAyNS0wMS0xNVQxMDozMDowMFo6OjEyMzQ1" or "LU1qQXlOM1UxTmpVME5qVXhNakUwTkRrPQ==" (for backward pagination)
ended_after?
optionalended_after:string|null
The date to filter bots ended after. ISO 8601 format.
extra?
optionalextra:string|null
Filter bots by matching values in the extra JSON payload.
This parameter performs in-memory filtering on the extra JSON field, similar to a SQL WHERE clause. It reduces the result set to only include bots that match all specified conditions.
Format specifications: - Single condition: "field:value" - Multiple conditions: "field1:value1,field2:value2"
Examples: - "customer_id:12345" - Only bots with this customer ID - "status:active,project:sales" - Only active bots from sales projects
Notes: - All conditions must match for a bot to be included - Values are matched exactly (case-sensitive) - Bots without the specified field are excluded
meeting_url?
optionalmeeting_url:string|null
Filter bots by meeting URL containing this string.
Performs a case-insensitive partial match on the bot's meeting URL. Useful for finding bots associated with specific meeting platforms or particular meeting IDs.
Example: "zoom.us" would match all Zoom meetings
meeting_platform?
optionalmeeting_platform:ListBotsMeetingPlatformAnyOf|null
Filter bots by meeting platform.
This parameter filters bots by the platform they are associated with. It can be used to find bots that are associated with a specific meeting platform. Valid values are: "zoom", "meet", "teams".
Example: "zoom" would match all bots associated with Zoom meetings.
To filter multiple platforms, use a comma-separated list of values. For example, "zoom,meet" would match all bots associated with Zoom or Meet meetings.
status?
optionalstatus:ListBotsStatusAnyOf|null
Filter bots by bot statuses.
This parameter filters bots by their status. It can be used to find bots that have any of the specified statuses. Valid values are one or more of: queued, transcribing, completed, failed, joining_call, in_waiting_room, in_waiting_for_host, in_call_not_recording, in_call_recording, recording_paused, recording_resumed, call_ended, recording_succeeded, recording_failed, api_request_stop, bot_rejected, bot_removed, bot_removed_too_early, waiting_room_timeout, invalid_meeting_url, meeting_error.
Example: "queued,joining_call" would match all bots that are queued or joining the call
ListBotsResponseCursor
ListBotsResponseCursor =
string|null
Cursor for the next page (null if no more pages)
ListBotsResponseDataItem
ListBotsResponseDataItem =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
ListBotsResponseDataItemMeetingPlatform
The platform of the meeting (zoom, meet, or teams)
extra
Custom metadata associated with the bot
duration
duration:
ListBotsResponseDataItemDuration
Duration of the meeting in seconds (null if meeting hasn't ended)
created_at
created_at:
string
ISO 8601 timestamp when the bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ended_at
ended_at:
ListBotsResponseDataItemEndedAt
ISO 8601 timestamp when the bot ended (null if still active)
joined_at
joined_at:
ListBotsResponseDataItemJoinedAt
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
exited_at
exited_at:
ListBotsResponseDataItemExitedAt
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
status
status:
ListBotsResponseDataItemStatus
The current status of the bot
error_code
error_code:
ListBotsResponseDataItemErrorCode
Error code if the bot failed (null if no error)
error_message
error_message:
ListBotsResponseDataItemErrorMessage
Human-readable error message if the bot failed (null if no error)
ListBotsResponseDataItemDuration
ListBotsResponseDataItemDuration =
number|null
Duration of the meeting in seconds (null if meeting hasn't ended)
ListBotsResponseDataItemEndedAt
ListBotsResponseDataItemEndedAt =
string|null
ISO 8601 timestamp when the bot ended (null if still active)
ListBotsResponseDataItemErrorCode
ListBotsResponseDataItemErrorCode =
string|null
Error code if the bot failed (null if no error)
ListBotsResponseDataItemErrorMessage
ListBotsResponseDataItemErrorMessage =
string|null
Human-readable error message if the bot failed (null if no error)
ListBotsResponseDataItemExitedAt
ListBotsResponseDataItemExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
ListBotsResponseDataItemExtra
ListBotsResponseDataItemExtra =
ListBotsResponseDataItemExtraAnyOf|null
Custom metadata associated with the bot
ListBotsResponseDataItemExtraAnyOf
ListBotsResponseDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
ListBotsResponseDataItemJoinedAt
ListBotsResponseDataItemJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
ListBotsResponseDataItemMeetingPlatform
ListBotsResponseDataItemMeetingPlatform = typeof
ListBotsResponseDataItemMeetingPlatform[keyof typeofListBotsResponseDataItemMeetingPlatform]
The platform of the meeting (zoom, meet, or teams)
ListBotsResponseDataItemStatus
ListBotsResponseDataItemStatus = typeof
ListBotsResponseDataItemStatus[keyof typeofListBotsResponseDataItemStatus]
The current status of the bot
ListBotsResponseInputCursor
ListBotsResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
ListBotsResponseInputDataItem
ListBotsResponseInputDataItem =
object
Properties
bot_id
bot_id:
string
The UUID of the bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
ListBotsResponseInputDataItemMeetingPlatform
The platform of the meeting (zoom, meet, or teams)
extra
Custom metadata associated with the bot
duration
duration:
ListBotsResponseInputDataItemDuration
Duration of the meeting in seconds (null if meeting hasn't ended)
created_at
created_at:
string
ISO 8601 timestamp when the bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ended_at
ended_at:
ListBotsResponseInputDataItemEndedAt
ISO 8601 timestamp when the bot ended (null if still active)
joined_at
joined_at:
ListBotsResponseInputDataItemJoinedAt
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
exited_at
exited_at:
ListBotsResponseInputDataItemExitedAt
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
status
The current status of the bot
error_code
error_code:
ListBotsResponseInputDataItemErrorCode
Error code if the bot failed (null if no error)
error_message
error_message:
ListBotsResponseInputDataItemErrorMessage
Human-readable error message if the bot failed (null if no error)
ListBotsResponseInputDataItemDuration
ListBotsResponseInputDataItemDuration =
number|null
Duration of the meeting in seconds (null if meeting hasn't ended)
ListBotsResponseInputDataItemEndedAt
ListBotsResponseInputDataItemEndedAt =
string|null
ISO 8601 timestamp when the bot ended (null if still active)
ListBotsResponseInputDataItemErrorCode
ListBotsResponseInputDataItemErrorCode =
string|null
Error code if the bot failed (null if no error)
ListBotsResponseInputDataItemErrorMessage
ListBotsResponseInputDataItemErrorMessage =
string|null
Human-readable error message if the bot failed (null if no error)
ListBotsResponseInputDataItemExitedAt
ListBotsResponseInputDataItemExitedAt =
string|null
ISO 8601 timestamp when the bot exited the meeting (null if not exited yet)
ListBotsResponseInputDataItemExtra
ListBotsResponseInputDataItemExtra =
ListBotsResponseInputDataItemExtraAnyOf|null
Custom metadata associated with the bot
ListBotsResponseInputDataItemExtraAnyOf
ListBotsResponseInputDataItemExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
ListBotsResponseInputDataItemJoinedAt
ListBotsResponseInputDataItemJoinedAt =
string|null
ISO 8601 timestamp when the bot joined the meeting (null if not joined yet)
ListBotsResponseInputDataItemMeetingPlatform
ListBotsResponseInputDataItemMeetingPlatform = typeof
ListBotsResponseInputDataItemMeetingPlatform[keyof typeofListBotsResponseInputDataItemMeetingPlatform]
The platform of the meeting (zoom, meet, or teams)
ListBotsResponseInputDataItemStatus
ListBotsResponseInputDataItemStatus = typeof
ListBotsResponseInputDataItemStatus[keyof typeofListBotsResponseInputDataItemStatus]
The current status of the bot
ListBotsResponseInputPrevCursor
ListBotsResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListBotsResponsePrevCursor
ListBotsResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListBotsStatusAnyOf
ListBotsStatusAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListCalendars429
ListCalendars429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListCalendars429Message
Human-readable error message
details?
optionaldetails:ListCalendars429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListCalendars429Details
ListCalendars429Details =
string|null
Additional error details (string or null)
ListCalendars429Message
ListCalendars429Message =
string|null
Human-readable error message
ListCalendarsCalendarPlatformAnyOf
ListCalendarsCalendarPlatformAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListCalendarsParams
ListCalendarsParams =
object
Properties
limit?
optionallimit:number
Maximum number of calendars to return in a single request.
Limits the number of results returned in a single API call.
Default: 50 Minimum: 1 Maximum: 250
Minimum
1
Maximum
250
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing <isoDate>::\<id\>. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MjAyNS0wMS0xNVQxMDozMDowMFo6OjEyMzQ1" or "LU1qQXlOM1UxTmpVME5qVXhNakUwTkRrPQ==" (for backward pagination)
account_email?
optionalaccount_email:string|null
Filter calendars by account email address. This performs a case-insensitive partial match (ilike) on the email address associated with the calendar account.
Example: "example" would match all calendars with email addresses containing "example" (e.g., "example@domain.com", "user@example.com").
calendar_platform?
optionalcalendar_platform:ListCalendarsCalendarPlatformAnyOf|null
Filter calendars by platform. It can be used to find calendars that are associated with a specific platform. Valid values are: "google", "microsoft".
Example: "google" would match all Google Calendar connections.
To filter multiple platforms, use a comma-separated list of values. For example, "google,microsoft" would match all calendars from both platforms.
status?
optionalstatus:ListCalendarsStatusAnyOf|null
Filter calendars by connection status(es). It can be used to find calendars that have any of the specified statuses. Valid values are one or more of: active, error, revoked, permission_denied.
Example: "active,error" would match all calendars that are active or have errors.
To filter multiple statuses, use a comma-separated list of values.
ListCalendarsResponseCursor
ListCalendarsResponseCursor =
string|null
Cursor for the next page (null if no more pages)
ListCalendarsResponseDataItem
ListCalendarsResponseDataItem =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
ListCalendarsResponseDataItemCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
synced_at
synced_at:
ListCalendarsResponseDataItemSyncedAt
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced yet. Syncs happen automatically when events change, or can be triggered manually using the sync endpoint
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and initially synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListCalendarsResponseDataItemCalendarPlatform
ListCalendarsResponseDataItemCalendarPlatform = typeof
ListCalendarsResponseDataItemCalendarPlatform[keyof typeofListCalendarsResponseDataItemCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
ListCalendarsResponseDataItemStatus
ListCalendarsResponseDataItemStatus = typeof
ListCalendarsResponseDataItemStatus[keyof typeofListCalendarsResponseDataItemStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
ListCalendarsResponseDataItemSyncedAt
ListCalendarsResponseDataItemSyncedAt =
string|null
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced yet. Syncs happen automatically when events change, or can be triggered manually using the sync endpoint
ListCalendarsResponseInputCursor
ListCalendarsResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
ListCalendarsResponseInputDataItem
ListCalendarsResponseInputDataItem =
object
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
ListCalendarsResponseInputDataItemCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
synced_at
synced_at:
ListCalendarsResponseInputDataItemSyncedAt
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced yet. Syncs happen automatically when events change, or can be triggered manually using the sync endpoint
created_at
created_at:
string
ISO 8601 timestamp when the calendar connection was created and initially synced
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListCalendarsResponseInputDataItemCalendarPlatform
ListCalendarsResponseInputDataItemCalendarPlatform = typeof
ListCalendarsResponseInputDataItemCalendarPlatform[keyof typeofListCalendarsResponseInputDataItemCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
ListCalendarsResponseInputDataItemStatus
ListCalendarsResponseInputDataItemStatus = typeof
ListCalendarsResponseInputDataItemStatus[keyof typeofListCalendarsResponseInputDataItemStatus]
The current status of the calendar connection. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
ListCalendarsResponseInputDataItemSyncedAt
ListCalendarsResponseInputDataItemSyncedAt =
string|null
ISO 8601 timestamp of the last successful calendar sync. Null if the calendar has never been synced yet. Syncs happen automatically when events change, or can be triggered manually using the sync endpoint
ListCalendarsResponseInputPrevCursor
ListCalendarsResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListCalendarsResponsePrevCursor
ListCalendarsResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListCalendarsStatusAnyOf
ListCalendarsStatusAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListEventSeries429
ListEventSeries429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListEventSeries429Message
Human-readable error message
details?
optionaldetails:ListEventSeries429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListEventSeries429Details
ListEventSeries429Details =
string|null
Additional error details (string or null)
ListEventSeries429Message
ListEventSeries429Message =
string|null
Human-readable error message
ListEventSeriesEventTypeAnyOf
ListEventSeriesEventTypeAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListEventSeriesParams
ListEventSeriesParams =
object
Properties
limit?
optionallimit:number
Maximum number of event series to return in a single request.
Limits the number of results returned in a single API call.
Default: 50 Minimum: 1 Maximum: 250
Minimum
1
Maximum
250
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing <isoDate>::\<id\>. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MjAyNS0wMS0xNVQxMDozMDowMFo6OjEyMzQ1" or "LU1qQXlOM1UxTmpVME5qVXhNakUwTkRrPQ==" (for backward pagination)
event_type?
optionalevent_type:ListEventSeriesEventTypeAnyOf|null
Filter event series by type(s). It can be used to find event series that have any of the specified types. Valid values are one or more of: one_off, recurring.
Example: "one_off,recurring" would match all event series that are one-off or recurring.
To filter multiple types, use a comma-separated list of values.
show_cancelled?
optionalshow_cancelled:boolean
Whether to include cancelled event instances in the results. When set to 'false', only non-cancelled event instances are returned. Note: This only affects event instances within series, not the series themselves. Default: true
ListEventSeriesResponseCursor
ListEventSeriesResponseCursor =
string|null
Cursor for the next page (null if no more pages)
ListEventSeriesResponseDataItem
ListEventSeriesResponseDataItem =
object
Properties
series_id
series_id:
string
The UUID of the event series. Every event (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
ListEventSeriesResponseDataItemEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
calendar_id
calendar_id:
string
The UUID of the calendar connection this event series belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
created_at
created_at:
string
ISO 8601 timestamp when this event series was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
events
List of event instances that belong to this series. For one-off events, this array contains a single instance. For recurring events, this array contains all instances that have been synced (typically within a 30-day window)
ListEventSeriesResponseDataItemEventType
ListEventSeriesResponseDataItemEventType = typeof
ListEventSeriesResponseDataItemEventType[keyof typeofListEventSeriesResponseDataItemEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
ListEventSeriesResponseDataItemEventsItem
ListEventSeriesResponseDataItemEventsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
title:
string
The title of the event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
meeting_url
meeting_url:
ListEventSeriesResponseDataItemEventsItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
ListEventSeriesResponseDataItemEventsItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListEventSeriesResponseDataItemEventsItemMeetingPlatform
ListEventSeriesResponseDataItemEventsItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
ListEventSeriesResponseDataItemEventsItemMeetingUrl
ListEventSeriesResponseDataItemEventsItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
ListEventSeriesResponseDataItemEventsItemStatus
ListEventSeriesResponseDataItemEventsItemStatus = typeof
ListEventSeriesResponseDataItemEventsItemStatus[keyof typeofListEventSeriesResponseDataItemEventsItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
ListEventSeriesResponseInputCursor
ListEventSeriesResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
ListEventSeriesResponseInputDataItem
ListEventSeriesResponseInputDataItem =
object
Properties
series_id
series_id:
string
The UUID of the event series. Every event (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
ListEventSeriesResponseInputDataItemEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
calendar_id
calendar_id:
string
The UUID of the calendar connection this event series belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
created_at
created_at:
string
ISO 8601 timestamp when this event series was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
events
List of event instances that belong to this series. For one-off events, this array contains a single instance. For recurring events, this array contains all instances that have been synced (typically within a 30-day window)
ListEventSeriesResponseInputDataItemEventType
ListEventSeriesResponseInputDataItemEventType = typeof
ListEventSeriesResponseInputDataItemEventType[keyof typeofListEventSeriesResponseInputDataItemEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
ListEventSeriesResponseInputDataItemEventsItem
ListEventSeriesResponseInputDataItemEventsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
title:
string
The title of the event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
status:
ListEventSeriesResponseInputDataItemEventsItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
meeting_url
meeting_url:
ListEventSeriesResponseInputDataItemEventsItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
ListEventSeriesResponseInputDataItemEventsItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListEventSeriesResponseInputDataItemEventsItemMeetingPlatform
ListEventSeriesResponseInputDataItemEventsItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
ListEventSeriesResponseInputDataItemEventsItemMeetingUrl
ListEventSeriesResponseInputDataItemEventsItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
ListEventSeriesResponseInputDataItemEventsItemStatus
ListEventSeriesResponseInputDataItemEventsItemStatus = typeof
ListEventSeriesResponseInputDataItemEventsItemStatus[keyof typeofListEventSeriesResponseInputDataItemEventsItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
ListEventSeriesResponseInputPrevCursor
ListEventSeriesResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListEventSeriesResponsePrevCursor
ListEventSeriesResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListEvents429
ListEvents429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListEvents429Message
Human-readable error message
details?
optionaldetails:ListEvents429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListEvents429Details
ListEvents429Details =
string|null
Additional error details (string or null)
ListEvents429Message
ListEvents429Message =
string|null
Human-readable error message
ListEventsParams
ListEventsParams =
object
Properties
limit?
optionallimit:number
Maximum number of events to return in a single request.
Limits the number of results returned in a single API call.
Default: 50 Minimum: 1 Maximum: 250
Minimum
1
Maximum
250
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing <isoDate>::\<id\>. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MjAyNS0wMS0xNVQxMDozMDowMFo6OjEyMzQ1" or "LU1qQXlOM1UxTmpVME5qVXhNakUwTkRrPQ==" (for backward pagination)
start_date?
optionalstart_date:string|null
Filter events starting on or after this date/time (ISO 8601 format).
end_date?
optionalend_date:string|null
Filter events ending on or before this date/time (ISO 8601 format).
status?
optionalstatus:ListEventsStatusAnyOf|null
Filter events by status(es). It can be used to find events that have any of the specified statuses. Valid values are one or more of: confirmed, cancelled, tentative.
Example: "confirmed,cancelled" would match all events that are confirmed or cancelled.
To filter multiple statuses, use a comma-separated list of values.
show_cancelled?
optionalshow_cancelled:boolean
Whether to include cancelled events in the results. When set to 'false', only non-cancelled events are returned. Default: true
ListEventsResponseCursor
ListEventsResponseCursor =
string|null
Cursor for the next page (null if no more pages)
ListEventsResponseDataItem
ListEventsResponseDataItem =
object
Properties
series_id
series_id:
string
The UUID of the event series this instance belongs to. Every event instance (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
ListEventsResponseDataItemEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
title:
string
The title of the event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
status:
ListEventsResponseDataItemStatus
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
meeting_url
meeting_url:
ListEventsResponseDataItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
ListEventsResponseDataItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListEventsResponseDataItemEventType
ListEventsResponseDataItemEventType = typeof
ListEventsResponseDataItemEventType[keyof typeofListEventsResponseDataItemEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
ListEventsResponseDataItemMeetingPlatform
ListEventsResponseDataItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
ListEventsResponseDataItemMeetingUrl
ListEventsResponseDataItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
ListEventsResponseDataItemStatus
ListEventsResponseDataItemStatus = typeof
ListEventsResponseDataItemStatus[keyof typeofListEventsResponseDataItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
ListEventsResponseInputCursor
ListEventsResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
ListEventsResponseInputDataItem
ListEventsResponseInputDataItem =
object
Properties
series_id
series_id:
string
The UUID of the event series this instance belongs to. Every event instance (both one-off and recurring) is associated with a series. Use this ID when scheduling bots for all occurrences of a recurring series
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
event_type
event_type:
ListEventsResponseInputDataItemEventType
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
event_id
event_id:
string
The UUID of the event instance
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
title
title:
string
The title of the event
start_time
start_time:
string
ISO 8601 timestamp when the event starts
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
end_time
end_time:
string
ISO 8601 timestamp when the event ends
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
is_exception
is_exception:
boolean
Whether this is an exception to a recurring series. True if this instance has been modified differently from the recurring pattern
meeting_url
meeting_url:
ListEventsResponseInputDataItemMeetingUrl
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
meeting_platform
meeting_platform:
ListEventsResponseInputDataItemMeetingPlatform
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
calendar_id
calendar_id:
string
The UUID of the calendar connection this event belongs to
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_scheduled
bot_scheduled:
boolean
Whether a bot has been scheduled for this event instance. True if a calendar bot schedule exists for this event
created_at
created_at:
string
ISO 8601 timestamp when this event instance was first synced into the system
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListEventsResponseInputDataItemEventType
ListEventsResponseInputDataItemEventType = typeof
ListEventsResponseInputDataItemEventType[keyof typeofListEventsResponseInputDataItemEventType]
The type of event. 'one_off' for single events that occur once, 'recurring' for events that are part of a recurring series with multiple occurrences
ListEventsResponseInputDataItemMeetingPlatform
ListEventsResponseInputDataItemMeetingPlatform =
"zoom"|"meet"|"teams"|null
The meeting platform detected from the meeting URL. Null if no meeting link was found in the event. Possible values: 'zoom', 'meet', or 'teams'
ListEventsResponseInputDataItemMeetingUrl
ListEventsResponseInputDataItemMeetingUrl =
string|null
The meeting URL extracted from the event. Null if the calendar platform did not include a meeting link in the event
ListEventsResponseInputDataItemStatus
ListEventsResponseInputDataItemStatus = typeof
ListEventsResponseInputDataItemStatus[keyof typeofListEventsResponseInputDataItemStatus]
The status of the event. Possible values: 'confirmed' (event is confirmed), 'cancelled' (event has been cancelled), 'tentative' (event is tentative)
ListEventsResponseInputPrevCursor
ListEventsResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListEventsResponsePrevCursor
ListEventsResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListEventsStatusAnyOf
ListEventsStatusAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListRawCalendars429
ListRawCalendars429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListRawCalendars429Message
Human-readable error message
details?
optionaldetails:ListRawCalendars429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListRawCalendars429Details
ListRawCalendars429Details =
string|null
Additional error details (string or null)
ListRawCalendars429Message
ListRawCalendars429Message =
string|null
Human-readable error message
ListRawCalendarsRequestBodyCalendarPlatform
ListRawCalendarsRequestBodyCalendarPlatform = typeof
ListRawCalendarsRequestBodyCalendarPlatform[keyof typeofListRawCalendarsRequestBodyCalendarPlatform]
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
ListRawCalendarsRequestBodyInputCalendarPlatform
ListRawCalendarsRequestBodyInputCalendarPlatform = typeof
ListRawCalendarsRequestBodyInputCalendarPlatform[keyof typeofListRawCalendarsRequestBodyInputCalendarPlatform]
The calendar platform to connect to. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365.
ListRawCalendarsResponseDataItem
ListRawCalendarsResponseDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
id
id:
string
The calendar ID from the calendar platform. Use this value as the 'raw_calendar_id' parameter when creating a calendar connection
name
name:
string
The display name of the calendar as shown in the calendar application
email:
string
The email address associated with the calendar. For Google Calendar, this is typically the calendar owner's email. For Microsoft, this is the calendar's email address
is_primary
is_primary:
boolean
Whether this is the user's primary/default calendar. The primary calendar is typically the main calendar associated with the user's account
ListRawCalendarsResponseInputDataItem
ListRawCalendarsResponseInputDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
id
id:
string
The calendar ID from the calendar platform. Use this value as the 'raw_calendar_id' parameter when creating a calendar connection
name
name:
string
The display name of the calendar as shown in the calendar application
email:
string
The email address associated with the calendar. For Google Calendar, this is typically the calendar owner's email. For Microsoft, this is the calendar's email address
is_primary
is_primary:
boolean
Whether this is the user's primary/default calendar. The primary calendar is typically the main calendar associated with the user's account
ListScheduledBots429
ListScheduledBots429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ListScheduledBots429Message
Human-readable error message
details?
optionaldetails:ListScheduledBots429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ListScheduledBots429Details
ListScheduledBots429Details =
string|null
Additional error details (string or null)
ListScheduledBots429Message
ListScheduledBots429Message =
string|null
Human-readable error message
ListScheduledBotsMeetingPlatformAnyOf
ListScheduledBotsMeetingPlatformAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ListScheduledBotsParams
ListScheduledBotsParams =
object
Properties
limit?
optionallimit:number
Maximum number of scheduled bots to return in a single request.
Limits the number of results returned in a single API call.
Default: 50 Minimum: 1 Maximum: 100
Maximum
100
cursor?
optionalcursor:string|null
The cursor to use for pagination.
Obtained from the cursor or prev_cursor field in the previous response.
The cursor is a base64-encoded string containing <isoDate>::\<id\>. To paginate backward, prefix the cursor with a - (minus sign).
Leave as null to get the first page of results.
Example: "MjAyNS0wMS0xNVQxMDozMDowMFo6OjEyMzQ1" or "LU1qQXlOM1UxTmpVME5qVXhNakUwTkRrPQ==" (for backward pagination)
bot_id?
optionalbot_id:string|null
Filter scheduled bots by UUID (partial match, case-insensitive).
Use this to find a scheduled bot when you only know part of the identifier.
scheduled_before?
optionalscheduled_before:string|null
Filter scheduled bots with join_at before this timestamp.
Returns only scheduled bots that are scheduled to join before the specified date.
ISO 8601 format. Must be within ±90 days from today.
Example: "2025-12-25T10:00:00Z"
scheduled_after?
optionalscheduled_after:string|null
Filter scheduled bots with join_at after this timestamp.
Returns only scheduled bots that are scheduled to join after the specified date.
ISO 8601 format. Must be within ±90 days from today.
Example: "2025-12-25T10:00:00Z"
status?
optionalstatus:ListScheduledBotsStatusAnyOf|null
Filter by scheduled bot status.
Returns only scheduled bots with the specified status(es).
Available statuses:
- scheduled: Bot is scheduled to join at a future time
- cancelled: Bot schedule was cancelled
- completed: Bot has completed its scheduled task
- failed: Bot failed to execute its scheduled task
To filter multiple statuses, use a comma-separated list of values. For example, "scheduled,completed" would match all bots that are scheduled or completed.
bot_name?
optionalbot_name:string|null
Filter bots by name containing this string.
Performs a case-insensitive partial match on the bot's name. Useful for finding bots with specific naming conventions or to locate a particular bot when you don't have its ID.
Example: "Sales" would match "Sales Meeting", "Quarterly Sales", etc.
meeting_url?
optionalmeeting_url:string|null
Filter bots by meeting URL containing this string.
Performs a case-insensitive partial match on the bot's meeting URL. Useful for finding bots associated with specific meeting platforms or particular meeting IDs.
Example: "zoom.us" would match all Zoom meetings
meeting_platform?
optionalmeeting_platform:ListScheduledBotsMeetingPlatformAnyOf|null
Filter by meeting platform.
This parameter filters scheduled bots by the platform they are associated with. It can be used to find bots that are associated with a specific meeting platform. Valid values are: "zoom", "meet", "teams".
Example: "zoom" would match all bots associated with Zoom meetings.
To filter multiple platforms, use a comma-separated list of values. For example, "zoom,meet" would match all bots associated with Zoom or Meet meetings.
ListScheduledBotsResponseCursor
ListScheduledBotsResponseCursor =
string|null
Cursor for the next page (null if no more pages)
ListScheduledBotsResponseDataItem
ListScheduledBotsResponseDataItem =
object
Properties
bot_id
bot_id:
string
The UUID of the scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the scheduled bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
ListScheduledBotsResponseDataItemMeetingPlatform
The platform of the meeting
join_at
join_at:
string
ISO 8601 timestamp when the bot should join the meeting
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The current status of the scheduled bot
created_at
created_at:
string
ISO 8601 timestamp when the scheduled bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the scheduled bot was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListScheduledBotsResponseDataItemMeetingPlatform
ListScheduledBotsResponseDataItemMeetingPlatform = typeof
ListScheduledBotsResponseDataItemMeetingPlatform[keyof typeofListScheduledBotsResponseDataItemMeetingPlatform]
The platform of the meeting
ListScheduledBotsResponseDataItemStatus
ListScheduledBotsResponseDataItemStatus = typeof
ListScheduledBotsResponseDataItemStatus[keyof typeofListScheduledBotsResponseDataItemStatus]
The current status of the scheduled bot
ListScheduledBotsResponseInputCursor
ListScheduledBotsResponseInputCursor =
string|null
Cursor for the next page (null if no more pages)
ListScheduledBotsResponseInputDataItem
ListScheduledBotsResponseInputDataItem =
object
Properties
bot_id
bot_id:
string
The UUID of the scheduled bot
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
bot_name
bot_name:
string
The name of the scheduled bot
meeting_url
meeting_url:
string
The URL of the meeting
meeting_platform
meeting_platform:
ListScheduledBotsResponseInputDataItemMeetingPlatform
The platform of the meeting
join_at
join_at:
string
ISO 8601 timestamp when the bot should join the meeting
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
status
The current status of the scheduled bot
created_at
created_at:
string
ISO 8601 timestamp when the scheduled bot was created
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
updated_at
updated_at:
string
ISO 8601 timestamp when the scheduled bot was last updated
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ListScheduledBotsResponseInputDataItemMeetingPlatform
ListScheduledBotsResponseInputDataItemMeetingPlatform = typeof
ListScheduledBotsResponseInputDataItemMeetingPlatform[keyof typeofListScheduledBotsResponseInputDataItemMeetingPlatform]
The platform of the meeting
ListScheduledBotsResponseInputDataItemStatus
ListScheduledBotsResponseInputDataItemStatus = typeof
ListScheduledBotsResponseInputDataItemStatus[keyof typeofListScheduledBotsResponseInputDataItemStatus]
The current status of the scheduled bot
ListScheduledBotsResponseInputPrevCursor
ListScheduledBotsResponseInputPrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListScheduledBotsResponsePrevCursor
ListScheduledBotsResponsePrevCursor =
string|null
Cursor for the previous page (null if on first page)
ListScheduledBotsStatusAnyOf
ListScheduledBotsStatusAnyOf =
string|null
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
ResendFinalWebhook429
ResendFinalWebhook429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ResendFinalWebhook429Message
Human-readable error message
details?
optionaldetails:ResendFinalWebhook429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ResendFinalWebhook429Details
ResendFinalWebhook429Details =
string|null
Additional error details (string or null)
ResendFinalWebhook429Message
ResendFinalWebhook429Message =
string|null
Human-readable error message
ResendFinalWebhookResponseData
ResendFinalWebhookResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
ResendFinalWebhookResponseInputData
ResendFinalWebhookResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
ResubscribeCalendar429
ResubscribeCalendar429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:ResubscribeCalendar429Message
Human-readable error message
details?
optionaldetails:ResubscribeCalendar429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
ResubscribeCalendar429Details
ResubscribeCalendar429Details =
string|null
Additional error details (string or null)
ResubscribeCalendar429Message
ResubscribeCalendar429Message =
string|null
Human-readable error message
ResubscribeCalendarResponseData
ResubscribeCalendarResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection that was resubscribed. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
resubscribed_at
resubscribed_at:
string
ISO 8601 timestamp when the calendar connection was resubscribed
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
ResubscribeCalendarResponseInputData
ResubscribeCalendarResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
calendar_id
calendar_id:
string
The UUID of the calendar connection that was resubscribed. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
resubscribed_at
resubscribed_at:
string
ISO 8601 timestamp when the calendar connection was resubscribed
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
RetryCallback429
RetryCallback429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:RetryCallback429Message
Human-readable error message
details?
optionaldetails:RetryCallback429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
RetryCallback429Details
RetryCallback429Details =
string|null
Additional error details (string or null)
RetryCallback429Message
RetryCallback429Message =
string|null
Human-readable error message
RetryCallbackRequestBody
RetryCallbackRequestBody =
RetryCallbackRequestBodyAnyOf|null
Optional callback configuration to override the bot's configured callback.
If provided, all fields must be included and these values will be used instead of the bot's original callback configuration. If omitted (null), the bot's original callback configuration will be used.
url: Custom callback URL (overrides configured URL)method: HTTP method (POSTorPUT, default:POST)secret: Custom HMAC secret (overrides configured secret, sent inx-mb-secretheader)
RetryCallbackRequestBodyAnyOf
RetryCallbackRequestBodyAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
RetryCallbackRequestBodyAnyOfMethod
RetryCallbackRequestBodyAnyOfMethod = typeof
RetryCallbackRequestBodyAnyOfMethod[keyof typeofRetryCallbackRequestBodyAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
RetryCallbackRequestBodyAnyOfSecret
RetryCallbackRequestBodyAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
RetryCallbackRequestBodyInput
RetryCallbackRequestBodyInput =
RetryCallbackRequestBodyInputAnyOf|null
Optional callback configuration to override the bot's configured callback.
If provided, all fields must be included and these values will be used instead of the bot's original callback configuration. If omitted (null), the bot's original callback configuration will be used.
url: Custom callback URL (overrides configured URL)method: HTTP method (POSTorPUT, default:POST)secret: Custom HMAC secret (overrides configured secret, sent inx-mb-secretheader)
RetryCallbackRequestBodyInputAnyOf
RetryCallbackRequestBodyInputAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret?
optionalsecret:RetryCallbackRequestBodyInputAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method?
optionalmethod:RetryCallbackRequestBodyInputAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
RetryCallbackRequestBodyInputAnyOfMethod
RetryCallbackRequestBodyInputAnyOfMethod = typeof
RetryCallbackRequestBodyInputAnyOfMethod[keyof typeofRetryCallbackRequestBodyInputAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
RetryCallbackRequestBodyInputAnyOfSecret
RetryCallbackRequestBodyInputAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
RetryCallbackResponseData
RetryCallbackResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
RetryCallbackResponseInputData
RetryCallbackResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
SyncCalendar429
SyncCalendar429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:SyncCalendar429Message
Human-readable error message
details?
optionaldetails:SyncCalendar429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
SyncCalendar429Details
SyncCalendar429Details =
string|null
Additional error details (string or null)
SyncCalendar429Message
SyncCalendar429Message =
string|null
Human-readable error message
SyncCalendarResponseData
SyncCalendarResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message confirming that the calendar sync operation has been initiated. The sync will fetch the latest events from the calendar platform and update the local database
SyncCalendarResponseInputData
SyncCalendarResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message confirming that the calendar sync operation has been initiated. The sync will fetch the latest events from the calendar platform and update the local database
UpdateCalendarBot429
UpdateCalendarBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:UpdateCalendarBot429Message
Human-readable error message
details?
optionaldetails:UpdateCalendarBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
UpdateCalendarBot429Details
UpdateCalendarBot429Details =
string|null
Additional error details (string or null)
UpdateCalendarBot429Message
UpdateCalendarBot429Message =
string|null
Human-readable error message
UpdateCalendarBotRequestBody
UpdateCalendarBotRequestBody =
UpdateCalendarBotRequestBodyAllOf&UpdateCalendarBotRequestBodyAllOfTwo
UpdateCalendarBotRequestBodyAllOf
UpdateCalendarBotRequestBodyAllOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
series_id
series_id:
string
The UUID of the event series to schedule bots for.
Both one-off and recurring events have a series_id. For recurring events, use 'all_occurrences' to schedule bots for all future occurrences.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
all_occurrences
all_occurrences:
boolean
Whether to schedule bots for all occurrences of the event series.
If true, bots will be scheduled for all future event instances in the series. If false, event_id must be provided to schedule a bot for a specific event instance.
Default: false
event_id?
optionalevent_id:string
The UUID of a specific event instance to schedule a bot for.
Required when all_occurrences is false. Use this to schedule a bot for a single occurrence of a recurring event or a specific one-off event. If all_occurrences is true, this parameter is ignored.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
UpdateCalendarBotRequestBodyAllOfTwo
UpdateCalendarBotRequestBodyAllOfTwo =
object
Partial update of bot configuration. Only provide the fields you want to update. All fields are optional.
Properties
bot_name?
optionalbot_name:string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:UpdateCalendarBotRequestBodyAllOfTwoBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
recording_mode?
optionalrecording_mode:UpdateCalendarBotRequestBodyAllOfTwoRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:UpdateCalendarBotRequestBodyAllOfTwoEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:UpdateCalendarBotRequestBodyAllOfTwoTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:UpdateCalendarBotRequestBodyAllOfTwoZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:UpdateCalendarBotRequestBodyAllOfTwoExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable or disable audio streaming for this bot.
- Set to
trueto enable streaming (requiresstreaming_config) - Set to
falseto disable streaming (do not providestreaming_config) - Omit this field to leave streaming configuration unchanged
If you want to change streaming settings, you must provide both streaming_enabled and streaming_config together.
streaming_config?
optionalstreaming_config:UpdateCalendarBotRequestBodyAllOfTwoStreamingConfig
The streaming configuration for the bot.
Required when streaming_enabled is true. Must not be provided when streaming_enabled is false.
input_url: Websocket stream URL that receives audio sent to the botoutput_url: Websocket stream URL where the bot sends audioaudio_frequency: Audio frequency in Hz (default: 24000)
Omit this field to leave streaming configuration unchanged.
transcription_enabled?
optionaltranscription_enabled:boolean
Enable or disable transcription for this bot.
- Set to
trueto enable transcription (requirestranscription_config) - Set to
falseto disable transcription (do not providetranscription_config) - Omit this field to leave transcription configuration unchanged
If you want to change transcription settings, you must provide both transcription_enabled and transcription_config together.
transcription_config?
optionaltranscription_config:UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfig
The transcription configuration for the bot.
Required when transcription_enabled is true. Must not be provided when transcription_enabled is false.
provider: Speech-to-text provider (default: "gladia")api_key: Your own API key for the provider (BYOK - available on Pro plans and above)custom_params: Custom parameters for transcription (see Gladia API documentation)
Omit this field to leave transcription configuration unchanged.
callback_enabled?
optionalcallback_enabled:boolean
Enable or disable callback for this bot.
- Set to
trueto enable callback (requirescallback_config) - Set to
falseto disable callback (do not providecallback_config) - Omit this field to leave callback configuration unchanged
If you want to change callback settings, you must provide both callback_enabled and callback_config together.
callback_config?
optionalcallback_config:UpdateCalendarBotRequestBodyAllOfTwoCallbackConfig
The callback configuration for the bot.
Required when callback_enabled is true. Must not be provided when callback_enabled is false.
url: The URL to be called upon completion or failure of the botsecret: Secret for HMAC validation (sent inx-mb-secretheader)method: HTTP method (POSTorPUT, default:POST)
Omit this field to leave callback configuration unchanged.
UpdateCalendarBotRequestBodyAllOfTwoBotImage
UpdateCalendarBotRequestBodyAllOfTwoBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfig
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfig =
object
The callback configuration for the bot.
Required when callback_enabled is true. Must not be provided when callback_enabled is false.
url: The URL to be called upon completion or failure of the botsecret: Secret for HMAC validation (sent inx-mb-secretheader)method: HTTP method (POSTorPUT, default:POST)
Omit this field to leave callback configuration unchanged.
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret
secret:
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method
method:
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod = typeof
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod[keyof typeofUpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigSecret
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
UpdateCalendarBotRequestBodyAllOfTwoEntryMessage
UpdateCalendarBotRequestBodyAllOfTwoEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
UpdateCalendarBotRequestBodyAllOfTwoExtra
UpdateCalendarBotRequestBodyAllOfTwoExtra =
UpdateCalendarBotRequestBodyAllOfTwoExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
UpdateCalendarBotRequestBodyAllOfTwoExtraAnyOf
UpdateCalendarBotRequestBodyAllOfTwoExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateCalendarBotRequestBodyAllOfTwoRecordingMode
UpdateCalendarBotRequestBodyAllOfTwoRecordingMode = typeof
UpdateCalendarBotRequestBodyAllOfTwoRecordingMode[keyof typeofUpdateCalendarBotRequestBodyAllOfTwoRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfig
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfig =
object
The streaming configuration for the bot.
Required when streaming_enabled is true. Must not be provided when streaming_enabled is false.
input_url: Websocket stream URL that receives audio sent to the botoutput_url: Websocket stream URL where the bot sends audioaudio_frequency: Audio frequency in Hz (default: 24000)
Omit this field to leave streaming configuration unchanged.
Properties
input_url
input_url:
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url
output_url:
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency
audio_frequency:
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigAudioFrequency
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigInputUrl
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigOutputUrl
UpdateCalendarBotRequestBodyAllOfTwoStreamingConfigOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
UpdateCalendarBotRequestBodyAllOfTwoTimeoutConfig
UpdateCalendarBotRequestBodyAllOfTwoTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout
waiting_room_timeout:
number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout
no_one_joined_timeout:
number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout
silence_timeout:
number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfig
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfig =
object
The transcription configuration for the bot.
Required when transcription_enabled is true. Must not be provided when transcription_enabled is false.
provider: Speech-to-text provider (default: "gladia")api_key: Your own API key for the provider (BYOK - available on Pro plans and above)custom_params: Custom parameters for transcription (see Gladia API documentation)
Omit this field to leave transcription configuration unchanged.
Properties
provider
provider:
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key
api_key:
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params
custom_params:
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigApiKey
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParams
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParams =
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParamsAnyOf
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider = typeof
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider[keyof typeofUpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
UpdateCalendarBotRequestBodyAllOfTwoZoomAccessTokenUrl
UpdateCalendarBotRequestBodyAllOfTwoZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
UpdateCalendarBotRequestBodyInput
UpdateCalendarBotRequestBodyInput =
UpdateCalendarBotRequestBodyInputAllOf&UpdateCalendarBotRequestBodyInputAllOfTwo
UpdateCalendarBotRequestBodyInputAllOf
UpdateCalendarBotRequestBodyInputAllOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
series_id
series_id:
string
The UUID of the event series to schedule bots for.
Both one-off and recurring events have a series_id. For recurring events, use 'all_occurrences' to schedule bots for all future occurrences.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
all_occurrences
all_occurrences:
boolean
Whether to schedule bots for all occurrences of the event series.
If true, bots will be scheduled for all future event instances in the series. If false, event_id must be provided to schedule a bot for a specific event instance.
Default: false
event_id?
optionalevent_id:string
The UUID of a specific event instance to schedule a bot for.
Required when all_occurrences is false. Use this to schedule a bot for a single occurrence of a recurring event or a specific one-off event. If all_occurrences is true, this parameter is ignored.
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
UpdateCalendarBotRequestBodyInputAllOfTwo
UpdateCalendarBotRequestBodyInputAllOfTwo =
object
Partial update of bot configuration. Only provide the fields you want to update. All fields are optional.
Properties
bot_name?
optionalbot_name:string
The name of the bot.
This name will be displayed as the bot's name in the meeting.
Min Length
1
Max Length
255
bot_image?
optionalbot_image:UpdateCalendarBotRequestBodyInputAllOfTwoBotImage
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
recording_mode?
optionalrecording_mode:UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
entry_message?
optionalentry_message:UpdateCalendarBotRequestBodyInputAllOfTwoEntryMessage
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
timeout_config?
optionaltimeout_config:UpdateCalendarBotRequestBodyInputAllOfTwoTimeoutConfig
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
zoom_access_token_url?
optionalzoom_access_token_url:UpdateCalendarBotRequestBodyInputAllOfTwoZoomAccessTokenUrl
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
extra?
optionalextra:UpdateCalendarBotRequestBodyInputAllOfTwoExtra
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
streaming_enabled?
optionalstreaming_enabled:boolean
Enable or disable audio streaming for this bot.
- Set to
trueto enable streaming (requiresstreaming_config) - Set to
falseto disable streaming (do not providestreaming_config) - Omit this field to leave streaming configuration unchanged
If you want to change streaming settings, you must provide both streaming_enabled and streaming_config together.
streaming_config?
optionalstreaming_config:UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfig
The streaming configuration for the bot.
Required when streaming_enabled is true. Must not be provided when streaming_enabled is false.
input_url: Websocket stream URL that receives audio sent to the botoutput_url: Websocket stream URL where the bot sends audioaudio_frequency: Audio frequency in Hz (default: 24000)
Omit this field to leave streaming configuration unchanged.
transcription_enabled?
optionaltranscription_enabled:boolean
Enable or disable transcription for this bot.
- Set to
trueto enable transcription (requirestranscription_config) - Set to
falseto disable transcription (do not providetranscription_config) - Omit this field to leave transcription configuration unchanged
If you want to change transcription settings, you must provide both transcription_enabled and transcription_config together.
transcription_config?
optionaltranscription_config:UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfig
The transcription configuration for the bot.
Required when transcription_enabled is true. Must not be provided when transcription_enabled is false.
provider: Speech-to-text provider (default: "gladia")api_key: Your own API key for the provider (BYOK - available on Pro plans and above)custom_params: Custom parameters for transcription (see Gladia API documentation)
Omit this field to leave transcription configuration unchanged.
callback_enabled?
optionalcallback_enabled:boolean
Enable or disable callback for this bot.
- Set to
trueto enable callback (requirescallback_config) - Set to
falseto disable callback (do not providecallback_config) - Omit this field to leave callback configuration unchanged
If you want to change callback settings, you must provide both callback_enabled and callback_config together.
callback_config?
optionalcallback_config:UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfig
The callback configuration for the bot.
Required when callback_enabled is true. Must not be provided when callback_enabled is false.
url: The URL to be called upon completion or failure of the botsecret: Secret for HMAC validation (sent inx-mb-secretheader)method: HTTP method (POSTorPUT, default:POST)
Omit this field to leave callback configuration unchanged.
UpdateCalendarBotRequestBodyInputAllOfTwoBotImage
UpdateCalendarBotRequestBodyInputAllOfTwoBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfig
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfig =
object
The callback configuration for the bot.
Required when callback_enabled is true. Must not be provided when callback_enabled is false.
url: The URL to be called upon completion or failure of the botsecret: Secret for HMAC validation (sent inx-mb-secretheader)method: HTTP method (POSTorPUT, default:POST)
Omit this field to leave callback configuration unchanged.
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret?
optionalsecret:UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method?
optionalmethod:UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod = typeof
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod[keyof typeofUpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigSecret
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
UpdateCalendarBotRequestBodyInputAllOfTwoEntryMessage
UpdateCalendarBotRequestBodyInputAllOfTwoEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
UpdateCalendarBotRequestBodyInputAllOfTwoExtra
UpdateCalendarBotRequestBodyInputAllOfTwoExtra =
UpdateCalendarBotRequestBodyInputAllOfTwoExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
UpdateCalendarBotRequestBodyInputAllOfTwoExtraAnyOf
UpdateCalendarBotRequestBodyInputAllOfTwoExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode
UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode = typeof
UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode[keyof typeofUpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfig
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfig =
object
The streaming configuration for the bot.
Required when streaming_enabled is true. Must not be provided when streaming_enabled is false.
input_url: Websocket stream URL that receives audio sent to the botoutput_url: Websocket stream URL where the bot sends audioaudio_frequency: Audio frequency in Hz (default: 24000)
Omit this field to leave streaming configuration unchanged.
Properties
input_url?
optionalinput_url:UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url?
optionaloutput_url:UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency?
optionalaudio_frequency:UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigAudioFrequency
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigInputUrl
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigOutputUrl
UpdateCalendarBotRequestBodyInputAllOfTwoStreamingConfigOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
UpdateCalendarBotRequestBodyInputAllOfTwoTimeoutConfig
UpdateCalendarBotRequestBodyInputAllOfTwoTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout?
optionalwaiting_room_timeout:number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout?
optionalno_one_joined_timeout:number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout?
optionalsilence_timeout:number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfig
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfig =
object
The transcription configuration for the bot.
Required when transcription_enabled is true. Must not be provided when transcription_enabled is false.
provider: Speech-to-text provider (default: "gladia")api_key: Your own API key for the provider (BYOK - available on Pro plans and above)custom_params: Custom parameters for transcription (see Gladia API documentation)
Omit this field to leave transcription configuration unchanged.
Properties
provider?
optionalprovider:UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key?
optionalapi_key:UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params?
optionalcustom_params:UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigApiKey
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParams
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParams =
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParamsAnyOf
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider = typeof
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider[keyof typeofUpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
UpdateCalendarBotRequestBodyInputAllOfTwoZoomAccessTokenUrl
UpdateCalendarBotRequestBodyInputAllOfTwoZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
UpdateCalendarBotResponseDataItem
UpdateCalendarBotResponseDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
UpdateCalendarBotResponseErrorsItem
UpdateCalendarBotResponseErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
UpdateCalendarBotResponseErrorsItemDetails
UpdateCalendarBotResponseErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
UpdateCalendarBotResponseInputDataItem
UpdateCalendarBotResponseInputDataItem =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
event_id
event_id:
string
The UUID of the event instance that was successfully scheduled for bot recording
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
UpdateCalendarBotResponseInputErrorsItem
UpdateCalendarBotResponseInputErrorsItem =
object
Properties
event_id
event_id:
string
The UUID of the event instance that failed to be scheduled. Use this to identify which specific event could not be scheduled
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
code:
string
Error code for programmatic handling. This is a machine-readable identifier that indicates the type of error that occurred
message
message:
string
Human-readable error message explaining why the scheduling failed for this event instance
details
Additional error details providing more context about the failure. Null if no additional details are available
UpdateCalendarBotResponseInputErrorsItemDetails
UpdateCalendarBotResponseInputErrorsItemDetails =
string|null
Additional error details providing more context about the failure. Null if no additional details are available
UpdateCalendarConnection429
UpdateCalendarConnection429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:UpdateCalendarConnection429Message
Human-readable error message
details?
optionaldetails:UpdateCalendarConnection429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
UpdateCalendarConnection429Details
UpdateCalendarConnection429Details =
string|null
Additional error details (string or null)
UpdateCalendarConnection429Message
UpdateCalendarConnection429Message =
string|null
Human-readable error message
UpdateCalendarConnectionResponseData
UpdateCalendarConnectionResponseData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the updated calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
UpdateCalendarConnectionResponseDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was last updated with the new credentials or settings
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
UpdateCalendarConnectionResponseDataCalendarPlatform
UpdateCalendarConnectionResponseDataCalendarPlatform = typeof
UpdateCalendarConnectionResponseDataCalendarPlatform[keyof typeofUpdateCalendarConnectionResponseDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
UpdateCalendarConnectionResponseDataStatus
UpdateCalendarConnectionResponseDataStatus = typeof
UpdateCalendarConnectionResponseDataStatus[keyof typeofUpdateCalendarConnectionResponseDataStatus]
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
UpdateCalendarConnectionResponseInputData
UpdateCalendarConnectionResponseInputData =
object
Properties
calendar_id
calendar_id:
string
The UUID of the updated calendar connection. Use this ID to reference the calendar in other API endpoints
Pattern
^([0-9a-fA-F]8-[0-9a-fA-F]4-[1-8][0-9a-fA-F]3-[89abAB][0-9a-fA-F]3-[0-9a-fA-F]12|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
calendar_platform
calendar_platform:
UpdateCalendarConnectionResponseInputDataCalendarPlatform
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
account_email
account_email:
string
The email address associated with the calendar account. This is the email of the calendar owner
status
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
updated_at
updated_at:
string
ISO 8601 timestamp when the calendar connection was last updated with the new credentials or settings
Pattern
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d4-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:.\d+)?)?(?:Z))$
UpdateCalendarConnectionResponseInputDataCalendarPlatform
UpdateCalendarConnectionResponseInputDataCalendarPlatform = typeof
UpdateCalendarConnectionResponseInputDataCalendarPlatform[keyof typeofUpdateCalendarConnectionResponseInputDataCalendarPlatform]
The calendar platform. Either 'google' for Google Calendar or 'microsoft' for Microsoft Outlook/365
UpdateCalendarConnectionResponseInputDataStatus
UpdateCalendarConnectionResponseInputDataStatus = typeof
UpdateCalendarConnectionResponseInputDataStatus[keyof typeofUpdateCalendarConnectionResponseInputDataStatus]
The current status of the calendar connection after the update. Possible values: 'active' (connection is working), 'error' (connection has errors), 'revoked' (OAuth access was revoked), 'permission_denied' (insufficient permissions)
UpdateScheduledBot429
UpdateScheduledBot429 =
object
Rate Limited - Exceeded rate limit
Properties
success
success:
boolean
error
error:
string
Human-readable error message
code
code:
string
Error code for programmatic handling
statusCode
statusCode:
number
HTTP status code
Maximum
9007199254740991
message?
optionalmessage:UpdateScheduledBot429Message
Human-readable error message
details?
optionaldetails:UpdateScheduledBot429Details
Additional error details (string or null)
retryAfter?
optionalretryAfter:number
Number of seconds to wait before retrying
Maximum
9007199254740991
UpdateScheduledBot429Details
UpdateScheduledBot429Details =
string|null
Additional error details (string or null)
UpdateScheduledBot429Message
UpdateScheduledBot429Message =
string|null
Human-readable error message
UpdateScheduledBotRequestBodyBotImage
UpdateScheduledBotRequestBodyBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
UpdateScheduledBotRequestBodyCallbackConfig
UpdateScheduledBotRequestBodyCallbackConfig =
UpdateScheduledBotRequestBodyCallbackConfigAnyOf|null
UpdateScheduledBotRequestBodyCallbackConfigAnyOf
UpdateScheduledBotRequestBodyCallbackConfigAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret
secret:
UpdateScheduledBotRequestBodyCallbackConfigAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method
method:
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod = typeof
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod[keyof typeofUpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateScheduledBotRequestBodyCallbackConfigAnyOfSecret
UpdateScheduledBotRequestBodyCallbackConfigAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
UpdateScheduledBotRequestBodyEntryMessage
UpdateScheduledBotRequestBodyEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
UpdateScheduledBotRequestBodyExtra
UpdateScheduledBotRequestBodyExtra =
UpdateScheduledBotRequestBodyExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
UpdateScheduledBotRequestBodyExtraAnyOf
UpdateScheduledBotRequestBodyExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateScheduledBotRequestBodyInputBotImage
UpdateScheduledBotRequestBodyInputBotImage =
string|null
The image URL of the bot's avatar.
Must be a valid HTTPS URL pointing to a JPEG or PNG image. This image will be displayed as the bot's avatar in the meeting.
The recommended aspect ratio is 16:9 for best display across different platforms.
UpdateScheduledBotRequestBodyInputCallbackConfig
UpdateScheduledBotRequestBodyInputCallbackConfig =
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOf|null
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOf
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOf =
object
Properties
url
url:
string
The URL to be called upon the completion or failure of the bot.
secret?
optionalsecret:UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfSecret
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
method?
optionalmethod:UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod = typeof
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod[keyof typeofUpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod]
The HTTP method to use for the callback. Allowed values are 'POST' or 'PUT'.
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfSecret
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfSecret =
string|null
To ensure that you can validate the callback, this secret will be added to the request in the 'x-mb-secret' header
UpdateScheduledBotRequestBodyInputEntryMessage
UpdateScheduledBotRequestBodyInputEntryMessage =
string|null
The message that the bot will send when it joins the meeting.
This message will be posted in the meeting chat when the bot successfully joins.
Available for Google Meet and Zoom meetings. Microsoft Teams does not support entry messages for guests outside of an organization.
Maximum: 500 characters
UpdateScheduledBotRequestBodyInputExtra
UpdateScheduledBotRequestBodyInputExtra =
UpdateScheduledBotRequestBodyInputExtraAnyOf|null
An optional extra configuration object for the bot.
This object can contain any custom key-value pairs that you want to associate with the bot. The data will be:
- Included in all webhook event payloads (if a webhook endpoint is configured)
- Part of the callback payload (if callback is enabled)
- Returned when fetching the bot's details via the API
Useful for storing custom metadata, tracking information, or any other data you need to correlate with the bot.
UpdateScheduledBotRequestBodyInputExtraAnyOf
UpdateScheduledBotRequestBodyInputExtraAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateScheduledBotRequestBodyInputRecordingMode
UpdateScheduledBotRequestBodyInputRecordingMode = typeof
UpdateScheduledBotRequestBodyInputRecordingMode[keyof typeofUpdateScheduledBotRequestBodyInputRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
UpdateScheduledBotRequestBodyInputStreamingConfig
UpdateScheduledBotRequestBodyInputStreamingConfig =
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOf|null
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOf
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOf =
object
Properties
input_url?
optionalinput_url:UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url?
optionaloutput_url:UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency?
optionalaudio_frequency:UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfAudioFrequency
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfInputUrl
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfOutputUrl
UpdateScheduledBotRequestBodyInputStreamingConfigAnyOfOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
UpdateScheduledBotRequestBodyInputTimeoutConfig
UpdateScheduledBotRequestBodyInputTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout?
optionalwaiting_room_timeout:number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout?
optionalno_one_joined_timeout:number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout?
optionalsilence_timeout:number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
UpdateScheduledBotRequestBodyInputTranscriptionConfig
UpdateScheduledBotRequestBodyInputTranscriptionConfig =
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOf|null
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOf
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOf =
object
Properties
provider?
optionalprovider:UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key?
optionalapi_key:UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params?
optionalcustom_params:UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfApiKey
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParams
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParams =
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider = typeof
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider[keyof typeofUpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
UpdateScheduledBotRequestBodyInputZoomAccessTokenUrl
UpdateScheduledBotRequestBodyInputZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
UpdateScheduledBotRequestBodyRecordingMode
UpdateScheduledBotRequestBodyRecordingMode = typeof
UpdateScheduledBotRequestBodyRecordingMode[keyof typeofUpdateScheduledBotRequestBodyRecordingMode]
The recording mode of the bot.
Determines what the bot records during the meeting:
speaker_view: Records the speaker's view (default). Shows the active speaker or presenter.audio_only: Records only the audio without video.gallery_view: Records the entire gallery view (coming soon).
Default: speaker_view
UpdateScheduledBotRequestBodyStreamingConfig
UpdateScheduledBotRequestBodyStreamingConfig =
UpdateScheduledBotRequestBodyStreamingConfigAnyOf|null
UpdateScheduledBotRequestBodyStreamingConfigAnyOf
UpdateScheduledBotRequestBodyStreamingConfigAnyOf =
object
Properties
input_url
input_url:
UpdateScheduledBotRequestBodyStreamingConfigAnyOfInputUrl
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
output_url
output_url:
UpdateScheduledBotRequestBodyStreamingConfigAnyOfOutputUrl
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
audio_frequency
audio_frequency:
UpdateScheduledBotRequestBodyStreamingConfigAnyOfAudioFrequency
The audio frequency in Hz. The default is 24000 Hz.
UpdateScheduledBotRequestBodyStreamingConfigAnyOfAudioFrequency
UpdateScheduledBotRequestBodyStreamingConfigAnyOfAudioFrequency =
number|null
The audio frequency in Hz. The default is 24000 Hz.
UpdateScheduledBotRequestBodyStreamingConfigAnyOfInputUrl
UpdateScheduledBotRequestBodyStreamingConfigAnyOfInputUrl =
string|null
Websocket stream URL, which receives the audio sent to the bot, and the bot will stream the audio to the meeting.
UpdateScheduledBotRequestBodyStreamingConfigAnyOfOutputUrl
UpdateScheduledBotRequestBodyStreamingConfigAnyOfOutputUrl =
string|null
Websocket stream URL, which the bot sends the audio to. This is used to stream the output audio to a destination.
UpdateScheduledBotRequestBodyTimeoutConfig
UpdateScheduledBotRequestBodyTimeoutConfig =
object
Configuration for automatic meeting exit behavior. For Google Meet and Microsoft Teams, the bot uses waiting_room_timeout to wait in the waiting room, then no_one_joined_timeout to wait for participants when first joining the meeting, and finally switches to silence_timeout monitoring once participants are detected. Zoom only uses waiting_room_timeout.
Properties
waiting_room_timeout
waiting_room_timeout:
number
The timeout in seconds for the bot to wait in the waiting room before leaving the meeting.
If the bot is placed in a waiting room and not admitted within this time, it will leave the meeting.
Note: Google Meet has its own waiting room timeout (approximately 10 minutes). Setting a higher value for Google Meet meetings will have no effect, as Google Meet will deny entry to the bot after its own timeout.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
no_one_joined_timeout
no_one_joined_timeout:
number
The timeout in seconds for the bot to wait for participants to join before leaving the meeting.
If no participants join the meeting within this time after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 2 minutes Maximum: 30 minutes
Minimum
120
Maximum
1800
silence_timeout
silence_timeout:
number
The timeout in seconds for the bot to wait for silence before leaving the meeting.
If no audio is detected for this duration after the bot joins, the bot will leave the meeting. Only applicable for Google Meet and Microsoft Teams meetings.
Default: 600 seconds (10 minutes) Minimum: 5 minutes Maximum: 30 minutes
Minimum
300
Maximum
1800
UpdateScheduledBotRequestBodyTranscriptionConfig
UpdateScheduledBotRequestBodyTranscriptionConfig =
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOf|null
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOf
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOf =
object
Properties
provider
provider:
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
api_key
api_key:
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfApiKey
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
custom_params
custom_params:
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParams
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfApiKey
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfApiKey =
string|null
The API key to use for the speech to text provider. This can be provided to use your own API key for the speech to text provider. It consumes less tokens than using the default API key. It is available on 'Pro' plans and above.
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParams
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParams =
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParamsAnyOf|null
Custom parameters for the transcription provider. See the transcription provider's documentation for available options. For Gladia, see https://docs.gladia.io/api-reference/v2/pre-recorded/init
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParamsAnyOf
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfCustomParamsAnyOf =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Index Signature
[key: string]: unknown
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider = typeof
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider[keyof typeofUpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider]
The speech to text provider to use for the bot. The default and only supported provider is 'gladia'. More providers will be supported in the future.
UpdateScheduledBotRequestBodyZoomAccessTokenUrl
UpdateScheduledBotRequestBodyZoomAccessTokenUrl =
string|null
The URL to get the Zoom access token (ZAK - Zoom Access Token).
This is required for Zoom meetings where the bot needs to join in the absence of the host. The bot will make a GET request to this URL to retrieve the access token. Follow the guide in Zoom to understand how to get Zoom Access Token at https://developers.zoom.us/docs/api/users/#tag/users/get/users/me/zak.
Expected Response Format:*
- HTTP Method: GET
- Response Status: 2xx (success)
- Response Body: Plain text (ASCII) containing the Zoom access token directly
- Content-Type:
text/plain(or any text-based content type) - Timeout: The request will timeout after 15 seconds
Important Requirements:*
- The response body must be plain ASCII text (not JSON, not binary)
- The token must be a valid C string (no null bytes in the middle)
- The token should be the raw access token string, not wrapped in JSON or any other format
- Example response body:
"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpZCI6MX0..."
Error Handling:*
- If the request fails, times out, or returns non-ASCII data, the bot will fail to join the meeting
- Ensure your endpoint is reliable and returns a valid token within the timeout window
Only applicable for Zoom meetings. Leave as null for Google Meet and Microsoft Teams meetings.
Example: "https://your-api.com/zoom-token"
UpdateScheduledBotResponseData
UpdateScheduledBotResponseData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
UpdateScheduledBotResponseInputData
UpdateScheduledBotResponseInputData =
object
Generated by orval v7.17.0 🍺 Do not edit manually. Meeting BaaS API API for managing meeting bots, calendar integrations, and webhooks OpenAPI spec version: 2.0.0
Properties
message
message:
string
Success message
ValidationErrorResponseInputMessage
ValidationErrorResponseInputMessage =
string|null
Human-readable error message
ValidationErrorResponseMessage
ValidationErrorResponseMessage =
string|null
Human-readable error message
Variables
CalendarWebhookConnectionCreatedDataCalendarPlatform
CalendarWebhookConnectionCreatedDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionCreatedDataStatus
CalendarWebhookConnectionCreatedDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
CalendarWebhookConnectionCreatedInputDataCalendarPlatform
CalendarWebhookConnectionCreatedInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionCreatedInputDataStatus
CalendarWebhookConnectionCreatedInputDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
CalendarWebhookConnectionDeletedDataCalendarPlatform
CalendarWebhookConnectionDeletedDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionDeletedInputDataCalendarPlatform
CalendarWebhookConnectionDeletedInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionUpdatedDataCalendarPlatform
CalendarWebhookConnectionUpdatedDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionUpdatedDataStatus
CalendarWebhookConnectionUpdatedDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform
CalendarWebhookConnectionUpdatedInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CalendarWebhookConnectionUpdatedInputDataStatus
CalendarWebhookConnectionUpdatedInputDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus
CalendarWebhookEventCancelledDataCancelledInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventCancelledDataEventType
CalendarWebhookEventCancelledDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus
CalendarWebhookEventCancelledInputDataCancelledInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventCancelledInputDataEventType
CalendarWebhookEventCancelledInputDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventCreatedDataEventType
CalendarWebhookEventCreatedDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventCreatedDataInstancesItemStatus
CalendarWebhookEventCreatedDataInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventCreatedInputDataEventType
CalendarWebhookEventCreatedInputDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventCreatedInputDataInstancesItemStatus
CalendarWebhookEventCreatedInputDataInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus
CalendarWebhookEventUpdatedDataAffectedInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventUpdatedDataEventType
CalendarWebhookEventUpdatedDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus
CalendarWebhookEventUpdatedInputDataAffectedInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventUpdatedInputDataEventType
CalendarWebhookEventUpdatedInputDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventsSyncedDataEventsItemEventType
CalendarWebhookEventsSyncedDataEventsItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus
CalendarWebhookEventsSyncedDataEventsItemInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CalendarWebhookEventsSyncedInputDataEventsItemEventType
CalendarWebhookEventsSyncedInputDataEventsItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus
CalendarWebhookEventsSyncedInputDataEventsItemInstancesItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
CreateBotRequestBodyInputCallbackConfigAnyOfMethod
CreateBotRequestBodyInputCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
CreateBotRequestBodyInputRecordingMode
CreateBotRequestBodyInputRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider
CreateBotRequestBodyInputTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod
CreateCalendarBotRequestBodyAllOfCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
CreateCalendarBotRequestBodyAllOfRecordingMode
CreateCalendarBotRequestBodyAllOfRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider
CreateCalendarBotRequestBodyAllOfTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod
CreateCalendarBotRequestBodyInputAllOfCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
CreateCalendarBotRequestBodyInputAllOfRecordingMode
CreateCalendarBotRequestBodyInputAllOfRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider
CreateCalendarBotRequestBodyInputAllOfTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
CreateCalendarConnectionRequestBodyCalendarPlatform
CreateCalendarConnectionRequestBodyCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CreateCalendarConnectionRequestBodyInputCalendarPlatform
CreateCalendarConnectionRequestBodyInputCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CreateCalendarConnectionResponseDataCalendarPlatform
CreateCalendarConnectionResponseDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CreateCalendarConnectionResponseDataStatus
CreateCalendarConnectionResponseDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
CreateCalendarConnectionResponseInputDataCalendarPlatform
CreateCalendarConnectionResponseInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
CreateCalendarConnectionResponseInputDataStatus
CreateCalendarConnectionResponseInputDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
GetBotDetailsResponseDataMeetingPlatform
GetBotDetailsResponseDataMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
GetBotDetailsResponseDataRecordingMode
GetBotDetailsResponseDataRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
GetBotDetailsResponseDataStatus
GetBotDetailsResponseDataStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
GetBotDetailsResponseInputDataMeetingPlatform
GetBotDetailsResponseInputDataMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
GetBotDetailsResponseInputDataRecordingMode
GetBotDetailsResponseInputDataRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
GetBotDetailsResponseInputDataStatus
GetBotDetailsResponseInputDataStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
GetBotStatusResponseDataStatus
GetBotStatusResponseDataStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
GetBotStatusResponseDataTranscriptionStatus
GetBotStatusResponseDataTranscriptionStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
processing
readonlyprocessing:"processing"='processing'
done
readonlydone:"done"='done'
error
readonlyerror:"error"='error'
not-applicable
readonlynot-applicable:"not-applicable"='not-applicable'
not-started
readonlynot-started:"not-started"='not-started'
GetBotStatusResponseInputDataStatus
GetBotStatusResponseInputDataStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
GetBotStatusResponseInputDataTranscriptionStatus
GetBotStatusResponseInputDataTranscriptionStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
processing
readonlyprocessing:"processing"='processing'
done
readonlydone:"done"='done'
error
readonlyerror:"error"='error'
not-applicable
readonlynot-applicable:"not-applicable"='not-applicable'
not-started
readonlynot-started:"not-started"='not-started'
GetCalendarDetailsResponseDataCalendarPlatform
GetCalendarDetailsResponseDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
GetCalendarDetailsResponseDataStatus
GetCalendarDetailsResponseDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
GetCalendarDetailsResponseInputDataCalendarPlatform
GetCalendarDetailsResponseInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
GetCalendarDetailsResponseInputDataStatus
GetCalendarDetailsResponseInputDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus
GetEventDetailsResponseDataAttendeesAnyOfItemResponseStatus:
object
Type Declaration
accepted
readonlyaccepted:"accepted"='accepted'
declined
readonlydeclined:"declined"='declined'
tentative
readonlytentative:"tentative"='tentative'
needsAction
readonlyneedsAction:"needsAction"='needsAction'
GetEventDetailsResponseDataCalendarPlatform
GetEventDetailsResponseDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
GetEventDetailsResponseDataEventType
GetEventDetailsResponseDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
GetEventDetailsResponseDataStatus
GetEventDetailsResponseDataStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus
GetEventDetailsResponseInputDataAttendeesAnyOfItemResponseStatus:
object
Type Declaration
accepted
readonlyaccepted:"accepted"='accepted'
declined
readonlydeclined:"declined"='declined'
tentative
readonlytentative:"tentative"='tentative'
needsAction
readonlyneedsAction:"needsAction"='needsAction'
GetEventDetailsResponseInputDataCalendarPlatform
GetEventDetailsResponseInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
GetEventDetailsResponseInputDataEventType
GetEventDetailsResponseInputDataEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
GetEventDetailsResponseInputDataStatus
GetEventDetailsResponseInputDataStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
GetScheduledBotResponseDataCallbackConfigAnyOfMethod
GetScheduledBotResponseDataCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
GetScheduledBotResponseDataMeetingPlatform
GetScheduledBotResponseDataMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
GetScheduledBotResponseDataRecordingMode
GetScheduledBotResponseDataRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
GetScheduledBotResponseDataStatus
GetScheduledBotResponseDataStatus:
object
Type Declaration
scheduled
readonlyscheduled:"scheduled"='scheduled'
cancelled
readonlycancelled:"cancelled"='cancelled'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider
GetScheduledBotResponseDataTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod
GetScheduledBotResponseInputDataCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
GetScheduledBotResponseInputDataMeetingPlatform
GetScheduledBotResponseInputDataMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
GetScheduledBotResponseInputDataRecordingMode
GetScheduledBotResponseInputDataRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
GetScheduledBotResponseInputDataStatus
GetScheduledBotResponseInputDataStatus:
object
Type Declaration
scheduled
readonlyscheduled:"scheduled"='scheduled'
cancelled
readonlycancelled:"cancelled"='cancelled'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider
GetScheduledBotResponseInputDataTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
ListBotsResponseDataItemMeetingPlatform
ListBotsResponseDataItemMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
ListBotsResponseDataItemStatus
ListBotsResponseDataItemStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
ListBotsResponseInputDataItemMeetingPlatform
ListBotsResponseInputDataItemMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
ListBotsResponseInputDataItemStatus
ListBotsResponseInputDataItemStatus:
object
Type Declaration
queued
readonlyqueued:"queued"='queued'
transcribing
readonlytranscribing:"transcribing"='transcribing'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
joining_call
readonlyjoining_call:"joining_call"='joining_call'
in_waiting_room
readonlyin_waiting_room:"in_waiting_room"='in_waiting_room'
in_waiting_for_host
readonlyin_waiting_for_host:"in_waiting_for_host"='in_waiting_for_host'
in_call_not_recording
readonlyin_call_not_recording:"in_call_not_recording"='in_call_not_recording'
in_call_recording
readonlyin_call_recording:"in_call_recording"='in_call_recording'
recording_paused
readonlyrecording_paused:"recording_paused"='recording_paused'
recording_resumed
readonlyrecording_resumed:"recording_resumed"='recording_resumed'
call_ended
readonlycall_ended:"call_ended"='call_ended'
recording_succeeded
readonlyrecording_succeeded:"recording_succeeded"='recording_succeeded'
recording_failed
readonlyrecording_failed:"recording_failed"='recording_failed'
api_request_stop
readonlyapi_request_stop:"api_request_stop"='api_request_stop'
bot_rejected
readonlybot_rejected:"bot_rejected"='bot_rejected'
bot_removed
readonlybot_removed:"bot_removed"='bot_removed'
bot_removed_too_early
readonlybot_removed_too_early:"bot_removed_too_early"='bot_removed_too_early'
waiting_room_timeout
readonlywaiting_room_timeout:"waiting_room_timeout"='waiting_room_timeout'
invalid_meeting_url
readonlyinvalid_meeting_url:"invalid_meeting_url"='invalid_meeting_url'
meeting_error
readonlymeeting_error:"meeting_error"='meeting_error'
ListCalendarsResponseDataItemCalendarPlatform
ListCalendarsResponseDataItemCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
ListCalendarsResponseDataItemStatus
ListCalendarsResponseDataItemStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
ListCalendarsResponseInputDataItemCalendarPlatform
ListCalendarsResponseInputDataItemCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
ListCalendarsResponseInputDataItemStatus
ListCalendarsResponseInputDataItemStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
ListEventSeriesResponseDataItemEventType
ListEventSeriesResponseDataItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
ListEventSeriesResponseDataItemEventsItemStatus
ListEventSeriesResponseDataItemEventsItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
ListEventSeriesResponseInputDataItemEventType
ListEventSeriesResponseInputDataItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
ListEventSeriesResponseInputDataItemEventsItemStatus
ListEventSeriesResponseInputDataItemEventsItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
ListEventsResponseDataItemEventType
ListEventsResponseDataItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
ListEventsResponseDataItemStatus
ListEventsResponseDataItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
ListEventsResponseInputDataItemEventType
ListEventsResponseInputDataItemEventType:
object
Type Declaration
one_off
readonlyone_off:"one_off"='one_off'
recurring
readonlyrecurring:"recurring"='recurring'
ListEventsResponseInputDataItemStatus
ListEventsResponseInputDataItemStatus:
object
Type Declaration
confirmed
readonlyconfirmed:"confirmed"='confirmed'
cancelled
readonlycancelled:"cancelled"='cancelled'
tentative
readonlytentative:"tentative"='tentative'
ListRawCalendarsRequestBodyCalendarPlatform
ListRawCalendarsRequestBodyCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
ListRawCalendarsRequestBodyInputCalendarPlatform
ListRawCalendarsRequestBodyInputCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
ListScheduledBotsResponseDataItemMeetingPlatform
ListScheduledBotsResponseDataItemMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
ListScheduledBotsResponseDataItemStatus
ListScheduledBotsResponseDataItemStatus:
object
Type Declaration
scheduled
readonlyscheduled:"scheduled"='scheduled'
cancelled
readonlycancelled:"cancelled"='cancelled'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
ListScheduledBotsResponseInputDataItemMeetingPlatform
ListScheduledBotsResponseInputDataItemMeetingPlatform:
object
Type Declaration
zoom
readonlyzoom:"zoom"='zoom'
meet
readonlymeet:"meet"='meet'
teams
readonlyteams:"teams"='teams'
ListScheduledBotsResponseInputDataItemStatus
ListScheduledBotsResponseInputDataItemStatus:
object
Type Declaration
scheduled
readonlyscheduled:"scheduled"='scheduled'
cancelled
readonlycancelled:"cancelled"='cancelled'
completed
readonlycompleted:"completed"='completed'
failed
readonlyfailed:"failed"='failed'
RetryCallbackRequestBodyAnyOfMethod
RetryCallbackRequestBodyAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
RetryCallbackRequestBodyInputAnyOfMethod
RetryCallbackRequestBodyInputAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod
UpdateCalendarBotRequestBodyAllOfTwoCallbackConfigMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
UpdateCalendarBotRequestBodyAllOfTwoRecordingMode
UpdateCalendarBotRequestBodyAllOfTwoRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider
UpdateCalendarBotRequestBodyAllOfTwoTranscriptionConfigProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod
UpdateCalendarBotRequestBodyInputAllOfTwoCallbackConfigMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode
UpdateCalendarBotRequestBodyInputAllOfTwoRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider
UpdateCalendarBotRequestBodyInputAllOfTwoTranscriptionConfigProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
UpdateCalendarConnectionResponseDataCalendarPlatform
UpdateCalendarConnectionResponseDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
UpdateCalendarConnectionResponseDataStatus
UpdateCalendarConnectionResponseDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
UpdateCalendarConnectionResponseInputDataCalendarPlatform
UpdateCalendarConnectionResponseInputDataCalendarPlatform:
object
Type Declaration
readonlygoogle:"google"='google'
microsoft
readonlymicrosoft:"microsoft"='microsoft'
UpdateCalendarConnectionResponseInputDataStatus
UpdateCalendarConnectionResponseInputDataStatus:
object
Type Declaration
active
readonlyactive:"active"='active'
error
readonlyerror:"error"='error'
revoked
readonlyrevoked:"revoked"='revoked'
permission_denied
readonlypermission_denied:"permission_denied"='permission_denied'
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod
UpdateScheduledBotRequestBodyCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod
UpdateScheduledBotRequestBodyInputCallbackConfigAnyOfMethod:
object
Type Declaration
POST
readonlyPOST:"POST"='POST'
PUT
readonlyPUT:"PUT"='PUT'
UpdateScheduledBotRequestBodyInputRecordingMode
UpdateScheduledBotRequestBodyInputRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider
UpdateScheduledBotRequestBodyInputTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'
UpdateScheduledBotRequestBodyRecordingMode
UpdateScheduledBotRequestBodyRecordingMode:
object
Type Declaration
audio_only
readonlyaudio_only:"audio_only"='audio_only'
speaker_view
readonlyspeaker_view:"speaker_view"='speaker_view'
gallery_view
readonlygallery_view:"gallery_view"='gallery_view'
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider
UpdateScheduledBotRequestBodyTranscriptionConfigAnyOfProvider:
object
Type Declaration
gladia
readonlygladia:"gladia"='gladia'