Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional SMS

Get all your SMS activity (unaggregated events)

get/transactionalSMS/statistics/events

Query parameters

limitinteger

Number of documents per page

startDatestring

Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report

endDatestring

Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report

offsetinteger

Index of the first document of the page

daysinteger

Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

phoneNumberstring

Filter the report for a specific phone number

event'bounces' | 'hardBounces' | 'softBounces' | 'delivered' | 'sent' | 'accepted' | 'unsubscription' | 'replies' | 'blocked' | 'rejected' | 'skipped'

Filter the report for specific events

tagsstring

Filter the report for specific tags passed as a serialized urlencoded array

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Response

Sms events report informations

Example response

{
  "events": [
    {
      "phoneNumber": "00189001094",
      "date": "2017-03-12T12:30:00Z",
      "messageId": "1472640582425378",
      "event": "accepted",
      "reason": "Message is undeliverable due to an incorrect / invalid / blacklisted / permanently barred MSISDN for this operator",
      "tag": "CabWaiting"
    }
  ]
}