search for calls containing specific keywords or phrases

API Docs by APIMATIC

Search for Calls Containing Specific Keywords or Phrases

Use this method to search for call transcriptions containing specific keywords or phrases. Wavix automatically labels speakers as an agent and a customer based on the call direction. You can search for phrases said by an agent, a customer, or both.

By default, the results are paginated, with 25 records per page.

This endpoint requires authentication.

POST /cdr
  • EXPLORER
  • PARAMETERS
Endpoint Arguments*
Parameters*
request (Call transcription search request)*

Search for calls containing specific keywords or phrases

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

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

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

transcription (Transcription search)*

Transcription filter

Filter results by call transcription status. Can be either `completed` or `failed`. When `failed` is used all other transcription parameters are ignored

Filter results by automatically identified language of the transcription

agent (Keywords and phrases filter)

Search in an agent's spoken words and phrases

must*

Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND

match*

Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

exclude*

Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

client (Keywords and phrases filter)

Search in an customer's spoken words and phrases

must*

Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND

match*

Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

exclude*

Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

any (Keywords and phrases filter)

Search in both speakers' spoken words and phrases

must*

Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND

match*

Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

exclude*

Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR

Requested page

Number of records per page

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

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

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

Filter results by minimum call duration

Response Type

curl -X POST \
  --url 'https://api.wavix.com/v1/cdr?appid=your-API-key' \
  -H 'Accept: application/json' \
  -H 'Content-type: application/json' \
  --data-raw '{
  "type": "placed",
  "from": "2023-01-01",
  "to": "2023-01-31",
  "transcription": {
    "status": "completed"
  },
  "page": 2,
  "per_page": 50
}'