MessageControllerV3
Messages

Start channel message

post/v3/messages/start

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v3/messages/start
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

transcriptstring nullable

The transcript if the client generated one, if is_text_message is true then this text will be used to generate andio using text-to-speech

is_text_messageboolean required

If true the server will generate audio based on the transcript provided

unique_client_idstring required

A unique id the client can use to identify the message, server will prevent duplicates using it

release_datestring date-time nullable

The date the message should be released (Not yet implemented)

is_streamingboolean required

If the message is being streamed than notifications are sent to listeners at the begining of the message

announce_userboolean nullable

Only used if is_text_message is true, prepends <first name said> to transcript before text-to-speech

voicestring nullable

the voice to use when doing text to speech

kind'audio' | 'text' | 'attachment' | 'action-item' | 'ai-prompt' | 'ai-response' | 'channel-reminder'
channel_idstring required
workspace_guidstring nullable
reply_to_message_idstring nullable
tagged_user_idsstring[]

IDs of users to tag on this message at creation time

Response

message_idstring required
creator_idstring required
created_atstring date-time required
deleted_atstring date-time nullable
last_updated_atstring date-time required
workspace_idsstring[] required
channel_idsstring[] required
parent_message_idstring nullable
heard_msnumber nullable

The number of ms of audio listened to by the user requesting the message

notesstring required
notifyboolean required

Has the logged in user cleared the notification for this message

last_heard_updatestring date-time required

Last time we listened/updated notify bit

namestring nullable
is_text_messageboolean required
status'offline' | 'paused' | 'processing' | 'scheduled' | 'active' | 'deleted' | 'account-deleted' | 'initializing' | 'inprogress' | 'canceled' | 'failed' required
label_idsstring[] required
source_message_idstring nullable required
cache_keystring required
audio_delivery'recording' | 'streaming' required
duration_msnumber required

The length of the message in milliseconds

total_heard_msnumber required

The number of ms of audio listened to by all users

notified_usersnumber required

Then number of users who have a notification for this message and have not listened to the audio.

users_caught_up'all' | 'some' | 'none' required

The number of users that listened to the audio or removed the notification

forward_idstring nullable

The ID of a forwarded message (Deprecated, for new implementations we should start using share_link_id

share_link_idstring nullable

The ID of a Share Link to a message

stream_keystring nullable

The stream key used to add audio to the message

socket_disconnects_while_streamingnumber required

The number of times the socket disconnected while the creator was sending audio

type'channel' | 'prerecorded' | 'voicememo' | 'stored' | 'welcome' required

Message type

channel_sequencenumber required

The sequencial id of the message within the channel

last_heard_atstring date-time required

The last time anyone listened or cleared notified on this message

folder_idstring nullable

Folder ID, only present when the message type is one of: voicememo,prerecorded

tagged_user_idsstring[] required

IDs of users tagged in the message

Changes

No recorded changes to this operation across all 1 revision of this API.