UNunified
calendar
bot

Retrieve a bot

Changed on

Retrieves a single CalendarBot by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

get/calendar/{connection_id}/bot/{id}

Request

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Bot

Query parameters

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