Partner API

CDRs (Call History)

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.

Overview

The CDR API gives you read access to call logs for all customers under your partner account. Three endpoints cover different scopes:

/accounts/{id}/cdrs

Single customer

Filtered CDR log for one customer. Most common — use for per-customer billing and support tickets.

/accounts/{id}/cdrs/{uuid}

Single call

Deep forensic detail for one specific call by its UUID. Use for troubleshooting a specific incident.

/cdrs

All customers

Global traffic log across all accounts. Use for platform-wide quality monitoring and aggregate reporting.

Customer CDRs

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/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.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

Available Filters

Parameter	Type	Example	Description
page	integer	1	Page number (default: 1)
per_page	integer	20	Records per page (default: 20, max: 100)
start_date	string	2026-03-01	Filter calls from this date (YYYY-MM-DD)
end_date	string	2026-03-31	Filter calls up to this date (YYYY-MM-DD)
call_direction	string	inbound	"inbound" or "outbound"
status	string	answered	"answered", "no-answer", "busy", "failed"
from_number	string	9876543210	Filter by originating number
to_number	string	1234567890	Filter by destination number
hangup_cause	string	NORMAL_CLEARING	SIP hangup cause code
min_duration	integer	10	Minimum call duration in seconds
max_duration	integer	3600	Maximum call duration in seconds
search	string	9876	Free-text search across number fields
context	string	sip-trunking	Call context type — use "sip-trunking" for voice calls

Examples

Basic — Recent CDRs (no filters)

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs?page=1&per_page=20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Billing cycle — All calls in March 2026

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs?start_date=2026-03-01&end_date=2026-03-31&per_page=100" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Quality check — Answered inbound calls, min 10 seconds

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs?call_direction=inbound&status=answered&min_duration=10&start_date=2026-03-01&end_date=2026-03-31" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Troubleshoot — Failed calls by hangup cause

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs?status=failed&hangup_cause=NO_ANSWER&start_date=2026-03-20" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK — Response

{
  "data": [
    {
      "call_uuid": "abc123-def456-ghi789",
      "from_number": "+919876543210",
      "to_number": "+911234567890",
      "direction": "outbound",
      "status": "answered",
      "duration_seconds": 185,
      "hangup_cause": "NORMAL_CLEARING",
      "cost": 1.39,
      "currency": "INR",
      "start_time": "2026-03-25T10:30:00Z",
      "answer_time": "2026-03-25T10:30:08Z",
      "end_time": "2026-03-25T10:33:05Z",
      "trunk_id": "trunk_abc",
      "context": "sip-trunking"
    }
  ],
  "meta": {
    "total": 1284,
    "page": 1,
    "per_page": 20
  }
}

Get Specific CDR by UUID

GEThttps://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs/{call_uuid}

Returns complete detail for a single call identified by its UUID. Use 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.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs/abc123-def456-ghi789" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK — Full CDR detail

{
  "call_uuid": "abc123-def456-ghi789",
  "from_number": "+919876543210",
  "to_number": "+911234567890",
  "direction": "outbound",
  "status": "answered",
  "duration_seconds": 185,
  "ring_duration_seconds": 8,
  "hangup_cause": "NORMAL_CLEARING",
  "hangup_initiator": "caller",
  "cost": 1.39,
  "currency": "INR",
  "start_time": "2026-03-25T10:30:00Z",
  "answer_time": "2026-03-25T10:30:08Z",
  "end_time": "2026-03-25T10:33:05Z",
  "trunk_id": "trunk_abc",
  "trunk_name": "Vobiz India Trunk",
  "context": "sip-trunking",
  "sip_response_code": 200,
  "caller_id": "+919876543210",
  "account_auth_id": "MA_48149cf4"
}

All CDRs (Global)

GEThttps://api.vobiz.ai/api/v1/partner/cdrs

Global CDR log across all customer accounts under your partner umbrella in 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.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL — All customer CDRs

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/cdrs?page=1&per_page=50" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

cURL — All failed calls today

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/cdrs?status=failed&start_date=2026-03-25&per_page=100" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

CDR Response Fields

Field	Description
call_uuid	Unique identifier for this call. Use to retrieve the full CDR via the single-call endpoint.
from_number	Originating caller number in E.164 format
to_number	Dialed destination number in E.164 format
direction	"inbound" (call to your customer) or "outbound" (call from your customer)
status	"answered", "no-answer", "busy", or "failed"
duration_seconds	Actual connected call duration in seconds (0 if call was not answered)
hangup_cause	SIP hangup reason code (e.g. NORMAL_CLEARING, NO_ANSWER, CALL_REJECTED)
cost	Charge for this call in the account currency
start_time	When the call attempt began (ISO 8601, UTC)
answer_time	When the call was answered. Null if not answered.
end_time	When the call ended (ISO 8601, UTC)
trunk_id	SIP trunk used to route this call
context	Call context type — "sip-trunking" for voice calls

Use Cases

Per-customer billing

Pull CDRs for a customer for the billing period. Sum duration_seconds × per-minute-rate for your invoice calculation.

Call quality troubleshooting

When a customer reports poor call quality, pull the specific CDR by UUID. Check hangup_cause and sip_response_code for root cause.

No-answer rate monitoring

Filter by status=no-answer over 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.

Transactions

Phone Numbers