Endpoints
CDRs (Call History)
Fetch full call detail records for every voice session across your Vobiz partner ecosystem - filter by date, direction, or hangup cause for billing and quality review.
GET
List customer CDRs
← Partner API Reference
Full call detail records for every voice session across your partner ecosystem. Filter by date range, direction, hangup cause, number, and more. Essential for billing reconciliation, call quality troubleshooting, and traffic monitoring.
All Partner API requests use
X-Auth-ID and X-Auth-Token headers. See Authentication for details.Overview
The CDR API gives you read access to call logs for all customers under your partner account. Three endpoints cover different scopes:- Customer CDRs - Filtered CDR log for one customer. Most common - use for per-customer billing and support tickets.
- Single CDR by UUID - Deep forensic detail for one specific call by its UUID. Use for troubleshooting a specific incident.
- All CDRs (Global) - Global traffic log across all accounts. Use for platform-wide quality monitoring and aggregate reporting.
Customer CDRs
Returns a paginated CDR log for one specific customer. All filter parameters are optional - omit all to get the most recent calls paginated by default.Available Filters
| Parameter | Type | Example | Description |
|---|---|---|---|
page | integer | 1 | Page number (1-indexed) |
per_page | integer | 20 | Items per page (max 100) |
start_date | string | 2026-03-01 | Start of date range, YYYY-MM-DD |
end_date | string | 2026-03-31 | End of date range, YYYY-MM-DD |
call_direction | string | inbound | inbound or outbound |
status | string | answered | answered, failed, busy, no_answer |
hangup_cause | string | NO_ANSWER | SIP/Q.850 hangup cause, e.g. NORMAL_CLEARING, NO_ANSWER, USER_BUSY |
min_duration | integer | 10 | Minimum call duration in seconds |
The date filters here are
start_date / end_date (CDRs), not from_date / to_date as used by the Transactions endpoint. Status values are underscored: no_answer, not no-answer.Examples
Response
Get Specific CDR by UUID
Returns complete detail for a single call identified by its UUID. Use this when a customer reports a specific call issue - pass the call UUID from their system or from a previous CDR list query. This endpoint exposes the full call metadata, including SIP response codes and media quality indicators where available.All CDRs (Global)
Global CDR log across all customer accounts under your partner umbrella, returned as a single paginated response. Supports all the same filter parameters as the per-customer endpoint. Use for platform-wide traffic monitoring and identifying customers with unusual call patterns.Response shape
The list response wraps the records in a fixed envelope:| Field | Notes |
|---|---|
success | Always true on a 200. |
account_id / account_auth_id | The customer the CDRs belong to. |
count | Number of records in this page’s data array. |
data[] | The CDR rows. Key per-row fields: uuid, call_direction, caller_id_number, destination_number, duration (total seconds), billsec (billable seconds), cost / total_cost, hangup_cause, mos (call quality), start_time / answer_time / end_time. |
pagination | page, per_page, total, pages, has_next, has_prev. |
summary | Window aggregates: totalCalls, answeredCalls, answerRate, avgCallDuration, total_billable_seconds, total_duration_seconds, total_cost, last_call_at. |
For billing, multiply each row’s
billsec (billable seconds), not raw duration, by your per-minute rate - or simply read summary.total_cost, which Vobiz has already computed at the customer’s pricing tier.Use Cases
- Per-customer billing - Pull CDRs for a customer for the billing period. Use
summary.total_costfor the period total, or sumbillsecacross rows if you apply your own markup. - Call quality troubleshooting - When a customer reports poor call quality, pull the specific CDR by UUID. Check
hangup_cause,mos,jitter, andpacket_lossfor the root cause. - No-answer rate monitoring - Filter by
status=no_answerover the past 7 days. High no-answer rates indicate number configuration issues or customer routing problems. - Fraud detection - Watch for abnormal call volumes or unusual call durations in the global CDR feed. Spikes in short-duration outbound calls can indicate robocalling abuse.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Path Parameters
Query Parameters
Available options:
inbound, outbound Available options:
answered, failed, busy, no_answer Example:
"NO_ANSWER"