v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Track multiple messages for a specific bulk send out - campaign

You can get all the tracking information for the messages of a bulk send out by providing the tracking id

get/sms/tracking/campaign/{campaignTrackingId}

Path parameters

campaignTrackingIdstring required

The tracking id of the campaign which includes the messages.

Query parameters

pagestring

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

sizestring

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.

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

application/json

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"
    }
  ]
}