POST /transactionalSMS/sms

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
content String Yes

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

type String No

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.

Valid values:

  • "transactional"
  • "marketing"

Default value: "transactional"

sender String Yes

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

organisationPrefix String No

A recognizable prefix will ensure your audience knows who you are.Mandatory for U.S. Carriers.This will be added as your Brand Name before the message content and will be included in content,Prefer to verify maximum length of 160 characters including this prefix to avoid multiple sending of same sms.

webUrl String No

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

tag String No

Tag of the message

recipient String Yes

Mobile number to send SMS with the country code

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.