Skip to main content
POST
/
cdr
Search for calls containing specific keywords or phrases
curl --request POST \
  --url https://api.wavix.com/v1/cdr \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "placed",
  "from": "2023-08-01T00:00:00.000Z",
  "to": "2023-08-31T00:00:00.000Z",
  "from_search": "4478012",
  "to_search": "44206723",
  "sip_trunk": "87095",
  "min_duration": 10,
  "transcription": {
    "agent": "<any>",
    "client": "<any>",
    "any": "<any>"
  },
  "uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
  "disposition": "answered",
  "page": 1,
  "per_page": 50
}'
{
  "items": [
    {
      "answered_by": "human",
      "date": "2023-08-21T06:43:36.000Z",
      "from": "14302287001",
      "to": "33170363950",
      "disposition": "answered",
      "duration": 6,
      "destination": "France",
      "per_minute": "0.027",
      "charge": "<string>",
      "sip_trunk": "32882",
      "forward_fee": "0.0",
      "uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "parent_uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
      "transcription": {
        "uuid": "40d6f322-048d-490b-95c7-4fc5c76a74db",
        "url": "https://api.wavix.com/v1/cdr/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret"
      }
    }
  ],
  "prices_url": "https://example.com",
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Body

application/json
​
type
string
required

Mandatory parameter. Use placed to search in the outbound call transcriptions or received to search in the inbound call transcriptions.

Example:

"placed"

​
from
string<date>
required

Mandatory parameter. Filter results by the lower limit on the date the call was placed or received. Has the following format yyyy-mm-dd

Example:

"2023-08-01T00:00:00.000Z"

​
to
string<date>
required

Mandatory parameter. Filter results by the upper limit on the date the call was placed or received. Has the following format yyyy-mm-dd

Example:

"2023-08-31T00:00:00.000Z"

​
page
integer
required

Requested page

Example:

1

​
per_page
integer
required

Number of records per page

Example:

50

​
from_search
string

Filter results by the originating phone number. The parameter can be either a full phone number or a part of it.

Example:

"4478012"

​
to_search
string

Filter results by destination phone number. The parameter can be either a full phone number or a part of it.

Example:

"44206723"

​
sip_trunk
string

Filter results by the unique SIP trunk ID used to place an outbound call. For inbound calls the parameter is ignored.

Example:

"87095"

​
min_duration
integer

Filter results by minimum call duration, in seconds

Example:

10

​
transcription
object
​
uuid
string

Call ID

Example:

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

​
disposition
enum<string>

Call disposition Filter calls by disposition. In case the parameter is not specified, only answered calls are returned. To get all calls regardless their disposition pass all as the parameter value

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

Response

200 - application/json

Call detailed records and transcriptions of recorded calls that match the search criteria

​
items
CDRwithTranscription · object[]
required

List of CDRs with links to call transcriptions

​
pagination
object
required
​
prices_url
string

Price url

Example:

"https://example.com"

⌘I