Get Conversations

Get all conversations of agents that user owns. With option to restrict to a specific agent.

Headers

xi-api-key

string

Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Query Parameters

cursor

string

Used for fetching next page. Cursor is returned in the response.

agent_id

string

The id of the agent you're taking the action on.

call_successful

enum<string>

The result of the success evaluation

Available options:

success,

failure,

unknown

page_size

integer

default: 30

How many conversations to return at maximum. Can not exceed 100, defaults to 30.

Required range: 1 < x < 100

Response

200 - application/json

conversations

object[]

required

Show child attributes

conversations.agent_id

string

required

conversations.agent_name

string

conversations.conversation_id

string

required

conversations.start_time_unix_secs

integer

required

conversations.call_duration_secs

integer

required

conversations.message_count

integer

required

conversations.status

enum<string>

required

Available options:

processing,

done

conversations.call_successful

enum<string>

required

An enumeration.

Available options:

success,

failure,

unknown

has_more

boolean

required

next_cursor

string