Send Predefined SMS

Trigger SMS sendings on the basis of pre-saved templates

This endpoint is used to trigger SMS sendings on the basis of pre-saved SMS trigger templates. SMS trigger templates allow you to save all the details necessary to ‘trigger’ an SMS sending as a template. These templates contain SMS sending details like the Sender name, the SMS content and text, and unsubscribe options at the time of campaign distribution, etc.

Request
Security:
Bearer
Request Body schema:

This endpoint is used to trigger SMSs on the basis of details pre-saved as SMS trigger templates – no need to pass the details manually.

predefinedTemplateId
required
string
Default: "TSMS-899"
listId
Array of strings or null <uuid>

The list ID(s) of the contact lists to which you wish to send the SMS. In case you wish to send the SMS to multiple lists, pass the relevant list IDs as an array.

scheduleDateTime
string or null <date-time>

The scheduled date and time for the message sending in RFC3339 format (Y-m-d TH:i:sP).

Array of objects or null (Recipients)

The mobile number(s) to which you want to send the SMS (along with the country code).

Array
recipient
required
integer <int64>
Array of objects or null (PersonalizationSubstitutionTag)

Insert dynamic data at the time of SMS sending, follow the pattern tagName:tagValue to substitute for the key/value pairs.

Array
tagName
string or null
tagValue
string or null
webHookUrl
string or null

The webhook URL where you want to receive delivery status updates for the SMS being sent.

Responses
202

Success

400

Bad Request

401

Unauthorized

409

Conflict

422

Client Error

500

Server Error

post/sms/predefinedsms
Request samples
{
  • "predefinedTemplateId": "TSMS-899",
  • "listId": [
    • "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
  • "scheduleDateTime": "2019-08-24T14:15:22Z",
  • "recipients": [
    • {
      • "recipient": 0,
      • "personalizationSubstitutionTags": [
        • {
          • "tagName": "string",
          • "tagValue": "string"
          }
        ]
      }
    ],
  • "webHookUrl": "string"
}
Response samples
{
  • "queueId": "string",
  • "QueuedTimestamp": 0
}