Skip to navigation

Get call

Returns one call with everything except the transcript: the report card with each criterion, the transfer to a person, the SMS sent, the summary written by the agent and the data it collected. Use it to update a CRM after a call (for example when the call.analyzed webhook says the report card is ready). The summary and the collected data are personal data of the caller: when the call has them, each read is recorded in the audit log of the organization. Required scope: calls:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

call_idstringRequiredformat: "^[A-Za-z0-9][A-Za-z0-9_:.-]{0,127}$"

Id of the call, as returned by GET /calls or by a webhook event.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Response

Successful response.
object"call"

Always call.

idstring

Id of the call: use it with GET /calls/{call_id}, the transcript and the events.

started_atdatetime or null

When the call started, ISO 8601 UTC; null if it never started.

ended_atdatetime or null

When the call ended, ISO 8601 UTC; null while it is in progress.

duration_secondsinteger>=0

Talk time in seconds. 0 for missed calls. It is not the billed time (see GET /usage).

directionenum

inbound: a phone call received on a line of the organization. outbound: a phone call made by an agent (POST /calls or a campaign). web: a conversation in the web widget.

Allowed values:
statusenum

How the call went. completed: the conversation ended normally. transferred: the agent handed the call to a person. forwarded: an inbound call forwarded to the business number without the agent (answering mode, or a backup number). interrupted: the call was cut before its natural end. failed: the call could not take place because of an error. in_progress: the call is still going on. Rejected before an agent answered: missed_lines_busy (all concurrent-call lines busy), missed_quota (plan minutes used up), missed_suspended (organization suspended), missed_platform (the service was at capacity), missed_agent_suspended (the agent is suspended).

caller_numberstring or null

The other party of the call, in international format: who called (inbound) or who was called (outbound). null on the web channel.

line_numberstring or null

The phone line of the organization used by the call, in international format. null on the web channel.

agentobject or null

The agent that handled the call (the first one, for calls that passed between agents); null if no agent took part.

handoff_countinteger>=0
How many times the call passed from one agent of a team to another. 0 for calls handled by one agent.
summarystring or null

Free text written by the agent after the call; it may contain personal data of the caller. Only on the single call, never in the list. Reading it is recorded in the audit log. null if there is no summary.

report_cardobject
The report card of the call, with each criterion.
transferobject
The transfer to a person, if the agent tried one.
sms_sent_countinteger>=0
SMS sent by the agent during the call.
collected_datalist of objects

Information the agent extracted from the conversation, as configured on the agent; personal data of the caller. Reading it is recorded in the audit log. Empty if nothing was collected.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error