Skip to main content
GET
/
api
/
v1
/
partner
/
accounts
/
{customer_auth_id}
/
cdrs
List customer CDRs
curl --request GET \
  --url https://api.vobiz.ai/api/v1/partner/accounts/{customer_auth_id}/cdrs \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "success": true,
  "account_id": "MA_XXXXXXXX",
  "account_auth_id": "MA_XXXXXXXX",
  "count": 2,
  "data": [
    {
      "account_id": "MA_XXXXXXXX",
      "answer_time": "2026-03-25T06:59:31Z",
      "billsec": 1,
      "bridge_uuid": "aabbccdd-1234-5678-90ab-cdef12345678",
      "call_direction": "outbound",
      "caller_id_name": "Acme Corp",
      "caller_id_number": "+918012345678",
      "campaign_id": null,
      "carrier_ip": null,
      "codec": "PCMU",
      "context": "voice-api",
      "cost": 0.3,
      "created_at": "2026-03-25T06:59:32Z",
      "currency": "INR",
      "customer_endpoint": null,
      "destination_number": "+919876543210",
      "duration": 6,
      "end_time": "2026-03-25T06:59:32Z",
      "failure_code": null,
      "failure_reason": null,
      "hangup_cause": "NORMAL_CLEARING",
      "hangup_cause_code": 4000,
      "hangup_cause_name": "Normal Hangup",
      "hangup_disposition": "send_bye",
      "hangup_source": "Caller",
      "id": 18600001,
      "jitter": 0,
      "mos": 4.5,
      "network_addr": "3.110.99.6",
      "origination_region": "mumbai",
      "packet_loss": 0,
      "progress_time": "2026-03-25T06:59:26Z",
      "region": "ap-south-1",
      "ring_time": 5,
      "sip_call_id": "11223344-1234-5678-90ab-cdef12345678",
      "sip_user_agent": "Vobiz",
      "start_time": "2026-03-25T06:59:26Z",
      "streaming_cost": 0,
      "terminated_to": null,
      "total_cost": 0.3,
      "trunk_id": null,
      "updated_at": "2026-03-25T06:59:32Z",
      "uuid": "55667788-1234-5678-90ab-cdef12345678"
    },
    {
      "account_id": "MA_XXXXXXXX",
      "answer_time": "2026-03-25T07:10:11Z",
      "billsec": 4,
      "bridge_uuid": "99887766-1234-5678-90ab-cdef12345678",
      "call_direction": "inbound",
      "caller_id_name": "+919876543210",
      "caller_id_number": "+919876543210",
      "campaign_id": null,
      "carrier_ip": null,
      "codec": "PCMU",
      "context": "voice-api",
      "cost": 0.45,
      "created_at": "2026-03-25T07:10:15Z",
      "currency": "INR",
      "customer_endpoint": null,
      "destination_number": "+918012345678",
      "duration": 9,
      "end_time": "2026-03-25T07:10:15Z",
      "failure_code": null,
      "failure_reason": null,
      "hangup_cause": "NORMAL_CLEARING",
      "hangup_cause_code": 4010,
      "hangup_cause_name": "End Of XML Instructions",
      "hangup_disposition": "send_bye",
      "hangup_source": "Vobiz",
      "id": 18600002,
      "jitter": 0,
      "mos": 4.5,
      "network_addr": "13.203.7.132",
      "origination_region": "mumbai",
      "packet_loss": 0,
      "progress_time": "2026-03-25T07:10:06Z",
      "region": "ap-south-1",
      "ring_time": 5,
      "sip_call_id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "sip_user_agent": "Vobiz",
      "start_time": "2026-03-25T07:10:06Z",
      "streaming_cost": 0,
      "terminated_to": null,
      "total_cost": 0.45,
      "trunk_id": null,
      "updated_at": "2026-03-25T07:10:15Z",
      "uuid": "aabbccdd-9999-5678-90ab-cdef12345678"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 2,
    "pages": 1,
    "has_next": false,
    "has_prev": false
  },
  "summary": {
    "answerRate": 100,
    "answeredCalls": 2,
    "avgCallDuration": "7s",
    "last_call_at": "2026-03-25T07:10:15Z",
    "totalCalls": 2,
    "total_billable_seconds": 15,
    "total_cost": 1,
    "total_duration_seconds": 15
  }
}

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.

← 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

ParameterTypeExampleDescription
pageinteger1Page number (1-indexed)
per_pageinteger20Items per page (max 100)
start_datestring2026-03-01Start of date range, YYYY-MM-DD
end_datestring2026-03-31End of date range, YYYY-MM-DD
call_directionstringinboundinbound or outbound
statusstringansweredanswered, failed, no-answer, busy
hangup_causestringNORMAL_CLEARINGSIP/Q.850 hangup cause
min_durationinteger10Minimum call duration in seconds

Examples

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"
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"
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"
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"

Response

