Call Management
Retrieve a live call
Fetch real-time state, direction, duration, and per-leg metadata for a single active Vobiz call by UUID using a GET request with status=live.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Call
/
{call_uuid}
Retrieve a live 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": "c9cab827-d7e6-4ab8-b521-f29e593a1c26",
"call_status": "in-progress",
"call_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"caller_name": "",
"direction": "outbound",
"from": "919262171438",
"request_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"session_start": "2026-06-11 16:03:28.586839",
"stir_attestation": "Not Applicable",
"stir_verification": "Not Applicable",
"to": "919148227303"
}GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/?status=live
This endpoint only returns data for calls currently in progress. For completed calls, use the standard call CDR endpoint instead.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
auth_id | string | Yes | Your Vobiz account ID |
call_uuid | string | Yes | Unique identifier of the live call |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Must be live to retrieve real-time call information |
The
status=live query parameter is required. Without it, the endpoint returns the finalized CDR (if the call ended) or a 404 error.Example request
cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/?status=live" \
-H "X-Auth-ID: YOUR_AUTH_ID" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
Response
200 OK
{
"api_id": "c9cab827-d7e6-4ab8-b521-f29e593a1c26",
"call_status": "in-progress",
"call_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"caller_name": "",
"direction": "outbound",
"from": "919262171438",
"request_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"session_start": "2026-06-11 16:03:28.586839",
"stir_attestation": "Not Applicable",
"stir_verification": "Not Applicable",
"to": "919148227303"
}
Response fields
| Field | Description |
|---|---|
api_id | Unique identifier for this API request |
call_status | Current state of the call (e.g. in-progress) |
call_uuid | Unique identifier of the live call |
caller_name | Caller ID name, if available (empty string otherwise) |
direction | Call direction: inbound or outbound |
from | Originating number |
request_uuid | Identifier of the request that initiated the call |
session_start | Timestamp when the call session started |
stir_attestation | STIR/SHAKEN attestation level, or Not Applicable |
stir_verification | STIR/SHAKEN verification result, or Not Applicable |
to | Destination number |
Poll this endpoint periodically to track a call’s status while it is in progress.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Your account Auth ID
Example:
"MA_XXXXXX"
Example:
"cdr_XXXXXXXXXX"
Query Parameters
Available options:
live, queued Response
200 - application/json
Live call details
Unique identifier for this API request
Current state of the call (e.g. in-progress)
Was this page helpful?
⌘I
Retrieve a live 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": "c9cab827-d7e6-4ab8-b521-f29e593a1c26",
"call_status": "in-progress",
"call_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"caller_name": "",
"direction": "outbound",
"from": "919262171438",
"request_uuid": "2ded13fe-4f9b-4958-9bfb-093ea2f29f91",
"session_start": "2026-06-11 16:03:28.586839",
"stir_attestation": "Not Applicable",
"stir_verification": "Not Applicable",
"to": "919148227303"
}