Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?status=queued
Returns an array of call UUIDs for all calls currently in the queued state. Maximum 20 results per request.
Calls are in the “queued” state when they have been initiated but are waiting to be connected - either waiting for the destination to ring or for resources to become available.

​
Path parameters

ParameterTypeRequiredDescription
auth_idstringYesYour Vobiz account ID

​
Query parameters

ParameterTypeRequiredDescription
statusstringYesMust be set to queued to retrieve queued calls
This endpoint returns a maximum of 20 call UUIDs per request. Poll periodically if you have more than 20 queued calls.

​
Example request

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?status=queued" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Response

200 OK
{
  "api_id": "c9527676-5839-11e1-86da-6ff39efcb949",
  "calls": [
    "eac94337-b1cd-499b-82d1-b39bca50dc31",
    "0a70a7fb-168e-4944-a846-4f3f4d2f96f1"
  ]
}
FieldDescription
api_idUnique identifier for this API request
callsArray of call UUIDs for all queued calls (max 20)

​
Common 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.
Use the returned call UUIDs with Retrieve a Queued Call to get details on each one, or use the Hang Up Call endpoint to cancel them.