KUkudosity
Reporting

Get Message Report

Retrieve information on messages sent during a period of time It will also return all custom data fields associated to contacts in the list

post/get-message-report.json

Request

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

Request body application/x-www-form-urlencoded

startstring date-time

A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.

endstring date-time

A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.

list_idinteger

Recipient list. Provide list_id to look up custom data on this list for the contact and return it in the response.

numberinteger

Virtual mobile number assigned to your account.

typeinteger

Message type, available options:

  • all
  • api
  • campaign
  • quick_sms
  • email_sms
  • keyword
  • test_sms
pageinteger

Page number, for pagination.

maxinteger

Maximum results returned per page.

response_stylestring

response_style = 'array' returns custom field lists as an array.

Response

Successful response containing information about the sent messages.

messages_totalinteger
sms_totalinteger

Changes

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