List the Calls of the key's environment
GET /v1/calls
| Property | Value |
|---|---|
| Operation | list_calls |
| Group | Calls |
| Scope | calls:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A metadata read; no Call content is returned. |
| Released in | 1.0.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Newest first, with keyset pagination. From 1.21.0 the list filters by status, Phone number, direction and a creation range besides the Agent (FR-calls-9); filters combine, and a cursor is valid only with the filters it was issued under. The answer carries no total count.
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/calls" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/calls`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/calls",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | no | The page size, 1 to 100. |
cursor | query | string | no | The opaque next_cursor of the previous page; it binds the filters it was issued under. |
agent_id | query | AgentId | no | Only the Calls of this Agent (1.10.0). |
status | query | CallStatus | no | Only the Calls in this status (1.21.0). |
phone_number_id | query | PhoneNumberId | no | Only the phone Calls on this Phone number (1.21.0): the number an inbound Call reached, or the number an outbound Call dialled from. A web Call has no Phone number, so it never matches. |
direction | query | CallDirection | no | Only the inbound Calls or only the outbound Calls (1.21.0). |
purpose | query | CallPurpose | no | Only the Calls of this purpose (1.58.0): evaluation, the Calls of evaluation suite runs and conversation test runs; conversation, every other Call. Absent: every Call. |
created_after | query | RequestTimestamp | no | Only the Calls created at or after this instant (1.21.0); the start of the range is inclusive. |
created_before | query | RequestTimestamp | no | Only the Calls created before this instant (1.21.0); the end of the range is exclusive. |
contact_id | query | ContactId | no | Only the Calls of this Contact (1.61.0). |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | CallList | |
400 | application/json | ErrorEnvelope | invalid_request, invalid_cursor |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is CallList.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of Call | yes | The Calls of this page, newest first. |
has_more | boolean | yes | True when a further page exists. |
next_cursor | string or null | yes | The cursor of the next page, or null on the last page. |
object | "list" | yes |