Skip to main content
GET
Export CDRs

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Query Parameters

from
string<date>
required

Start of the date range to query, in YYYY-MM-DD format. Inclusive.

Example:

"2023-01-01"

to
string<date>
required

End of the date range to query, in YYYY-MM-DD format. Inclusive.

Example:

"2023-09-01"

type
string
required

Filters CDRs by call direction. One of placed (outbound calls dialed by the account) or received (inbound calls answered by the account).

Example:

"received"

disposition
enum<string>

Filters CDRs by call disposition. One of answered (the called party answered), busy (the called party was busy), rejected (the call was declined), failed (the call could not be routed), or all (no disposition filter). Final disposition of the call. One of answered (the called party answered), noanswer (no answer within the ring timeout), busy (the called party was busy), failed (the call could not be routed), or all (matches any disposition when used as a filter).

Available options:
answered,
noanswer,
busy,
failed,
all

Filters CDRs by originating phone number. Accepts a full or partial number.

Example:

"13524815863"

Filters CDRs by destination phone number. Accepts a full or partial number.

Example:

"12565378257"

sip_trunk
string

Filters outbound CDRs by SIP trunk login. Ignored for inbound calls.

Example:

"12321"

uuid
string

Filters CDRs by the unique call ID.

Example:

"99df5ffd-962a-410f-bcce-d08f1f7f328c"

page
integer<int32>

Page number to retrieve. Default 1.

Example:

1

per_page
integer<int32>
default:25

Number of records to return per page. Default 25.

Example:

25

Response

Returns an NDJSON stream of CDRs, one record per line.

NDJSON stream of CDR records, one per line.