WAwavix
CDRs

Search transcriptions

Changed on

Searches call transcriptions for the given keywords or phrases and returns the matching CDRs with their transcriptions.

post/v1/cdrs

Request

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

Request body

type'placed' | 'received' required

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

fromstring date required

Start date for call search in YYYY-MM-DD format.

tostring date required

End date for call search in YYYY-MM-DD format.

from_searchstring

Originating phone number to filter results. Accepts full or partial number.

to_searchstring

Destination phone number to filter results. Accepts full or partial number.

sip_trunkstring

SIP trunk login to filter outbound calls. Ignored for inbound calls.

min_durationinteger

Minimum call duration in seconds.

uuidstring

Call ID.

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

pageinteger

Page number to retrieve.

per_pageinteger

Number of records per page.

Example request

{
  "type": "placed",
  "from": "2023-08-01",
  "to": "2023-08-31",
  "from_search": "4478012",
  "to_search": "44206723",
  "sip_trunk": "87095",
  "min_duration": 10,
  "transcription": {
    "agent": {
      "must": [
        "Hello",
        "Thank you"
      ],
      "match": [
        "Nope",
        "Maybe"
      ],
      "exclude": [
        "Richard",
        "Issue resolved"
      ]
    },
    "client": {
      "must": [
        "Hello",
        "Thank you"
      ],
      "match": [
        "Nope",
        "Maybe"
      ],
      "exclude": [
        "Richard",
        "Issue resolved"
      ]
    },
    "any": {
      "must": [
        "Hello",
        "Thank you"
      ],
      "match": [
        "Nope",
        "Maybe"
      ],
      "exclude": [
        "Richard",
        "Issue resolved"
      ]
    }
  },
  "uuid": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
  "page": 1,
  "per_page": 25
}

Response

Returns a paginated list of matching CDRs with their transcriptions.

Example response

{
  "items": [
    {
      "answered_by": "human",
      "date": "2023-08-21T06:43:36.000Z",
      "from": "14302287001",
      "to": "33170363950",
      "duration": 6,
      "destination": "France",
      "per_minute": "0.027",
      "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",
      "transcription": {
        "uuid": "40d6f322-048d-490b-95c7-4fc5c76a74db",
        "url": "https://api.wavix.com/v1/cdrs/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret"
      }
    }
  ],
  "pagination": {
    "current_page": 2,
    "per_page": 25,
    "total": 101,
    "total_pages": 5
  }
}

Changes

  • d4db3aae3627Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • warning

      removed subschema #2 from the request property allOf list

    • info

      added the new all enum value to the request property

    • info

      added the new answered enum value to the request property

    • info

      added the new busy enum value to the request property

    • info

      added the new failed enum value to the request property

    • info

      added the new noanswer enum value to the request property

  • 6a89c962481cRevision changes
    • breaking

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

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property / became optional

    • info

      the request property / became optional

    • info

      the request property / became optional

    • info

      the request property default value 1 was added

    • info

      the request property default value 25 was added

    • info

      removed from the response body allOf list for the response 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