Calls
List calls
https://api.vaakyo.com/api/v1/callsCalls in the workspace, newest first, without transcripts. Page with limit and skip; total is the number of calls matching the filters.
Authorization
An API key (X-API-Key or Authorization: Bearer), or a signed-in member with the calls.view permission.
Query parameters
sortstringdefault: "-created_at"created_at, duration_seconds or cost_paise; a leading - for descending
at most 20 characters
limitintegerdefault: 50How many to return.
1 to 200
skipintegerdefault: 0How many to skip (for paging).
at least 0
agent_idstringan agent id, or several comma-separated
at most 1400 characters
statusstringcomma-separated statuses
at most 80 characters
directionstringoutbound, inbound or web (comma-separated)
at most 40 characters
qstringtext in a number, the agent's name or the call id
at most 80 characters
batch_idstringonly the calls of this batch (campaign)
at most 64 characters
sincestring | nullcreated at or after this time (ISO 8601)
date-time
untilstring | nullcreated before this time (ISO 8601)
date-time
call_idstringa call id or its beginning
at most 64 characters
phone_numberstringthe agent's number(s), comma-separated (caller id or dialled number)
at most 400 characters
customer_numberstringthe customer's number, or a part of it
at most 20 characters
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.
itemsobject[]Newest first, without the transcript.
Show item attributes
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_idstringwaiting_forstringprovider_accountstringuser_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.
currencystringcost_breakdownobjectplan_seconds_coveredintegerdefault: 0providersobjectprovider_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.
guardrail_incidentsintegerdefault: 0guardrail_severitystringguardrail_checkobjectbatch_idstringbatch_rowinteger | nulldefault: nullattemptintegerdefault: 1answered_bystringscheduled_forstring | nulldefault: nulldate-time
rescheduled_fromstringrescheduled_tostringrescheduled_forstring | nulldefault: nulldate-time
transferred_toobjecttransferred_atstring | nulldefault: nulldate-time
transfer_reasonstringtransfer_statusstringtransfer_secondsnumberdefault: 0transfer_charged_paiseintegerdefault: 0totalintegerCalls matching the filters.
401No 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.