Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CDR detailed report request data

Request object for CDR detailed report

start_time
string<date-time>
required

Start time in ISO format

Example:

"2024-02-01T00:00:00Z"

end_time
string<date-time>
required

End time in ISO format

Example:

"2024-02-12T23:59:59Z"

timezone
string

Timezone for the report

Example:

"UTC"

call_types
integer<int32>[]

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

Example:
record_types
integer<int32>[]

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

Example:
connections
integer<int64>[]

List of connections to filter by

Example:
report_name
string

Name of the report

Example:

"My CDR Report"

source
string

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

Example:

"calls"

include_all_metadata
boolean

Whether to include all metadata

Example:

true

filters
object[]

List of filters to apply

fields
string[]

Set of fields to include in the report

Example:
managed_accounts
string<uuid>[]

List of managed accounts to include

Example:
select_all_managed_accounts
boolean

Whether to select all managed accounts

Example:

false

Response

CDR report request created successfully

data
object

Response object for CDR detailed report