post

/transactional/sms

SendTransactionalSms function sends transactional mobile text messages to recipients.

There are 2 different methods to send transactional sms.

Method-1

In this method, the client sends the content and recipients. The system returns uuid-type transactionalIds per recipient and uuid-type groupId for all.

These transactional ids are used to get the report per recipient whereas the groupId response field is used to get the report of all recipient at once.

Method-2

This method is used to send transactional mobile text messages using an existing template in the system. The only difference from Method-1 is templateId field is used to select the template from the system. This templateId can be created both using API (CreateSmsContent) or through GUI.

Request Parameters

1 Header

Request Body

Please note that either smsFromId/message pair or templateId is used.

3 Examples
Schema
object
content
object

Sms content to send

required
send
object
required
current
object

If templateId field is used to send to a templateId, this object is used to send parameters to this template.

reporting
object
tags
array[string]

Tags assgined with this transactional text message.

Responses

The messages has been sent. Please keep transacionalId(s) and groupId to use in reporting later.

1 Example
Schema
object
transactionId
string
code
integer
message
string
data
object

gsm phone number and assigned transactional id

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
access_token