List calls

The call history, newest first. direction (in or out) limits the list to one direction. Filters from/to (Unix ms, startedAt in range, from <= to), agentId, flagged (true/false), goal (success/failure/unclear/no_conversation/not_evaluated, or the backward-compatible unknown - records with no clear result: goal.result is missing or unknown (always true for unclear and not_evaluated, and for no_conversation only when its result is unknown) - see the call's goal field), outcome (agent/transferred/no_answer/other, see the Billing column of the kind table below; a gate ring, kind: "ring", is always other, even when its status is no_answer). Unknown parameters are ignored. Calls vs. conversations: GET /v1/calls returns individual call RECORDS - each phone leg is its own row. The portal's /en/calls table groups related legs (an inbound agent leg plus an outbound transfer leg) into one CONVERSATION - a successfully transferred call therefore shows as one row in the portal, but as up to two records via the API/MCP (the leg that performed the transfer has outcome: "transferred"; the receiving leg keeps its own outcome). Sum call counts from the API with that in mind.

get/v1/calls

Request

  • Base URL: https://volai.cz
  • URL: https://volai.cz/v1/calls
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of calls to return (1-200, default 50).

beforeinteger

Return only calls started strictly before this Unix epoch timestamp in milliseconds. Use nextBefore from the previous page to continue.

direction'in' | 'out'

Filter by call direction: in (incoming) or out (outgoing).

frominteger

Return only calls that started at or after this Unix epoch timestamp in milliseconds.

tointeger

Return only calls that started at or before this Unix epoch timestamp in milliseconds.

agentIdstring

Filter to calls handled by this agent.

flagged'true' | 'false'

Filter by whether the call was flagged (PATCH /v1/calls/{id} with flag set) - true or false.

goal'success' | 'failure' | 'unclear' | 'no_conversation' | 'not_evaluated' | 'unknown'

Filter by the agent's goal evaluation result for the call. unclear: the conversation happened, but the outcome could not be determined. no_conversation: the caller did not speak, voicemail or a voice menu answered, or the call did not connect. not_evaluated: no goal evaluation yet (no goal set, a different provider, or still pending). unknown is a coarser, backward-compatible filter for records with no clear result - goal.result is missing or unknown: always true for unclear and not_evaluated, and for no_conversation only when its result is also unknown - technical completion alone is not success.

outcome'agent' | 'transferred' | 'no_answer' | 'other'

Filter by a coarse outcome classification of the call RECORD (agent: connected and handled by the agent; transferred: bridged to a human; no_answer: not picked up; other: anything else, including a failed leg). A gate ring (kind: "ring") is always other, even when its status is no_answer. This is per record, not per conversation - see the note under the Calls response schema about calls vs. conversations.

Response

Calls

hasMoreboolean required
nextBeforenumber nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.