WAwavix
CDRs

List CDRs

Changed on

Returns a paginated list of call detail records for the authenticated account, within the requested date range.

get/v1/cdrs

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v1/cdrs
  • Auth
    HTTP bearer

Query parameters

fromstring date required
Example:2023-01-01

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

tostring date required
Example:2023-09-01

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

typestring required
Example:received

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

disposition'answered' | 'noanswer' | 'busy' | 'failed' | 'all'

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).

Filters CDRs by call disposition. 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 (no disposition filter).

from_searchstring
Example:13524815863

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

to_searchstring
Example:12565378257

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

sip_trunkstring
Example:12321

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

uuidstring
Example:99df5ffd-962a-410f-bcce-d08f1f7f328c

Filters CDRs by the unique call ID.

pageinteger
Example:1

Page number to retrieve. Default 1.

per_pageinteger
Example:25

Number of records to return per page. Default 25.

Response

Returns a paginated list of CDRs.

Example response

{
  "items": [
    {
      "date": "2023-08-21T06:43:36.000Z",
      "from": "14302287001",
      "to": "33170363950",
      "duration": 6,
      "destination": "France",
      "per_minute": "0.027",
      "charge": "0.822",
      "sip_trunk": "32882",
      "forward_fee": "0.0",
      "uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "call_id": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "parent_uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "parent_call_id": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "answered_by": "human"
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Changes

  • d4db3aae3627Revision changes
    • breaking

      the query request parameter disposition was restricted to a list of enum values

    • info

      added the new enum value all to the query request parameter disposition

    • info

      added the new enum value answered to the query request parameter disposition

    • info

      added the new enum value busy to the query request parameter disposition

    • info

      added the new enum value failed to the query request parameter disposition

    • info

      added the new enum value noanswer to the query request parameter disposition

    • info

      for the query request parameter disposition, the type was generalized from no type to string

  • 6a89c962481cRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status