Messages (v6)

Create conversation message and obtain stream_key for WebSocket audio upload

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. Always returns 201 Created, including idempotent replays. Clients that need to distinguish a replay from an initial creation must compare idempotency_key / id instead of relying on the HTTP status.

post/v6/messages/stream

Request

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

Request body

idempotency_keystring uuid

Optional client-supplied UUID idempotency key. When the key is reused for the same user the server returns the existing message instead of failing.

conversation_idstring required

Conversation (legacy channel_id). Required in the JSON body for every /v5/messages/* route.

reply_to_message_idstring

ID of the message being replied to; backend resolves the thread root automatically

tagged_user_idsstring[]

IDs of users to tag on this message at creation time

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.