v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Transactional SMS

Send SMS message to a mobile number

post/transactionalSMS/sms

Request body

senderstring required

Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters

recipientstring required

Mobile number to send SMS with the country code

contentstring required

Content of the message. If more than 160 characters long, will be sent as multiple text messages

type'transactional' | 'marketing'

Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc.

tagstring

Tag of the message

webUrlstring url

Webhook to call for each event triggered by the message (delivered etc.)

unicodeEnabledboolean

Format of the message. It indicates whether the content should be treated as unicode or not.

organisationPrefixstring

A recognizable prefix will ensure your audience knows who you are. Recommended by U.S. carriers. This will be added as your Brand Name before the message content. Prefer verifying maximum length of 160 characters including this prefix in message content to avoid multiple sending of same sms.

Example request

{
  "sender": "MyShop",
  "recipient": "33689965433",
  "content": "Enter this code:CCJJG8 to validate your account",
  "type": "marketing",
  "tag": "accountValidation",
  "webUrl": "http://requestb.in/173lyyx1",
  "unicodeEnabled": true,
  "organisationPrefix": "MyCompany"
}

Response

SMS has been sent successfully to the recipient

referencestring required

messageIdinteger required

smsCountinteger

Count of SMS's to send multiple text messages

usedCreditsnumber float

SMS credits used per text message

remainingCreditsnumber float

Remaining SMS credits of the user

Example response

{
  "reference": "ab1cde2fgh3i4jklmno",
  "remainingCredits": 82.85,
  "smsCount": 2,
  "messageId": 1511882900176220,
  "usedCredits": 0.7
}