Retrieving SMS Messages

You can track the messages you have sent during a certain period by submitting the Get Messages Details Within Date Range API request. The API will return an array of multiple records. Each record includes the details of an SMS message that was sent during the provided date range in the API request. You can also specify the number of SMS messages you want to receive per response page, as well as the response page index number you want to receive.

To use Cequens Get Messages Details Within Date Range API, first submit an HTTP Request with the date range, and other optional details, and then receive a Response that includes the details of all SMS messages sent during the provided date range.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Success Response

The data key in the Get Messages Details Within Date Range Success response is an array that includes a number of records, one for each SMS sent within the submitted date range. Each record includes the following details about the SMS message that you are tracking:

ParameterDescription
IdA string that returns the SMS ID of the message to be tracked.
AccountIdAn integer that represents the ID of the account used to send the SMS.
RequestIdA string that specifies the ID of the request submitted to send the SMS.
SenderA string that returns the sender’s name of the SMS.
MessageTextA string that returns the actual message content of the SMS
RecipientThe Mobile Recipient
StatusAn integer that specifies the delivery status of the SMS. Its possible values are:
  • 1 (Delivered)
  • 2 (Undelivered)
  • 3 (Sent)
  • 4 (Buffered)
  • 5 (Blocked)
  • 16 (Rejected by SMS Center)
  • 17 (In Progress)
  • 1200 (Unknown)
SentDateA string that returns the date and time on which the SMS was sent.
Query Params
string
required

Interval start date, Supported date formats are['YYYY-MM-DD hh:mm:ss','MM-DD-YYYY hh:mm:ss','YYYY/MM/DD hh:mm:ss','MM/DD/YYYY hh:mm:ss','YYYY-M-D hh:mm:ss','M-D-YYYY hh:mm:ss','YYYY/M/D hh:mm:ss','M/D/YYYY hh:mm:ss']

string
required

Interval end date, Supported date formats are['YYYY-MM-DD hh:mm:ss','MM-DD-YYYY hh:mm:ss','YYYY/MM/DD hh:mm:ss','MM/DD/YYYY hh:mm:ss','YYYY-M-D hh:mm:ss','M-D-YYYY hh:mm:ss','YYYY/M/D hh:mm:ss','M/D/YYYY hh:mm:ss']

int32
Defaults to 1

Page index starts from 1:N for too many SMSs retrieved.

int32
Defaults to 1000

Number of SMS per page. Max value is 1000.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json