Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Call Management

Retrieve All Queued Calls

Get a list of all call UUIDs for calls that are currently queued and waiting to connect.

This endpoint returns an array of call UUIDs for all calls currently in the queued state. The maximum number of results returned per API call is 20.

What are Queued Calls? Calls are in the "queued" state when they have been initiated but are waiting to be connected. This includes calls waiting for the destination to answer or for available resources.

Use Case: Monitor queue depth, identify calls stuck in queue, or perform bulk operations on pending calls.

HTTP Request

GET/api/v1/account/{accountId}/call/?status=queued

Path Parameters

accountIdstringRequired

Your Vobiz account ID

Query Parameters

statusstringRequired

Must be set to "queued" to retrieve queued calls

Limit: This endpoint returns a maximum of 20 call UUIDs per request. If you have more than 20 queued calls, you may need to poll this endpoint periodically.

Response

Returns an array of call UUIDs for all queued calls.

Response - 200 OK
{
  "api_id": "c9527676-5839-11e1-86da-6ff39efcb949",
  "calls": [
    "eac94337-b1cd-499b-82d1-b39bca50dc31",
    "0a70a7fb-168e-4944-a846-4f3f4d2f96f1"
  ]
}

Response Fields

api_id - Unique identifier for this API request
calls - Array of call UUIDs for all queued calls (max 20)

Example Request

Retrieve All Queued Calls

Request
GET /api/v1/account/MA2025RK4E639VJFZAGV/call/?status=queued

Headers:
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"
Content-Type: application/json

Use Cases

  • •Monitor queue depth and detect call backlogs
  • •Identify calls stuck in queue for troubleshooting
  • •Build queue management dashboards
  • •Cancel all queued calls in bulk during maintenance
  • •Track average time calls spend in queue

Tip: Use the returned call UUIDs with the Retrieve a Queued Call endpoint to get detailed information about each queued call, or use the Hang Up a Call endpoint to cancel them.

Retrieve a Queued Call
Record Calls