Messages (v6)

Get messages by sequence range

Returns the conversation's messages (MessageV6) whose channel sequence is between sequence_from and sequence_to inclusive, ascending by sequence. With notified=true only the ones the user was notified about. Successor to the v3 /messages/{channel_id}/sequential/{start}/{stop} and .../notified/{start}/{stop} reads. A request may span at most 500 sequences. MessageV6 differs from v5 in three ways: thread_id (the parent id, or the message id itself when it is not a reply) replaces parent_message_id; the audio rendition and its transcript, AI summary, language flags and time codes are nested under content, with the waveform as a compact base-36 string; and the requesting user's own state (heard_ms, label_ids, notify, notes, last_heard_update) is included where the read path carries it.

get/v6/messages/by-sequence

Request

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

Query parameters

conversation_idstring required

Conversation (channel) ID. User must have access to it.

sequence_fromnumber required

First channel sequence of the range (inclusive).

sequence_tonumber required

Last channel sequence of the range (inclusive). At most 500 sequences past sequence_from.

notifiedboolean

Only the messages the user was notified about (default: false).

languagestring

Language for message content (e.g. transcript, audio). Original language used if not provided.

presigned_urlboolean

Include presigned URLs for audio files (default: false).

Response

Changes

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