Calls
Get a call
https://voxa.abhinavyadav.in/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.
Path parameters
call_idstringrequiredThe 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.
idstringThe call's id.
agent_idstringagent_namestringchannelenum<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_numberstringto_numberstringstatusenum<string>default: "queued"Final states: completed, failed, no-answer, busy, canceled.
One of:queuedringingin-progresscompletedfailedno-answerbusycanceled
providerstringdefault: "plivo"provider_call_idstringprovider_request_idstringuser_dataobjectWhat 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
textstringatstringdate-time
interruptedbooleandefault: falseusageobjectSpeech, voice and model usage.
Show child attributes
stt_secondsnumberdefault: 0tts_charactersintegerdefault: 0llm_input_tokensintegerdefault: 0llm_output_tokensintegerdefault: 0llm_callsintegerdefault: 0recording_secondsnumberdefault: 0Length of the recording; download it with Download a recording.
hangup_bystringWho ended the call (agent, user, api, system, ...).
hangup_reasonstringerrorstringcreated_atstringdate-time
answered_atstring | nulldefault: nulldate-time
ended_atstring | nulldefault: nulldate-time
duration_secondsnumberdefault: 0From answer to hang-up.
first_audio_msinteger | nulldefault: nullAverage time from the caller finishing a turn to the agent's first audio.
cost_paiseintegerdefault: 0What the call cost the workspace, billed per second.
providersobjectprovider_cost_usdnumberdefault: 0queued_atstring | nulldefault: nullWhen the call joined the queue (outbound calls).
date-time
dequeued_atstring | nulldefault: nulldate-time
ignore_call_windowbooleandefault: falsesummarystringPost-call summary, when the agent's analytics ask for one.
extractedobjectPost-call extraction, when the agent's analytics ask for it.
batch_idstringbatch_rowinteger | nulldefault: nullattemptintegerdefault: 1401No credentials, or they are invalid or revoked.
detailstringWhat went wrong, in plain words.
403Your role (or an API key) lacks the permission.
detailstringWhat went wrong, in plain words.
422Validation Error
detailobject[]Show item attributes
locstring | integer[]msgstringtypestring429Over the per-key rate limit; wait for Retry-After.
detailstringWhat went wrong, in plain words.