Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 2.42 KB

File metadata and controls

27 lines (20 loc) · 2.42 KB

SendTransacSms

Properties

Name Type Description Notes
organisationPrefix String 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. [optional]
recipient String Mobile number to send SMS with the country code
sender String Name of the sender. The number of characters is limited to 11 for alphanumeric characters and 15 for numeric characters
tag String Tag of the message. Can be a string or an array of strings (e.g., "accountValidation" or ["tag1", "tag2"]). [optional]
type TypeEnum 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. [optional]
unicodeEnabled Boolean Format of the message. It indicates whether the content should be treated as unicode or not. [optional]
webUrl String Webhook to call for each event triggered by the message (delivered etc.) [optional]
templateId Integer Template ID to send SMS with the template. When provided, overrides the content parameter. Either 'templateId' or 'content' must be provided, but not both. [optional]
content String Content of the message. If more than 160 characters long, will be sent as multiple text messages. Either 'templateId' or 'content' must be provided, but not both. Mandatory if 'templateId' is not passed, ignored if 'templateId' is passed. [optional]
params Map<String, Object> Pass the set of attributes to customize the template. For example, {"FNAME":"Joe", "LNAME":"Doe"}. These are the placeholder variables in the template that will be replaced with the corresponding values passed in the params object. Applicable only if `templateId` is used. [optional]

Enum: TypeEnum

Name Value
TRANSACTIONAL "transactional"
MARKETING "marketing"