v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Track multiple voice messages with filters for a specific time range

Limit the tracking result of multiple voice messages by passing filters

post/voice/tracking

Query parameters

fromstring

ISO-8601 date-time format

tostring

ISO-8601 date-time format

pageinteger

The page number to retrieve, default value is 0 (meaning the first page)

sizeinteger

The number of items to retrieve, default value is 20.

sortstring

The field name that will be used to sort the results.

trackingIdstring

If provided then only the voice messages of the campaign with this tracking Id will be retrieved.

taggedboolean

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

fieldNamestring required

Defines the name of the field for this filter. ACCEPTED VALUES: id, recipient, from, collectedTones, groups, country, status.status, campaign

searchOperatorstring

Defines the search operator to be used for the search. Examples: is, is_not, contains, starts_with, ends_with

searchTermstring required

Defines the value of the specified field.

Response

200

totalElementsinteger

lastboolean

totalPagesinteger

firstboolean

numberOfElementsinteger

sizeinteger

numberinteger

Example response

{
  "content": [
    {
      "messageId": "900f2ad3-790b-49f3-ab59-f6ffcf9af250",
      "to": "306986111111",
      "from": "TestSender",
      "country": "GR",
      "status": {
        "status": "NoAnswer",
        "date": "2017-06-07T09:24:22Z"
      },
      "applicationName": "Routee Web App",
      "originatingService": "Voice",
      "direction": "Outbound",
      "message": {
        "language": "en-GB",
        "gender": "female",
        "text": "Hello!!!"
      },
      "chargeInterval": 60
    }
  ],
  "totalElements": 2,
  "last": true,
  "totalPages": 1,
  "first": true,
  "numberOfElements": 2,
  "size": 20
}