Reporting

Get SMS Sent to Account

This will return paginated information regarding individual messages sent to provided mobile number.

get/get-contact-sms-stats.json

Request

  • Base URL
    https://api.transmitsms.com
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

mobileinteger required

The mobile number of the recipient. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.

countrycodestring

Format the mobile number to international format using 2-letter ISO 3166 country code or country name. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.

COUNTRYCOUNTRY CODELOCALINTERNATIONAL
Australiaau049157015661491570156
New Zealandnz021267012964212670129
United Kingdomgb075001769644750017696
United Statesus251355114512513551145
startstring date-time

The start date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.

endstring date-time

The end date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.

sort_fieldstring

Sort by one of the following fields":"" delivery_status, message_id, datetime_send.

orderstring

Order by either ascending (asc) or descending (desc).

pageinteger

Page number for pagination.

maxinteger

Maximum results returned per page.

Example request

{
  "mobile": 61478038915,
  "countrycode": "au",
  "start": "2020-04-27 06:00:00",
  "end": "2020-04-27 06:00:00",
  "sort_field": "delivery_status",
  "order": "asc",
  "page": 1,
  "max": 10
}

Response

OK

totalinteger

Changes

No recorded changes to this operation across all 2 revisions of this API.