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/{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 -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
{
"api_id": "c8b427f6-58ce-11e1-86da-adf28403fe48",
"calls": [
{
"answer_time": "2014-10-15 09:03:43",
"bill_duration": null,
"billed_duration": null,
"call_direction": "outbound",
"call_duration": 180,
"call_state": "ACTIVE",
"call_uuid": "97ceeb52-58b6-11e1-86da-77300b68f8bb",
"conference_uuid": null,
"end_time": null,
"from_number": "+14156667777",
"initiation_time": "2014-10-15 09:03:38",
"parent_call_uuid": null,
"hangup_cause_code": null,
"hangup_cause_name": null,
"hangup_source": null,
"to_number": "+14156667778",
"total_amount": null,
"total_rate": null,
"stir_verification": "verified",
"stir_attestation": "A",
"source_ip": "1.1.1.1"
}
]
}
Live-call-specific fields
| Field | Description |
|---|
call_state | Current state: RINGING, EARLY, ACTIVE, or HELD |
call_duration | Live call duration in seconds since answer_time |
end_time | Will be null for active calls |
billed_duration | Will be null until the call ends |
total_amount | Will be null until call ends and billing is calculated |
hangup_* | All hangup fields are null for active calls |
Call state values
| Value | Meaning |
|---|
RINGING | Call is ringing, not yet answered |
EARLY | Early media state (e.g., ringback tone playing) |
ACTIVE | Call is connected and in progress |
HELD | Call is on hold |
Poll this endpoint periodically to monitor live call metrics. Use call_duration to calculate current call costs in real-time.
