Values to send a transactional SMS
Request body which must comply to the following JSON Schema:
{
"required" : [ "content", "recipient", "sender" ],
"type" : "object",
"properties" : {
"sender" : {
"maxLength" : 15,
"type" : "string",
"description" : "Name of the sender. **The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters**\n",
"example" : "MyShop"
},
"recipient" : {
"type" : "string",
"description" : "Mobile number to send SMS with the country code",
"example" : "33689965433"
},
"content" : {
"type" : "string",
"description" : "Content of the message. If more than **160 characters** long, will be sent as multiple text messages\n",
"example" : "Enter this code:CCJJG8 to validate your account"
},
"type" : {
"type" : "string",
"description" : "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.",
"example" : "marketing",
"default" : "transactional",
"enum" : [ "transactional", "marketing" ]
},
"tag" : {
"type" : "string",
"description" : "Tag of the message",
"example" : "accountValidation"
},
"webUrl" : {
"type" : "string",
"description" : "Webhook to call for each event triggered by the message (delivered etc.)",
"format" : "url",
"example" : "http://requestb.in/173lyyx1"
},
"unicodeEnabled" : {
"type" : "boolean",
"description" : "Format of the message. It indicates whether the content should be treated as unicode or not.\n",
"example" : true,
"default" : false
},
"organisationPrefix" : {
"type" : "string",
"description" : "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" : "MyCompany"
}
}
}
