Skip to main content
POST
/
api
/
ingest
/
sms
/
v1
/
template
/
send
Send SMS Template
curl --request POST \
  --url https://api-ai.zixflow.com/api/ingest/sms/v1/template/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "recipient": "<string>",
  "route": "<string>",
  "sender_id": "<string>",
  "template_name": "<string>",
  "variables": {},
  "is_flash": true,
  "post_back_url": "<string>",
  "post_back_data": "<string>"
}
'
{
  "success": true,
  "message": "SMS request queued successfully",
  "request_id": "f8df74d1-11fa-4485-b164-b9a65358f4fc"
}

​
Description

This endpoint allows you to send an SMS using a predefined template. Templates can include variables that are replaced with actual values when the SMS is sent. Either template_name or template_id must be provided to identify the template.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Body

​
recipient
string
required
The phone number with a country prefix to which the message will be sent. Required. Must be in international format without the leading plus sign (+) or any spaces, dashes, or other special characters. Format: country code followed by the phone number. Example: 919876543210 (India: country code 91 + number 9876543210).
​
route
string
required
Type of connectivity for the message. Supported routes: promotional, transactional, or otp.
​
sender_id
string
required
The registered and approved sender name to be used for the message. You can add and manage sender IDs in Zixflow SMS Settings.
​
template_name
string
required
The name of the SMS template to use. You can add and manage SMS templates in Zixflow SMS Content.
​
variables
object
required
Key-value pairs for template variables. Keys should match the variable names in the template, and values will replace the placeholders.
​
is_flash
boolean
Optional. Set this parameter to true if you want to send a flash SMS via the API; otherwise, set it to false. Flash SMS appears directly on the screen. Default: false.
​
post_back_url
string
(Optional) To receive post-back notifications about the sent message as it is delivered or failed. When a message status changes (delivered, failed, etc.), a notification will be sent to this URL. See Postback Notifications for the payload format and field descriptions.
​
post_back_data
string
(Optional) The data that will be sent back on the post_back_url with the notification. This can be used as an identifier for the sent message if the client wants to track or correlate messages with their own system. See Postback Notifications for how it appears in the notification.

​
Response

​
success
boolean
Indicates whether the request was successful. true if the request was accepted and queued, false otherwise.
​
message
string
Success message when the request succeeded, or error message when it failed.
​
request_id
string
Present only when success is true. Unique identifier for this request; use it for tracking and for correlating with postback notifications.
{
  "success": true,
  "message": "SMS request queued successfully",
  "request_id": "f8df74d1-11fa-4485-b164-b9a65358f4fc"
}