Sign in
bot

Send Chat Message

Causes the bot to send a message in the meeting chat.

The base rate limit for this endpoint is:

  • 300 requests per min per workspace
post/api/v1/bot/{id}/send_chat_message/

Path parameters

idstring uuid required

A UUID string identifying this bot.

Request body

tostring

The person or group that the message will be sent to. On non-Zoom platforms, "everyone" is currently the only supported option, meaning the message will be sent to everyone in the meeting.

messagestring required

The message that will be sent.

pinboolean

Response

idstring uuid required
bot_namestring

The name of the bot that will be displayed in the call. (Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_atstring date-time nullable

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call.

metadataobject

Changes

Changed in 3 of the 6 revisions of this API.373

  • 56a9d14b7f103See the full diff
    • ●

      removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_config from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_url from the response with the 200 status

      response-optional-property-removed

  • 55ce8c277c241See the full diff
    • ○

      added the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/deepgram_async/credential_id to the response with the 200 status

      response-optional-property-added

  • 01244e56b3a1342See the full diff
    • ▲

      added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmp BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocket BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhook BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallback to the recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/type from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/events from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/url from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new melia-1 enum value to the recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/operating_point response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/model to the response with the 200 status

      response-optional-property-added

    • ○

      added discriminator to recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property for the response status 200

      response-property-discriminator-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog