Skip to content
VoxaDocs
Navigation
Open console →

Calls

Get a call

GET/api/v1/calls/{call_id}

One call with its transcript, usage, cost, and post-call analytics (summary, extracted).

Authorization

An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.view permission.

X-API-KeyAuthorization: Bearercalls.view

Path parameters

call_idstringrequired

The call's id.

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Response

200Success.
idstring

The call's id.

agent_idstring
agent_namestring
channelenum<string>default: "phone"

phone or web (a browser test call).

One of:phoneweb

directionenum<string>default: "outbound"

outbound, inbound or web.

One of:outboundinboundweb

from_numberstring
to_numberstring
statusenum<string>default: "queued"

Final states: completed, failed, no-answer, busy, canceled.

One of:queuedringingin-progresscompletedfailedno-answerbusycanceled

providerstringdefault: "plivo"
provider_call_idstring
provider_request_idstring
user_dataobject

What was passed when the call was placed.

transcriptobject[]

Every turn, in order (only on Get a call).

Show item attributes
roleenum<string>

One of:assistantusertool

textstring
atstring

date-time

interruptedbooleandefault: false
usageobject

Speech, voice and model usage.

Show child attributes
stt_secondsnumberdefault: 0
tts_charactersintegerdefault: 0
llm_input_tokensintegerdefault: 0
llm_output_tokensintegerdefault: 0
llm_callsintegerdefault: 0
recording_secondsnumberdefault: 0

Length of the recording; download it with Download a recording.

hangup_bystring

Who ended the call (agent, user, api, system, ...).

hangup_reasonstring
errorstring
created_atstring

date-time

answered_atstring | nulldefault: null

date-time

ended_atstring | nulldefault: null

date-time

duration_secondsnumberdefault: 0

From answer to hang-up.

first_audio_msinteger | nulldefault: null

Average time from the caller finishing a turn to the agent's first audio.

cost_paiseintegerdefault: 0

What the call cost the workspace, billed per second.

providersobject
provider_cost_usdnumberdefault: 0
queued_atstring | nulldefault: null

When the call joined the queue (outbound calls).

date-time

dequeued_atstring | nulldefault: null

date-time

ignore_call_windowbooleandefault: false
summarystring

Post-call summary, when the agent's analytics ask for one.

extractedobject

Post-call extraction, when the agent's analytics ask for it.

batch_idstring
batch_rowinteger | nulldefault: null
attemptintegerdefault: 1
401No credentials, or they are invalid or revoked.
detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.
detailstring

What went wrong, in plain words.

422Validation Error
detailobject[]
Show item attributes
locstring | integer[]
msgstring
typestring
429Over the per-key rate limit; wait for Retry-After.
detailstring

What went wrong, in plain words.

Esc