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.
Authorization
bearerAuth JWT access token returned by Signing In (POST /auth/v1/tokens/).
In: header
Query Parameters
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']
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']
Page index starts from 1:N for too many SMSs retrieved.
int321Number of SMS per page. Max value is 1000.
int321000Response Body
application/json
application/json
curl -X GET "https://example.com/sms/v1/messages?from=string&to=string""{\n \"replyCode\": 0,\n \"replyMessage\": \"[Request handled successfully] Request handled successfully.\",\n \"requestId\": \"aeec0640-6232-11e7-b60b-77c0e21cef84\",\n \"clientRequestId\": 0,\n \"requestTime\": \"2017-07-06T12:05:48.068\",\n \"data\": [\n {\n \"Id\": \"00A47DE5-B086-4A0E-9E69-0B712F1393A5\",\n \"AccountId\": \"783\",\n \"RequestId\": \"375295152\",\n \"Sender\": \"Cequens\",\n \"MessageText\": \"Test Message\",\n \"Recepient\": \"201234567890\",\n \"Status\": 3,\n \"SentDate\": \"2017-07-05T11:49:18.713Z\"\n },\n {\n \"Id\": \"0E7306E0-E6ED-4F0B-AC92-D211BA7272E9\",\n \"AccountId\": \"783\",\n \"RequestId\": \"161541572\",\n \"Sender\": \"Cequens\",\n \"MessageText\": \"Test Message\",\n \"Recepient\": \"201234567890\",\n \"Status\": 1,\n \"SentDate\": \"2017-07-05T12:38:58.216Z\"\n }\n ]\n}"Sending SMS To Groups POST
In case you want to send bulk SMS to predefined groups of recipients, use Cequens Send SMS to Groups API. The API will return to you the messages’ ID to track them later using Cequens Get Message Details by ID API. Using Cequens Send SMS to Groups API is quite simple. First, submit an HTTP Request with the group’s name, the message text, and other important parameters, and then receive a Response that includes the SMS IDs.
Sending SMS POST
Use messages endpoint to send Single or Bulk SMS. When you send SMS messages using this API, the API will return to you the sent messages’ ID to track them later using Cequens Get Message Details by ID API.