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
Retrieve a live call
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 |
Example request
cURL
Response
200 OK
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 |
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)