WAwavix
CDRs

Retrieve a CDR

Changed on

Returns the call detail record for the call identified by call_id.

get/v1/cdrs/{call_id}

Request

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

Path parameters

call_idstring uuid required
Example:aa566501-c591-4a8b-b3b9-cc1295398b72

The unique ID of the call.

Query parameters

show_transcriptionboolean
Example:true

When true, includes the call transcription in the response.

Response

Returns the CDR.

datestring date-time nullable required

Call date and time in ISO 8601 format.

fromstring required

Caller ID (ANI).

tostring required

Dialed number (DNIS).

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

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

durationinteger required

Call duration in seconds.

destinationstring nullable required

Destination of the call. For outbound calls, contains the country name and, optionally, a mobile carrier or city name. For inbound calls, includes the SIP trunk name, SIP URI, or PSTN number the call is forwarded to.

per_minutestring nullable required

Price per minute in USD.

recording_urlstring nullable

URL of the recorded call file. Call recording can be enabled on a SIP trunk for outbound calls and on a phone number for inbound calls.

chargestring nullable required

Total charge for the call in USD.

sip_trunkstring nullable

System-generated SIP trunk login. For outbound calls only.

forward_feestring

PSTN forwarding price in USD. For inbound calls only when forwarded to PSTN.

uuidstring required

Call ID. Deprecated — use call_id instead.

call_idstring required

Call ID. Alias of uuid.

parent_uuidstring nullable

Parent call ID. Deprecated — use parent_call_id instead.

parent_call_idstring nullable

Parent call ID. Alias of parent_uuid.

answered_bystring nullable

Who answered the call. Possible values are human, machine.

Example response

{
  "date": "2023-08-21T06:43:36.000Z",
  "from": "14302287001",
  "to": "33170363950",
  "duration": 6,
  "destination": "France",
  "per_minute": "0.027",
  "recording_url": "https://api.wavix.com/v1/recordings/recording_id",
  "charge": "0.162",
  "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",
  "transcription": {
    "uuid": "40d6f322-048d-490b-95c7-4fc5c76a74db",
    "url": "https://api.wavix.com/v1/cdrs/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret"
  }
}

Changes

  • 6a89c962481cRevision changes
    • breaking

      added the pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ to the path request parameter call_id

    • breaking

      for the path request parameter call_id, the format changed from no format to uuid

    • 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 optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the 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

    • info

      added the required property to the 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

    • info

      added the required property to the 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

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 76b9bb35619fRevision changes
    • info

      endpoint added