Sign in

v1

latestOpenAPI 3.0.32026-07-246376162.1 KB
Reporting

Get list of CDRs

Returns a paginated list of Call Detail Records (CDRs). Use the cursor returned in metadata.next_cursor to continue fetching records beyond the first 10000 results. When cursor is not provided, pagination is limited to the first 10000 records using limit and offset.

get/api/v4/reporting/cdrs

Query parameters

limitinteger

The number of items to return.

offsetinteger

The number of items to skip before starting to collect the result set. Ignored when a valid cursor is provided.

cursorstring
Example:WzE3NDcwNDU1NjAwMDAsIjdkN2Y4Yzc0LWRhMDgtNGViMy1iNzc5LTQxMzY0YzEyOWQ4YSJd

Cursor returned in the previous response metadata as next_cursor. Treat this value as an opaque token and pass it back unchanged. If both cursor and offset are provided: a valid cursor takes priority and offset is ignored. If cursor is invalid, the API falls back to offset-based pagination. If the fallback offset is also invalid, the API returns 400 Bad Request.

'call' | 'conversation' | 'hlr_lookup' | 'sms'
OR
string[]

Filter by CDR type. Accepts a single value or an array.

string
OR
string[]

Filter by external account ID. Accepts a single value or an array.

'inbound' | 'outbound' | 'click_to_call' | 'dialer' | 'scheduled_callback' | 'queue_callback' | 'chat' | 'facebook' | 'instagram' | 'telegram' | 'viber' | 'whatsapp' | 'hlr_lookup' | 'outbound_sms'
OR
string[]

Filter by CDR subtype. Accepts a single value or an array.

'busy' | 'answered' | 'vm_answered' | 'machine_answered' | 'abandoned' | 'dialer_abandoned' | 'system_abandoned' | 'rejected' | 'system_rejected' | 'no_answer' | 'missed' | 'failed' | 'active' | 'archived' | 'initiated' | 'waiting' | 'available' | 'unavailable' | 'unknown' | 'sent' | 'delivered' | 'not_sent' | 'not_delivered' | 'route_unavailable'
OR
string[]

Filter by disposition. Accepts a single value or an array.

string
OR
string[]

Filter by wrap-up code. Accepts a single value or an array.

'agent' | 'busy' | 'customer' | 'dncr_failure' | 'dncr_restricted' | 'failed' | 'machine' | 'machine_answered' | 'manager' | 'no_answer' | 'rejected' | 'remote_party' | 'system_reject' | 'timeout'
OR
string[]

Filter by end reason. Accepts a single value or an array.

'monitor' | 'whisper' | 'barge_in' | 'intercept' | 'terminate' | 'forward' | 'consult_transfer' | 'blind_transfer' | 'all_transfers' | 'conference' | 'call_score'
OR
string[]

Filter by event tag. Accepts a single value or an array. Special value all_transfers expands to all transfer types.

string phone
OR
string[]

Filter by caller phone number. Accepts a single value or an array. Cannot be used with from_phone_number_like.

string phone
OR
string[]

Filter by destination phone number. Accepts a single value or an array of values. Cannot be used with to_phone_number_like.

from_phone_number_likestring

Filter by caller phone number pattern. Use * as a wildcard. Cannot be used with from_phone_number.

to_phone_number_likestring

Filter by destination phone number pattern. Use * as a wildcard. Cannot be used with to_phone_number.

string uuid
OR
string[]

Filter by source channel account ID. Accepts a single value or an array.

string uuid
OR
string[]

Filter by destination channel account ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by source channel profile ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by destination channel profile ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by user ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by team ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by queue ID. Accepts a single value or an array.

integer
OR
integer[]

Filter by campaign ID. Accepts a single value or an array.

string uuid
OR
string[]

Filter by related call ID. Accepts a single value or an array.

string
OR
string[]

Filter by destination country name. Accepts a single value or an array.

number float
OR
Example:4.5

Filter by conversation score or score range.

number float
OR
Example:120.5

Filter by overall duration (seconds) or by duration range.

number float
OR
Example:12.3

Filter by dialing duration (seconds) or by duration range.

number float
OR
Example:8.2

Filter by time spent in IVR (seconds) or by a duration range.

number float
OR
Example:25.7

Filter by time spent in queue (seconds) or by a duration range.

number float
OR
Example:180.4

Filter by time spent talking (seconds) or by a duration range.

number float
OR
Example:15.3

Filter by time spent on hold (seconds) or by a duration range.

string date-time
OR
Example:2024-01-01T00:00:00Z

Filter by start time or by start time range.

string date-time
OR
Example:2024-01-31T23:59:59Z

Filter by end time or by end time range.

Response

OK

Example response

{
  "cdrs": [
    {
      "id": "775a5558-59a6-4468-a502-0deef2a3315d",
      "type": "call",
      "subtype": "outbound",
      "from": {
        "type": "phone_number",
        "phone_number": "18885658889"
      },
      "to": {
        "type": "phone_number",
        "phone_number": "18885658889"
      },
      "account_id": "123321",
      "user": {
        "id": 1,
        "name": "Jane Doe",
        "email": "jane.doe@contactcenter.com",
        "name_snapshot": "Snapshot name"
      },
      "cost": "0.055",
      "tags": [
        "conference",
        "whisper"
      ],
      "started_at": "2020-08-19T11:32:43.413000Z",
      "ended_at": "2020-08-19T11:33:11.031000Z",
      "data": {
        "queue": {
          "id": 1,
          "name": "Technical Support",
          "name_snapshot": "Snapshot name"
        },
        "campaign": {
          "id": 9,
          "name": "Retention Outreach",
          "name_snapshot": "Snapshot name"
        },
        "destination_country": "France",
        "durations": {
          "overall": 27.618,
          "dialing": 5.783,
          "queue": 10.796,
          "talk": 21.835
        },
        "end_reason": "customer",
        "wrapup_code": {
          "code_snapshot": "0000"
        },
        "summary": "The agent called the customer to follow up on a previous inquiry.",
        "conversation_score": 3.3,
        "mos": 4.37,
        "mos_tc": 3.9
      }
    }
  ],
  "metadata": {
    "total": 100
  }
}