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.

get/v1/messages

Request

  • Base URL
    https://apis.cequens.com/sms
  • URL
    https://apis.cequens.com/sms/v1/messages
  • Auth
    API key in header Authorization

Query parameters

fromstring 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']

tostring 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']

pageIndexinteger

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

patchSizeinteger

Number of SMS per page. Max value is 1000.

Response

200

replyCodeinteger
replyMessagestring
requestIdstring
clientRequestIdinteger
requestTimestring

Example response

{
  "replyMessage": "[Request handled successfully] Request handled successfully.",
  "requestId": "aeec0640-6232-11e7-b60b-77c0e21cef84",
  "requestTime": "2017-07-06T12:05:48.068",
  "data": [
    {
      "Id": "00A47DE5-B086-4A0E-9E69-0B712F1393A5",
      "AccountId": "783",
      "RequestId": "375295152",
      "Sender": "Cequens",
      "MessageText": "Test Message",
      "Recepient": "201234567890",
      "Status": 3,
      "SentDate": "2017-07-05T11:49:18.713Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.