UNunified
calendar
bot

List all bots

Changed on

Returns a list of CalendarBots. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/calendar/{connection_id}/bot

Request

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

meeting_urlstring

Filter bots by meeting URL

event_idstring

Filter bots by calendar event ID (reference to CalendarEvent)

statusstring

Filter bots by status (READY, IN_CALL_RECORDING, DONE, etc.)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

Display name for the bot in the meeting

meeting_urlstring

URL of the meeting to join

event_idstring

Reference to calendar_event if scheduled via calendar (reference to CalendarEvent)

status'READY' | 'JOINING_CALL' | 'IN_WAITING_ROOM' | 'IN_CALL_NOT_RECORDING' | 'RECORDING_PERMISSION_ALLOWED' | 'RECORDING_PERMISSION_DENIED' | 'IN_CALL_RECORDING' | 'CALL_ENDED' | 'DONE' | 'FATAL'
join_atstring date-time

When to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

started_atstring date-time

When the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

ended_atstring date-time

When the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

recording_idstring

Reference to calendar_recording when ready

rawobject

Changes