Send Template Message with Dynamic Variables

post

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/messages/dynamic-template

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Send Template Message with Dynamic Variables uses template containing variable parts; each variable is a placeholder within the template that gets replaced with actual data for each recipient when the message is sent, allowing the same template to send personalized message to each given recipient.

📘
Note:
This feature is applicable only to customer onboarded in the India region.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

You must have an approved AgentID or a specific number to be used as AgentID.
Templates must be approved in Kaleyra platform and in RCS ecosystem.

Path Params

sid

string

required

Account SID (Security Identifier).

Body Params

The source parameter table uses templateid and messageparams,
while the actual request payload uses templateId and
messageParams. This specification follows the actual request
payload names.

Documented variable examples:

firstname: Recipient's first name.
dueamount: Amount due to be paid. Data type String / Number.
duedate: Due date for payment.

from

string

required

The service code unique to the RCS agent, specified when the
RCS agent is created or onboarded. Contact the RCS Provisioning
Team for more details on the unique service code.

array of strings

required

length ≤ 100

List of recipients' device addresses.

Up to 100 recipients are allowed.

Each recipient is a phone number in E.164 format prefixed
with the country code without a plus sign.

to*

templateId

string

required

Defines the template ID which is automatically created after
sending the template creation API.

ttlSeconds

string

Specifies the Time-to-Live (TTL) for the RCS message, in seconds.

If the platform is unable to deliver the message within this
duration, it will automatically expire and be revoked. No further
delivery will be attempted after TTL has expired.

Optional.

messageParams

array of objects

required

Key-value pairs for template variables.

Each object contains a list of "

Variables are replaced based on a match between variable names
in the template body and names supplied in the JSON request.

Elements in messageParams must be in the same order as recipient
numbers in the to array.

The first messageParams element personalizes the first recipient,
the second element personalizes the second recipient, and so on.

A mismatch in one or both conditions may disrupt personalization.

Additional parameters can be supplied based on requirements,
provided they are defined in the approved template.

messageParams*

Headers

api-key

string

required

API key generated from the Kaleyra.io account.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note:

Prerequisites

200Message sent successfully to provider.

400Template/carrier error.