CEcequens

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 .

post/v1/messages/personalized

Request

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

Request body

messageTextstring required

The message Jinja2 template content that you want to send.

senderNamestring required

The name of the message sender.

messageTypestring required

Message type either text or unicode Can be text or unicode

recipientsstring required

The intended recipients’ phone numbers comma separated

replacementListstring

An array variablesLists. The delimiters between each variable list is the ';' . and the delimiters between variables are commas ','

variableListstring
clientSchemaRestrictionboolean

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

Response

200

replyCodeinteger
replyMessagestring
requestIdstring
clientRequestIdinteger
requestTimestring

Example response

{
  "replyMessage": "Request handled successfully",
  "requestId": "2fbc0560-6187-11e7-b60b-77c0e21cef84",
  "requestTime": "2017-07-05T15:38:10.742",
  "data": {
    "SentSMSIDs": [
      {
        "SMSId": "0461f8f4-4c4f-4dc0-b7ed-097f4f9f85f4"
      }
    ]
  }
}

Changes

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