Send SMS
Body
The registered and approved Sender name to be used for the message.
Type of connectivity for the message, such as promotional, transactional, or OTP.
The phone number with a country prefix to which the message will be sent.
The content of the message that you want to send.
(Optional) Set this parameter to true if you want to send a flash SMS via the API; otherwise, set it to false.
(Optional) Only applicable for India. If you want to pass a template ID directly via the API, you can do so with this parameter.
(Optional) Only applicable for India. If you want to pass an entity ID directly via the API, you can do so with this parameter.
(Optional) Specify the URL where the user’s report and deliveries should be delivered.
(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
Indicates whether the call was successful. true if successful, false if not.
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.
- 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.