Retrieve a queued call

GET

api

Account

{auth_id}

Call

{call_uuid}

Retrieve a queued call

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/ \
  --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/{call_uuid}/"

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/{call_uuid}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "api_id": "45223222-74f8-11e1-8ea7-12313806be9a",
  "call_status": "queued",
  "call_uuid": "6653422-91b6-4716-9fad-9463daaeeec2",
  "request_uuid": "6653422-91b6-4716-9fad-9463daaeeec2",
  "caller_name": "+15856338537",
  "direction": "outbound",
  "from": "15856338537",
  "to": "14154290945"
}

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/?status=queued

Retrieve information about a call that has been initiated but is not yet connected. Queued calls are waiting for the destination to answer or for resources to become available.

A call is in the “queued” state when it has been initiated via the API but has not been answered yet, including calls waiting for the destination to ring or answer.

Path parameters

Parameter	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz account ID
`call_uuid`	string	Yes	Unique identifier of the queued call

Query parameters

Parameter	Type	Required	Description
`status`	string	Yes	Must be `queued` to retrieve queued call details

If the call is no longer queued (connected or ended), this endpoint returns a 404 error. Use the standard CDR endpoint for completed calls.

Example request

cURL

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

Response

200 OK

{
  "direction": "outbound",
  "from": "15856338537",
  "call_status": "queued",
  "api_id": "45223222-74f8-11e1-8ea7-12313806be9a",
  "to": "14154290945",
  "caller_name": "+15856338537",
  "call_uuid": "6653422-91b6-4716-9fad-9463daaeeec2",
  "request_uuid": "6653422-91b6-4716-9fad-9463daaeeec2"
}

Field	Description
`api_id`	Unique identifier for this API request
`call_status`	Always `queued` for this endpoint
`call_uuid`	Unique identifier for the call
`request_uuid`	Request identifier (same as `call_uuid`)
`direction`	Call direction: `outbound` or `inbound`
`from`	Source phone number
`to`	Destination phone number
`caller_name`	Caller ID name

Combine this endpoint with Retrieve All Queued Calls to monitor all pending calls on your account at once.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

call_uuid

string

required

Example:

"cdr_XXXXXXXXXX"

Query Parameters

status

enum<string>

default:queued

required

Available options:

live,

queued

Response

200 - application/json

Queued call details

api_id

string

required

Unique identifier for this API request

call_status

string

required

Always queued for this endpoint

call_uuid

string

required

request_uuid

string

required

caller_name

string

required

direction

string

required

from

string

required

string

required

Retrieve a queued call

curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/ \
  --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/{call_uuid}/"

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/{call_uuid}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "api_id": "45223222-74f8-11e1-8ea7-12313806be9a",
  "call_status": "queued",
  "call_uuid": "6653422-91b6-4716-9fad-9463daaeeec2",
  "request_uuid": "6653422-91b6-4716-9fad-9463daaeeec2",
  "caller_name": "+15856338537",
  "direction": "outbound",
  "from": "15856338537",
  "to": "14154290945"
}

​Path parameters

​Query parameters

​Example request

​Response

Authorizations

Path Parameters

Query Parameters

Response

Path parameters

Query parameters

Example request

Response