Retrieve a bot

Updated:

GET/calendar/{connection_id}/bot/{id}

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

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Bot

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDisplay name for the bot in the meeting
meeting_urlstringNoURL of the meeting to join
event_idstringNoReference to calendar_event if scheduled via calendar (reference to CalendarEvent)
statusenumNoValues: READY, JOINING_CALL, IN_WAITING_ROOM, IN_CALL_NOT_RECORDING, RECORDING_PERMISSION_ALLOWED, RECORDING_PERMISSION_DENIED, IN_CALL_RECORDING, CALL_ENDED, DONE, FATAL
status_changesCalendarBotStatusChange[]NoHistory of status changes
status_changes[].statusenumNoValues: READY, JOINING_CALL, IN_WAITING_ROOM, IN_CALL_NOT_RECORDING, RECORDING_PERMISSION_ALLOWED, RECORDING_PERMISSION_DENIED, IN_CALL_RECORDING, CALL_ENDED, DONE, FATAL
status_changes[].changed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status_changes[].sub_codestringNoPlatform-specific status sub-code
status_changes[].messagestringNoHuman-readable status message
join_atstring (date-time)NoWhen to join the meeting (for scheduled bots) (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
started_atstring (date-time)NoWhen the bot actually joined (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
ended_atstring (date-time)NoWhen the bot left (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
recording_configobjectNo
recording_config.record_videobooleanNo
recording_config.record_audiobooleanNo
recording_config.record_transcriptbooleanNo
recording_config.record_chatbooleanNo
recording_config.record_screensharebooleanNo
recording_config.transcriptionCalendarBot_recording_config_transcriptionNo
recording_config.transcription.providerenumNoValues: MEETING_CAPTIONS, AWS_TRANSCRIBE, GOOGLE_SPEECH, ASSEMBLYAI, DEEPGRAM, CUSTOM
recording_config.transcription.modeenumNoValues: PRIORITIZE_ACCURACY, PRIORITIZE_LOW_LATENCY
recording_config.transcription.languagestringNoISO language code (e.g., 'en-US')
recording_config.transcription.enable_speaker_labelsbooleanNoWhether to identify speakers in transcript
recording_config.transcription.enable_word_timestampsbooleanNoWhether to include word-level timestamps
automatic_leaveobjectNo
automatic_leave.waiting_room_timeoutnumberNoSeconds to wait in waiting room before leaving (default: 1200)
automatic_leave.no_participants_timeoutnumberNoSeconds to wait when no other participants before leaving (default: 2)
automatic_leave.detect_botsbooleanNoWhether to leave if only bots remain
meeting_metadataobjectNo
meeting_metadata.titlestringNo
meeting_metadata.platformstringNo'zoom', 'webex', 'google_meet', etc.
meeting_metadata.host_namestringNo
meeting_metadata.host_emailstringNo
meeting_metadata.meeting_identifierstringNoPlatform-specific meeting identifier (not a unified object ref)
meeting_metadata.started_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
meeting_metadata.ended_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
meeting_metadata.participant_countnumberNo
participantsCalendarBotParticipant[]No
participants[].idstringNo
participants[].namestringNo
participants[].emailstringNo
participants[].is_hostbooleanNo
participants[].is_cohostbooleanNo
participants[].joined_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
participants[].left_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
participants[].platformstringNoPlatform-specific participant identifier
participants[].is_botbooleanNoWhether this participant is a bot
participants[].is_selfbooleanNoWhether this participant is the current bot
participants[].speakingbooleanNoWhether participant is currently speaking
participants[].webcam_onbooleanNoWhether participant's webcam is on
participants[].screenshare_onbooleanNoWhether participant is sharing screen
participants[].platform_metadataobjectNoPlatform-specific metadata
recording_idstringNoReference to calendar_recording when ready

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/calendar/5de520f96e439b002043d8dc/bot/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?