Call Management
Retrieve all queued calls
List UUIDs for all pending outbound calls on your Vobiz account waiting to connect - returns up to 20 queued calls per request for full queue visibility.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
List queued calls
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"api_id": "c9527676-5839-11e1-86da-6ff39efcb949",
"calls": [
"eac94337-b1cd-499b-82d1-b39bca50dc31",
"0a70a7fb-168e-4944-a846-4f3f4d2f96f1"
]
}GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/?status=queued
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
| Parameter | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your Vobiz account ID |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Must 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"
]
}
| Field | Description |
|---|---|
api_id | Unique identifier for this API request |
calls | Array 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.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Query Parameters
Available options:
live, queued Was this page helpful?
⌘I
List queued calls
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"api_id": "c9527676-5839-11e1-86da-6ff39efcb949",
"calls": [
"eac94337-b1cd-499b-82d1-b39bca50dc31",
"0a70a7fb-168e-4944-a846-4f3f4d2f96f1"
]
}