GET
/
conversations
/
{conversation_id}
Get a conversation
curl --request GET \
  --url https://api.operator.xyz/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Operator-Version: <operator-version>'
{
  "id": "<string>",
  "agent_id": "<string>",
  "customer_id": null,
  "channel_type": null,
  "channel": {
    "type": "phone",
    "callee_no": null,
    "caller_no": null,
    "recording_url": null
  },
  "livemode": true,
  "override_config": null,
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": null,
  "completed_at": null,
  "direction": "inbound",
  "status": "queued",
  "failure_reason": null,
  "custom_fields": {},
  "summary": null,
  "duration_sec": null,
  "sentiment": null
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Operator-Version
enum<string>
required

The API version to use.

Available options:
2025-06-19

Path Parameters

conversation_id
string
required

Unique identifier for the conversation, e.g. conv_8qm9JBCiTe7.

Response

Successful response.

id
string
required

Unique identifier for the conversation, e.g. conv_8qm9JBCiTe7.

agent_id
string
required

Version-specific identifier for the agent that handled the conversation, e.g. ca_8qm9JBCiTe7@v0.

livemode
boolean
required

Whether the conversation is in livemode.

created_at
string<date-time>
required

When the conversation was created.

direction
enum<string>
required

The direction of the conversation.

Available options:
inbound,
outbound
status
enum<string>
required

The status of the conversation.

Available options:
queued,
in-progress,
completed,
voicemail,
failed,
busy,
no-answer
custom_fields
object
required

Additional key-value pairs attached to the conversation. These can be used to store arbitrary data by procedural agents.

customer_id
string

Unique identifier for the customer, e.g. cus_8qm9JBCiTe7.

channel_type
enum<string>

The channel of the conversation.

Available options:
phone,
chat_realtime,
chat_async
channel
object

The channel of the conversation. Response object for a phone channel conversation.

override_config
object

Partial override for the agent's configuration (e.g. voice, runtime, tools). Follows the same shape as the agent configuration object, but all fields are optional since it is merged into the base config.

started_at
string<date-time>

When the conversation was started.

completed_at
string<date-time>

When the conversation was completed.

failure_reason
enum<string>

The reason for the conversation failure, only set when status is failed.

Available options:
dial_failed,
number_marked_disconnected,
pstn_blocked,
dnc_rejected,
tcpa_rejected,
number_invalid,
internal_error,
twilio_error,
agent_timeout,
customer_requested_dnc
summary
string

The summary of the conversation.

duration_sec
integer

The duration of the conversation in seconds.

sentiment
string

The sentiment of the customer during the conversation.