v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Track multiple messages with filters for a specific time range

Limit the tracking result of multiple sms by passing filters (accept a date range only for the latest 7 days).

post/sms/tracking

Query parameters

dateStartstring date required

ISO-8601 date-time format (accept a date range only for the latest 7 days)

dateEndstring date required

ISO-8601 date-time format (accept a date range only for the latest 7 days)

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. Max value is 2000.

sortstring

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

trackingIdstring

If provided then only the SMS messages for the specific Campaign Tracking Id will be retrieved.

campaignboolean

If true it will return only SMS messages that belong to an SMS campaign.

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

fieldNamestring required

The name of the field to filter. Available values: smsId, to, status.status, direction, label, campaign

searchTermstring required

The exact value that the specified field must match.

searchOperatorstring

Optional: The operator upon which the search operation will be executed. Possible values: 'is', 'is_not', 'contains', 'starts_with', 'ends_with'. If missing defaults to 'is'.

Response

200

totalPagesinteger

lastboolean

totalElementsinteger

firstboolean

numberOfElementsinteger

sizeinteger

numberinteger

Example response

{
  "totalPages": 1,
  "last": true,
  "totalElements": 1,
  "first": true,
  "numberOfElements": 1,
  "size": 20,
  "content": [
    {
      "applicationName": "Routee",
      "campaignName": "testCampaign",
      "country": "GR",
      "smsId": "23c2bd04-f76e-11e6-bc64-92361f002671",
      "messageId": "29c2ad68-f76e-11e6-bc64-92361f002671",
      "body": "string",
      "operator": "string",
      "originatingService": "sms",
      "to": "+306912345678",
      "status": {
        "status": "Delivered",
        "date": "2016-06-23T06:55:57Z",
        "reason": {
          "detailedStatus": "Delivered",
          "description": "The SMS was sent and it was delivered to its recipient."
        }
      },
      "latency": 1,
      "parts": 1,
      "part": 1,
      "price": 0.036,
      "from": "amdTelecom",
      "direction": "Outbound"
    }
  ]
}