Skip to main content

Create a CDR request

POST 

/reporting/cdr_requests

Check the status and retrieve a CDR with a call to: GET/reporting/cdr_requests/{id}

  • CDRs are available for 30 days
  • The filters field specifies a list of query criteria as follows:
'filters': [
\{
'filter_type': enum('and', 'or'),
'cli': string,
'cli_filter': enum('contains', 'starts_with', 'ends_with')
\},
\{
'filter_type': enum('and', 'or'),
'cld': string,
'cld_filter': enum('contains', 'starts_with', 'ends_with'),
\},
\{
'filter_type': enum('and', 'or'),
'tags_list': list of tag strings
\}
]

Note: The first object in the filter list must specify a filter_type of and. You can not follow an or with another and. Other than that, you can specify as many filters as you like in any order.

Request

Body

required

CDR Request to add

    start_time stringrequired

    UTC (2024-02-15T00:00:00+00:00)

    end_time string

    UTC (2024-02-15T19:11:03+00:00). Must be less than 24 hours from now

    call_types integer[]

    Default value: 1

    Inbound = 1, Outbound = 2

    record_types integer[]

    Default value: 1

    Complete = 1, Incomplete = 2, Errors = 3

    connections string[]

    Array of connection IDs

    report_name string
    source string

    Specifies the source of the CDR. Can be either 'calls' or 'call-control'

    filters string[]

Responses

200: CDR Request response

Schema

    id stringrequired
    start_time stringrequired

    UTC (2024-02-15T00:00:00+00:00)

    end_time stringrequired

    UTC (2024-02-15T19:11:03+00:00)

    call_types integer[]required

    Default value: 1

    Inbound = 1, Outbound = 2

    record_types integer[]required

    Default value: 1

    Complete = 1, Incomplete = 2, Errors = 3

    connections string[]required

    Array of connection IDs

    report_name stringrequired
    status integerrequired

    Default value: 1

    Pending = 1, Complete = 2, Failed = 3, Expired = 4

    report_url stringrequired

    Link to report

    filters stringrequired

    Search criteria

    created_at stringrequired
    updated_at stringrequired

400: Bad request

401: Unauthorized

Loading...