Skip to main content

​
Endpoint

GET /api/v1/calls
Retrieve a list of all active call sessions currently managed by the system, along with pending call IDs waiting to be processed.

​
Authentication

This endpoint requires admin authentication using the X-Admin-Token header.
​
X-Admin-Token
string
required
Admin authentication token configured in your environment settings

​
Response

Returns a JSON object containing active calls and pending call IDs.
​
calls
array
List of active call session objects
​
pending_call_ids
array
List of call IDs waiting to be accepted and started. These are calls that have been queued but not yet allocated to a call session.

​
Example Request

curl -X GET https://your-domain.com/api/v1/calls \
  -H "X-Admin-Token: your-admin-token"

​
Example Response

{
  "calls": [
    {
      "call_id": "call_abc123",
      "status": "RUNNING"
    },
    {
      "call_id": "call_def456",
      "status": "NEW"
    }
  ],
  "pending_call_ids": [
    "call_ghi789",
    "call_jkl012"
  ]
}

​
Use Cases

  • Monitoring: Track the number and status of active calls
  • Debugging: Identify calls stuck in specific states
  • Capacity Planning: See pending calls waiting for available capacity
  • System Health: Verify the call management system is processing requests

Build docs developers (and LLMs) love

Get started for freeTalk to us