Conversations

Conversation detail

404 rather than 403 on someone else's conversation: the id is the only secret protecting a transcript, and a 403 would confirm it is real.

get/v1/conversations/{id}

Request

  • Base URL: https://api.cadencercs.com
  • URL: https://api.cadencercs.com/v1/conversations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Conversation id.

Response

The conversation.

idstring required
agentIdstring required
brandIdstring required
tostring required

Recipient, E.164.

channel'rcs' | 'sms' | 'queued'
channelConfidence'provisional' | 'committed'

provisional means we chose a channel and have no confirmation yet. It becomes committed when the channel is proven: on the first delivery receipt from the handset on RCS, or on an SMS fallback caused by the recipient — no RCS on their device, or your agent not launched on their carrier.

A fallback caused by us — a rejected payload, a bad credential, a timeout — leaves this provisional, because it says nothing about the recipient. Committing there would mark a perfectly reachable handset SMS-only for the rest of the conversation on the strength of our own bug, and report it as a fact about their phone. See fellBack.ourFault on the send response.

trustLevel'verified_rcs' | 'branded_sms' | 'unbranded_sms'
state'OPENING' | 'OPEN' | 'USER_REPLIED' | 'CHANNEL_FLIP_TO_SMS' | 'CLOSING' | 'CLOSED' | 'CLOSED_OPTOUT' required
useCase'transactional' | 'promo' | 'conversational' | 'leadgen'
turnCountnumber
turnCeilingnumber
rcsOnlyboolean

SMS is disabled for this conversation.

createdAtstring
closedAtstring nullable

Changes

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