To add this product to your account, contact a Telesign expert. This product is available for full-service accounts only.
This page lists each template, its template-specific parameters, and its recommended channels. These parameters are in addition to those for any request to Telesign Messaging. To set up an email template, contact our Customer Support Team.
📘
NOTE:
For a full list that defines both these parameters and others that are common to any request, go to POST /v1/omnichannel.
text
Recommended For
all channels
Send a simple text-only message.
Parameter
Type
Description
Example
Required?
message.{channel_name}.parameters
object
Contains sub-properties with values for variables in the message template.
y
message.{channel_name}.parameters.text
string
The main text of your message.
All purchases today are 20% off!
y
text_2way
Recommended For
Viber
Send a simple text-only message as part of a Viber two-way chat. The schema is the same as for the text template.
text_session
Recommended For
Viber
Send a simple text-only message as part of a Viber session chat. The schema is the same as for the text template.
media
Recommended For
RCS
Send a message to an end-user that includes an embedded image, audio file, or video file.
Parameter
Type
Description
Example
Required?
message.{channel_name}.parameters
object
Contains sub-properties with values for variables in the message template.
y
message.{channel_name}.parameters.url
string
The URL for the image, video, or audio file to embed in the message.
https://acme.co/summer_deals.png
y
url_action
Recommended For
RCS
Viber
Send a message to an end-user that includes a link button to a URL of your choice.
Parameter
Type
Description
Example
Required?
message.{channel_name}.parameters
object
Contains sub-properties with values for variables in the message template.
y
message.{channel_name}.parameters.text
string
The main text of your message.
All purchases today are 20% off!
y
message.{channel_name}.parameters.url_text
string
Text for the link in the message.
See all deals here.
y
message.{channel_name}.parameters.url_payload
string
Unique identifier for the link in the message.
mktUrl1
y
message.{channel_name}.parameters.url
string
The URL for the link in the message.
https://acme.co/summer_deals
y
rc_url_action_vertical
Recommended For
RCS
Send a message to an end-user that displays a vertically stacked rich card, including both an image and a link button to a URL of your choice.
Parameter
Type
Description
Example
Required?
message.{channel_name}.parameters
object
Contains sub-properties with values for variables in the message template.
y
message.{channel_name}.parameters.url_text
string
Text for the link in the message.
See all deals here.
y
message.{channel_name}.parameters.url_payload
string
Unique identifier for the link in the message.
mktUrl1
y
message.{channel_name}.parameters.url
string
The URL for the link in the message.
https://acme.co/summer_deals
y
message.{channel_name}.parameters.media_url
string
The URL reference for the image to include in the rich card in your message.
