Skip to main content
GET
/
core
/
conversations
/
{conversation_id}
Get a conversation
curl --request GET \
  --url https://api.anyreach.ai/core/conversations/{conversation_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "user_id": "<string>",
  "agent_id": "<string>",
  "agent_version_id": "<string>",
  "agent_number": "<string>",
  "web_widget_id": "<string>",
  "duration": 123,
  "user_turn_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "summary": "<string>",
  "initial_context": "<string>",
  "custom_metadata": {},
  "conversation": {},
  "recording_details": {}
}

Authorizations

​
Authorization
string
header
required

Personal access token. See Authentication.

Path Parameters

​
conversation_id
string
required

The conversation's unique ID.

Response

The conversation.

Fields marked sensitive are only returned to tokens whose role grants access to them.

​
id
string

Unique conversation ID.

​
organization_id
string

Your organization ID.

​
direction
enum<string>

Who initiated the conversation.

Available options:
inbound,
outbound
​
channel
enum<string>

The conversation channel.

Available options:
telephone,
webrtc,
email,
text
​
status
enum<string>

Current state of the conversation.

Available options:
token_created,
triggered,
ringing,
in_progress,
completed,
failed,
cancelled,
transferred,
unanswered
​
user_id
string

The end user's identifier (a phone number for telephony).

​
agent_id
string

The agent handling the conversation.

​
agent_version_id
string

The specific agent version in use.

​
agent_number
string

The agent's phone number (telephony).

​
web_widget_id
string | null

The web widget that originated the conversation, if any.

​
duration
integer | null

Conversation length in seconds.

​
user_turn_count
integer | null

Number of user turns.

​
created_at
string<date-time>

Creation timestamp.

​
updated_at
string<date-time>

Last-update timestamp.

​
agent
object

Sensitive. The handling agent.

​
summary
string

Sensitive. Generated conversation summary.

​
initial_context
string

Sensitive. Context injected into the agent at the start of the conversation.

​
custom_metadata
object | null

Sensitive. Metadata you attached when creating the conversation.

​
conversation
object | null

Sensitive. The transcript.

​
recording_details
object | null

Sensitive. Recording information, including a time-limited recording_url.