Skip to main content
GET
/
calls
List calls
curl --request GET \
  --url https://api.vocobase.com/api/v2/calls \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "calls": [
      {
        "call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "direction": "outbound",
        "from_number": "<string>",
        "to_number": "<string>",
        "status": "pending",
        "provider": "mcube",
        "duration_seconds": 123,
        "error_message": "<string>",
        "started_at": "2023-11-07T05:31:56Z",
        "ended_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Query Parameters

​
limit
integer
default:10

Number of calls to return.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of calls to skip.

Required range: x >= 0
​
status
enum<string>

Filter by call status (case-insensitive).

Available options:
pending,
ringing,
in_progress,
completed,
failed,
no_answer,
busy,
canceled

Response

List of calls.

​
success
boolean
​
data
object