Messages (v6)

Start welcome message

Returns the started message plus a signed stream_key. Clients open the existing application websocket and authenticate the audio-upload session with this key (same flow as the legacy v3 stream-key behavior). The stream_key is bound to message.id and expires according to the websocket gateway configuration.

post/v6/messages/welcome/start

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v6/messages/welcome/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'
workspace_idstring required
is_voicemailboolean required

Response

stream_keystring required

Signed key the client must use to authenticate the websocket audio upload session for this message.

Changes

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