v1
latestOpenAPI 3.0.32026-07-14490228.1 KBGet Calls
This endpoint retrieves all calls available to the client.
get/calls
Query parameters
pageinteger
The current page of results to retrieve.
per_pageinteger
The number of results to pull back. Allowed values: 25, 50, 100, -1 (for all).
sortstring
The order for record sorting. Allowed values are asc and desc.
orderstring
The field for sorting records. Allowed values: id, name, scope, type, length, status.
searchstring
A value to search the sender and recipient number fields by for the request.
search_number_idsinteger[]
The associated number IDs to filter by.
search_directionsstring[]
The call directions to filter by. Allowed values are inbound, outbound, outbound-api, and outbound-dial.
search_statusesstring[]
The call status to filter by. Allowed values are queued, ringing, in-progress, completed, canceled, busy, failed, and no-answer.
Response
200
Example response
{
"data": [
{
"id": 1,
"call_sid": "CA37d892355f32bb0e7dcc106b1d661124",
"sender_number": "+15555555551",
"recipient_number": "+15555555555",
"person_id": 1,
"number_id": 1,
"direction": "outbound-api",
"status": "completed",
"sequence_number": 3,
"duration": 1,
"client_id": 1,
"created_at": "2021-06-23 21:59:04",
"updated_at": "2021-06-23 21:59:29"
}
],
"meta": {
"total": 1,
"count": 1,
"page": 1,
"pages": 1,
"per_page": 25,
"order": "id",
"sort": "desc"
}
}