v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

SMS

View received SMS

View received SMS messages.

post/sms/view-received

Request body

start_datestring date

ISO-8601 formatted datetime which defaults to 7 days ago at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC.

end_datestring date

ISO-8601 formatted datetime which defaults to now. Timezone is UTC.

unix_startinteger

Deprecated: this is a legacy method of selecting the start of the search period as a unix timestamp. This can be left empty to use the start_date.

unix_endinteger

Deprecated: this is a legacy method of selecting the end of the search period as a unix timestamp. This can be left empty to use the end_date.

usernamestring

If passed will filter the results based on the username information on the message

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

Response

SMS Messages

Example response

{
  "data": {
    "request_id": "e023461c-8c86-11e9-b984-408d5cce2644",
    "messages": [
      {
        "timestamp": "2022-09-30T02:02:41Z",
        "content": "Example content",
        "message_id": "2434321b-566d-40cf-a16b-34570931c205",
        "username": "api-12345678"
      }
    ]
  }
}