{
  "success": true,
  "account_id": "MA_XXXXXXXX",
  "account_auth_id": "MA_XXXXXXXX",
  "count": 2,
  "data": [
    {
      "account_id": "MA_XXXXXXXX",
      "answer_time": "2026-03-25T10:00:08Z",
      "billsec": 177,
      "bridge_uuid": "aabbccdd-1234-5678-90ab-cdef12345678",
      "call_direction": "outbound",
      "caller_id_name": "John Doe",
      "caller_id_number": "+919876543210",
      "campaign_id": null,
      "carrier_ip": "10.0.0.1",
      "codec": "PCMU",
      "context": "voice-api",
      "cost": 0.45,
      "created_at": "2026-03-25T10:03:05Z",
      "currency": "INR",
      "customer_endpoint": null,
      "destination_number": "+918012345678",
      "duration": 185,
      "end_time": "2026-03-25T10:03:05Z",
      "failure_code": null,
      "failure_reason": null,
      "hangup_cause": "NORMAL_CLEARING",
      "hangup_cause_code": 4000,
      "hangup_cause_name": "Normal Hangup",
      "hangup_disposition": "send_bye",
      "hangup_source": "Caller",
      "id": 18000000,
      "jitter": 2,
      "mos": 4.5,
      "network_addr": "10.0.0.2",
      "origination_region": "mumbai",
      "packet_loss": 0,
      "progress_time": "2026-03-25T10:00:00Z",
      "region": "ap-south-1",
      "ring_time": 8,
      "sip_call_id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "sip_user_agent": "Vobiz",
      "start_time": "2026-03-25T10:00:00Z",
      "streaming_cost": 0,
      "terminated_to": null,
      "total_cost": 0.45,
      "trunk_id": null,
      "updated_at": "2026-03-25T10:03:05Z",
      "uuid": "aabbccdd-1234-5678-90ab-cdef12345678"
    },
    {
      "account_id": "MA_XXXXXXXX",
      "answer_time": "2026-03-25T11:15:04Z",
      "billsec": 42,
      "bridge_uuid": "11223344-5566-7788-99aa-bbccddeeff00",
      "call_direction": "outbound",
      "caller_id_name": "",
      "caller_id_number": "+919876543210",
      "campaign_id": null,
      "carrier_ip": "10.0.0.1",
      "codec": "PCMU",
      "context": "voice-api",
      "cost": 0.12,
      "created_at": "2026-03-25T11:15:46Z",
      "currency": "INR",
      "customer_endpoint": null,
      "destination_number": "+918012345678",
      "duration": 46,
      "end_time": "2026-03-25T11:15:46Z",
      "failure_code": null,
      "failure_reason": null,
      "hangup_cause": "NORMAL_CLEARING",
      "hangup_cause_code": 4000,
      "hangup_cause_name": "Normal Hangup",
      "hangup_disposition": "send_bye",
      "hangup_source": "Callee",
      "id": 18000001,
      "jitter": 1,
      "mos": 4.4,
      "network_addr": "10.0.0.2",
      "origination_region": "mumbai",
      "packet_loss": 0,
      "progress_time": "2026-03-25T11:15:00Z",
      "region": "ap-south-1",
      "ring_time": 4,
      "sip_call_id": "11223344-5566-7788-99aa-bbccddeeff00",
      "sip_user_agent": "Vobiz",
      "start_time": "2026-03-25T11:15:00Z",
      "streaming_cost": 0,
      "terminated_to": null,
      "total_cost": 0.12,
      "trunk_id": null,
      "updated_at": "2026-03-25T11:15:46Z",
      "uuid": "11223344-5566-7788-99aa-bbccddeeff00"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1284,
    "pages": 65,
    "has_next": true,
    "has_prev": false
  },
  "summary": {
    "answerRate": 48.2,
    "answeredCalls": 619,
    "avgCallDuration": "28s",
    "last_call_at": "2026-03-25T11:15:00Z",
    "totalCalls": 1284,
    "total_billable_seconds": 17428,
    "total_cost": 312.85,
    "total_duration_seconds": 35952
  }
}

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.
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"
{
  "account_id": "MA_XXXXXXXX",
  "answer_time": "2026-03-25T10:00:08Z",
  "billsec": 177,
  "bridge_uuid": "aabbccdd-1234-5678-90ab-cdef12345678",
  "call_direction": "outbound",
  "caller_id_name": "John Doe",
  "caller_id_number": "+919876543210",
  "campaign_id": null,
  "carrier_ip": "10.0.0.1",
  "codec": "PCMU",
  "context": "voice-api",
  "cost": 0.45,
  "created_at": "2026-03-25T10:03:05Z",
  "currency": "INR",
  "customer_endpoint": null,
  "destination_number": "+918012345678",
  "duration": 185,
  "end_time": "2026-03-25T10:03:05Z",
  "failure_code": null,
  "failure_reason": null,
  "hangup_cause": "NORMAL_CLEARING",
  "hangup_cause_code": 4000,
  "hangup_cause_name": "Normal Hangup",
  "hangup_disposition": "send_bye",
  "hangup_source": "Caller",
  "id": 18000000,
  "jitter": 2,
  "mos": 4.5,
  "network_addr": "10.0.0.2",
  "origination_region": "mumbai",
  "packet_loss": 0,
  "progress_time": "2026-03-25T10:00:00Z",
  "region": "ap-south-1",
  "ring_time": 8,
  "sip_call_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "sip_user_agent": "Vobiz",
  "start_time": "2026-03-25T10:00:00Z",
  "streaming_cost": 0,
  "terminated_to": null,
  "total_cost": 0.45,
  "trunk_id": null,
  "updated_at": "2026-03-25T10:03:05Z",
  "uuid": "aabbccdd-1234-5678-90ab-cdef12345678"
}

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.
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 -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"

Use Cases

  • Per-customer billing - Pull CDRs for a customer for the billing period. Multiply duration_seconds by your per-minute rate for invoice calculations.
  • Call quality troubleshooting - When a customer reports poor call quality, pull the specific CDR by UUID. Check hangup_cause and sip_response_code for the 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.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

customer_auth_id
string
required

Query Parameters

start_date
string<date>
end_date
string<date>
call_direction
enum<string>
Available options:
inbound,
outbound
status
enum<string>
Available options:
answered,
failed,
busy,
no_answer
min_duration
integer
hangup_cause
string
Example:

"NO_ANSWER"

per_page
integer
default:20

Response

200 - application/json

Customer CDRs

account_id
string
required
count
integer
required
data
array
required
pagination
object
required
success
boolean
required
summary
object
required
account_auth_id
string
required