Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
CDR Reports

Create a new CDR report request

Creates a new CDR report request with the specified filters

post/legacy/reporting/batch_detail_records/voice

Request body

call_typesinteger[]

List of call types to filter by (Inbound = 1, Outbound = 2)

connectionsinteger[]

List of connections to filter by

end_timestring date-time required

End time in ISO format

fieldsstring[]

Set of fields to include in the report

include_all_metadataboolean

Whether to include all metadata

managed_accountsstring[]

List of managed accounts to include

record_typesinteger[]

List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)

report_namestring

Name of the report

select_all_managed_accountsboolean

Whether to select all managed accounts

sourcestring

Source of the report. Valid values: calls (default), call-control, fax-api, webrtc

start_timestring date-time required

Start time in ISO format

timezonestring

Timezone for the report

Example request

{
  "call_types": [
    1,
    2
  ],
  "connections": [
    123,
    456
  ],
  "end_time": "2024-02-12T23:59:59Z",
  "fields": [
    "call_leg_id",
    "start_time",
    "end_time"
  ],
  "filters": [
    {
      "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
      "cld": "+13129457420",
      "cli": "+13129457420",
      "tags_list": "tag1"
    }
  ],
  "include_all_metadata": true,
  "managed_accounts": [
    "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
  ],
  "record_types": [
    1,
    2
  ],
  "report_name": "My CDR Report",
  "source": "calls",
  "start_time": "2024-02-01T00:00:00Z",
  "timezone": "UTC"
}

Response

CDR report request created successfully

Example response

{
  "data": {
    "connections": [
      123,
      456
    ],
    "created_at": "2024-02-12T14:00:00Z",
    "end_time": "2024-02-12T23:59:59Z",
    "filters": [
      {
        "billing_group": "adfaa016-f921-4b6c-97bb-e4c1dad231c5",
        "cld": "+13129457420",
        "cli": "+13129457420",
        "tags_list": "tag1"
      }
    ],
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "managed_accounts": [
      "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
    ],
    "record_type": "cdr_detailed_report",
    "record_types": [
      1,
      2
    ],
    "report_name": "My Report",
    "start_time": "2024-02-01T00:00:00Z",
    "status": 1,
    "updated_at": "2024-02-12T14:05:00Z"
  }
}