Sending Personalized SMS
Personalized SMS is a type of Short Messages that generated from rendering a template , A template is a text that contains a special text that contains variables, Those variable got substituted at the runtime .
Authorization
bearerAuth JWT access token returned by Signing In (POST /auth/v1/tokens/).
In: header
Request Body
application/json
The message Jinja2 template content that you want to send.
"Hi {{Name}} your Salary is {{Salary}}"The name of the message sender.
"Cequens"Message type either text or unicode Can be text or unicode
"text"The intended recipients’ phone numbers comma separated
"201xxxxxxxxx,966xxxxxx"An array variablesLists. The delimiters between each variable list is the ';' . and the delimiters between variables are commas ','
"employeeX,500$""Name,Salary"Restrict the validation for the replacement list versus the variable list and messageText , When enable it will not be any tolerance for missing variable in the variable list
falseResponse Body
application/json
application/json
curl -X POST "https://example.com/sms/v1/messages/personalized" \ -H "Content-Type: application/json" \ -d '{ "messageText": "Hi {{Name}} your Salary is {{Salary}}", "senderName": "Cequens", "messageType": "text", "recipients": "201xxxxxxxxx,966xxxxxx" }'"{\n \"replyCode\": 0,\n \"replyMessage\": \"Request handled successfully\",\n \"requestId\": \"2fbc0560-6187-11e7-b60b-77c0e21cef84\",\n \"clientRequestId\": 0,\n \"requestTime\": \"2017-07-05T15:38:10.742\",\n \"data\": {\n \"SentSMSIDs\": [\n {\n \"SMSId\": \"0461f8f4-4c4f-4dc0-b7ed-097f4f9f85f4\"\n }\n ],\n \"InvalidRecipients\": \"\"\n }\n}"Delete Contact from Group DELETE
**Note:** the official documentation page omits the endpoint path for this operation; it is placed here as the DELETE counterpart of *Add Contact to Group* (`POST /sms/v1/destinations/grouping`). You can remove recipients from certain groups anytime. Use this API to remove the recipients you want from a specific group by first submitting an HTTP Request with the group’s name, and the recipients’ phone numbers to be removed from it, then receiving a Response that returns the valid phone numbers successfully removed from the group, and the invalid phone numbers that were not removed from the group.
Getting Bulk SMS Campaign Details GET
You can track any Bulk SMS campaigns you sent using its Bulk ID in the API request. The API will return the details of the SMS Campaign you want to track, such as the Number of SMS Sent, Delivered & Undelivered in an SMS Campaign