POST
/
api
/
v1
/
campaign
/
sms
/
send
curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/sms/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "senderId": "IDENTY",
    "route": "transactional",
    "number": "919090909090",
    "message": "Your OTP is 0101",
    "isFlash": false,
    "dltTemplateId": "1234",
    "dltEntityId": "1234",
    "reportURL": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5",
    "submissionStatus": false
}'

{
  "status": true,
  "message": "SMS sent successfully"
}

​
Body

​
senderId
string
required

The registered and approved Sender name to be used for the message.

​
route
string
required

Type of connectivity for the message, such as promotional, transactional, or OTP.

​
number
string
required

The phone number with a country prefix to which the message will be sent.

​
message
string
required

The content of the message that you want to send.

​
isFlash
boolean

(Optional) Set this parameter to true if you want to send a flash SMS via the API; otherwise, set it to false.

​
dltTemplateId
string

(Optional) Only applicable for India. If you want to pass a template ID directly via the API, you can do so with this parameter.

​
dltEntityId
string

(Optional) Only applicable for India. If you want to pass an entity ID directly via the API, you can do so with this parameter.

​
reportURL
string

(Optional) Specify the URL where the user’s report and deliveries should be delivered.

​
submissionStatus
boolean

(Optional) When a user wants to wait for submission status from the API, they must set this key to true. It is false by default.

​
Response

​
status
boolean

Indicates whether the call was successful. true if successful, false if not.

​
message
string

success or error response message

​
Reports & Deliveries

In order to get delivery reports directly into your system you need to take care of few simple things.

  1. Please make sure that, the URL passed in the field reportUrl, must accept HTTP POST request with JSON request body.

If you are sending an SMS using a GET URL, it is necessary to encode the message using the URL Encoding method before sending it. However, if you are using a POST API, there is no need to encode the message.

For example, if the message is “Hi User 1 & User 2, Welcome to zixflow,” it needs to be encoded as “Hi%20User%201%20%26%20User%202%2C%20Welcome%20to%20zixflow” using URL Encoding.

You can use a tool like https://www.urlencoder.org/ for reference on how to properly encode your message.

curl --location --request POST 'https://api.zixflow.com/api/v1/campaign/sms/send' \
--header 'Authorization: Bearer 56616641ee123b80a36b99fedc2bfa4f0d7f63072d97ddb1578c7a5aa970e7edde6618c7f750beb921aee3eebc9cc48899ee992fa4eb95a663d0e0b2eaa35b73f3b2344c' \
--header 'Content-Type: application/json' \
--data-raw '{
    "senderId": "IDENTY",
    "route": "transactional",
    "number": "919090909090",
    "message": "Your OTP is 0101",
    "isFlash": false,
    "dltTemplateId": "1234",
    "dltEntityId": "1234",
    "reportURL": "https://webhook.site/0a276bc5-f0e4-4235-9006-b58b7d224ad5",
    "submissionStatus": false
}'

{
  "status": true,
  "message": "SMS sent successfully"
}