POST
/
conversations
/
create_phone_call

Authorizations

Authorization
string
headerrequired

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

Body

application/json
from_number
string
required

The phone number associated with the account from which the call will be made.

to_number
string
required

The phone number to call including the country code.

agent_id
string

The agent id to use for the conversation. If null, the agent configuration will be used.

agent_config
object

The agent configuration to use for the conversation. If null, the agent id will be used.

Response

200 - application/json
uri
string
required

The uri of the conversation.

type
enum<string>
required

The type of conversation.

Available options:
inbound_phone_call,
outbound_phone_call,
web_call
account_id
string
required

The account id associated with of the conversation.

status
enum<string>
required

The status of the conversation.

Available options:
started,
ended,
queued
agent_config
object
required

The agent configuration used for the conversation.

id
string
required

The id of the conversation.

started_at
string

The start time of the conversation.

ended_at
string

The end time of the conversation. Returns null if the conversation is has not ended.

agent_id
string

The id of the agent used in the conversation. Returns null if the conversation did not use an existing agent.

messages
object[]

The messages of the conversation.

phone_call
object

The phone call details of the conversation. Returns null if the conversation was over web.

ended_reason
enum<string>

The reasons the conversation ended.

Available options:
agent_ended,
user_ended,
unknown
cost_breakdown
object

The cost breakdown of the conversation.

Get Audio RecordingGet Phone Number