Skip to main content
GET
Get a conversation

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

id
string
erforderlich

The numeric id or the conversation_id of the conversation.

Antwort

The conversation, with its transcript when your retention settings allow.

id
integer
erforderlich

ID of the conversation.

conversation_id
string
erforderlich

Stable public ID of the conversation. Accepted by GET /api/v1/conversations/{id}.

call_id
string | null
erforderlich

Telephony call identifier. Set for voice conversations only.

channel
enum<string>
erforderlich

Channel the conversation took place on.

Verfügbare Optionen:
voice,
livechat,
whatsapp,
email,
other
status
string
erforderlich

Always open; closed conversations are not returned.

Allowed value: "open"
agent_id
integer | null
erforderlich

The voice agent (its id from GET /api/v1/voice_agents) or messaging agent that handled the conversation.

agent_name
string | null
erforderlich

Name of the agent that handled the conversation.

started_at
string<date-time> | null
erforderlich

Call start for voice, otherwise when the conversation was created.

ended_at
string<date-time> | null
erforderlich

Call end for voice conversations; null for chats.

duration_seconds
integer | null
erforderlich

Call duration in seconds; null for chats.

metadata
object
erforderlich

Usage figures of the conversation.

transcript
object[]

Detail responses only. Omitted when your retention settings do not allow access, the transcript has expired, or cleanup has already removed it. Hidden and technical messages are never included.