Use this action to send a message with advanced features through your specified channel (optionally with cascading backup channels) to a recipient phone number.
- Base URL:
- Authentication: Basic
- Encoding: Accepts only UTF-8 unicode characters as inputs.
- Responds With:
- Required Headers:
Content-Type - json
All the potential channels you want the service to be able to try and details on how to use those channels. If the first channel attempted fails, you have specified a fallback channel, and the fallback timeout has elapsed, the service looks to the next channel object here for details on what to do.
The end user’s phone number you want to send this message to, as digits without spaces or special characters, beginning with the country dialing code.
Contains properties specifying to the service how to construct the message for each channel. There should be one object in here for each channel, plus a default object with configuration to be applied if none of the specified channels can be used.
The purpose for which the message is being sent. Choose from
OTP - one-time passwords,
ARN - alerts, reminders, and notifications, or
MKT - marketing messages.
Your own identifier, used to refer to this transaction.
Your URL that you want TeleSign to send callbacks to for this transaction. Overrides any previously set callback URL for your account.
The phase of the customer life-cycle the end user is in when this transaction is sent. Choices include:
create- Create a new account.
sign-in- End user signs-in to their account.
transact- End user completes a transaction.
update- End user updates contact details or other info related to their account.
delete- Delete an account.
Specifies the sender ID to be displayed to the end user on the generated message. Before using this, give any sender IDs you might want to use to our Customer Support Team, so we can add them to our allow list. If the sender ID in this field is not on this list, it is not used. We do not guarantee that the sender ID you specify will be used; TeleSign may override this value to improve delivery quality or to follow the regulations of particular countries.
The IP address of the end user the message is sent to. Must be in the format defined by the Internet Engineering Task Force (IETF).
Success. Your request was fulfilled and resulted in a message being sent. Code against the TeleSign status or error codes from the
status.code property in the response payload, rather than the HTTP status code of the response.
|Status Code||Text String||Description|
|3001||Message in progress||TeleSign successfully received this message request and is processing it. (Intermediate)|
A unique, 32-digit hex value randomly generated by TeleSign to identify this request.
Contains properties related to the request status.
Your own identifier, used to refer to this transaction. If you did not supply an external ID in your request, the value of this response property is