Call Detail Records (CDR)

Retrieve detailed call logs and usage data for your account.

The Call Detail Records (CDR) API endpoint allows you to fetch comprehensive call logs for your account. This includes information about call participants, duration, status, costs, timestamps, and more. CDR data is essential for billing reconciliation, usage analytics, and compliance reporting.

Use Cases: CDRs are commonly used for billing verification, traffic analysis, fraud detection, and generating usage reports. You can filter records by date range and paginate through large datasets efficiently.

HTTP Request

GEThttps://api.vobiz.ai/api/v1/account/{ACCOUNT_ID}/cdr

Authentication Required:

• X-Auth-ID: Your account ID (e.g., MA_BN2MZ1VV)
• X-Auth-Token: Your account Auth Token
• Content-Type: application/json

Query Parameters

URL Parameters

Name	Type	Description
`ACCOUNT_ID`Required	string	Your unique Vobiz account identifier (e.g., MA_BN2MZ1VV). Must match your X-Auth-ID header.

Query String Parameters

Name	Type	Description
`start_date`Required	string (YYYY-MM-DD)	The beginning of the search period in YYYY-MM-DD format (e.g., 2025-12-31).
`end_date`Required	string (YYYY-MM-DD)	The end of the search period in YYYY-MM-DD format (e.g., 2026-01-23).
`per_page`	integer	Number of records to return per request. Useful for pagination (default: 20, max: 100).
`page`	integer	The specific page of results to view. Use for navigating through paginated results (default: 1).
`context`Required	string	The underlying engine context. Use "kamailio" for standard CDR queries.

Response

A successful request returns a 200 OK status with a JSON body containing an array of call objects.

Success Response - 200 OK

{
  "data": [
    {
      "call_id": "abc123-def456-ghi789",
      "from_number": "+912271264217",
      "to_number": "+919876543210",
      "direction": "outbound",
      "duration": 125,
      "status": "completed",
      "start_time": "2026-01-23T10:30:00Z",
      "end_time": "2026-01-23T10:32:05Z",
      "cost": 0.05,
      "currency": "USD",
      "trunk_id": "e3e55a78-1234-5678-90ab-cdef12345678",
      "caller_id": "+912271264217",
      "hangup_cause": "NORMAL_CLEARING"
    },
    {
      "call_id": "xyz789-uvw456-rst123",
      "from_number": "+919876543210",
      "to_number": "+912271264217",
      "direction": "inbound",
      "duration": 45,
      "status": "completed",
      "start_time": "2026-01-23T09:15:00Z",
      "end_time": "2026-01-23T09:15:45Z",
      "cost": 0.02,
      "currency": "USD",
      "trunk_id": "e3e55a78-1234-5678-90ab-cdef12345678",
      "caller_id": "+919876543210",
      "hangup_cause": "NORMAL_CLEARING"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 20,
    "total_records": 150,
    "total_pages": 8
  }
}

Response Fields

• call_id - Unique identifier for the call
• from_number / to_number - Call participants
• duration - Length of the call in seconds
• status - Call status (e.g., "completed", "no-answer", "busy", "failed")
• cost - Price of the call (if applicable)
• direction - "inbound" or "outbound"
• hangup_cause - Reason for call termination

Examples

cURL - Fetch CDR for Date Range

cURL Request

curl -X GET "https://api.vobiz.ai/api/v1/account/{ACCOUNT_ID}/cdr?start_date=2025-12-31&end_date=2026-01-23&per_page=20&page=1" \
  -H "X-Auth-ID: {ACCOUNT_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json"

Generic Template (Use Your Own Values)

cURL Template

curl -X GET "https://api.vobiz.ai/api/v1/account/{ACCOUNT_ID}/cdr?start_date={YYYY-MM-DD}&end_date={YYYY-MM-DD}&per_page={LIMIT}&page={PAGE_NUMBER}" \
  -H "X-Auth-ID: {ACCOUNT_ID}" \
  -H "X-Auth-Token: {AUTH_TOKEN}" \
  -H "Content-Type: application/json"

Parameter Quick Reference

Parameter	Example	Description
`start_date`	2025-12-31	Beginning of search period (YYYY-MM-DD)
`end_date`	2026-01-23	End of search period
`per_page`	20	Records per request (pagination)
`page`	1	Page number to view

Quick Tips:

• Date Format: Always use YYYY-MM-DD format for dates
• Pagination: Use per_page and page for large datasets
• Date Range: Limit your date range to avoid timeouts on large datasets

Common Use Cases:

• Billing Reconciliation: Verify call costs against invoices
• Traffic Analysis: Analyze call patterns and peak usage times
• Fraud Detection: Monitor for unusual calling patterns
• Compliance Reporting: Generate call logs for regulatory requirements
• Usage Reports: Create detailed usage reports for customers

Recording Overview

Error Handling