Send a Rich Text Message with Chiplist

post

https://rcs-api.in.kaleyra.io/v1/{sid}/rcs/messages/rich-text-with-chiplist

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Send a Rich Text Message with Chiplist API request allows you to send a rich text message that includes emojis or special characters, along with a chiplist - a set of interactive buttons that offer quick replies or actions. This format is ideal for creating expressive, engaging, and interactive user experiences.

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.

Path Params

sid

string

required

Account SID (Security Identifier).

Body Params

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. A recipient may be a phone number in E.164 format
prefixed with the country code without a plus sign, or, where
documented by the API variant, a URI-like identification.

to*

ttlSeconds

string

Specifies the Time-to-Live (TTL) for the action message, in seconds.
If the platform is unable to deliver the message within this duration,
it will automatically expire and be revoked.

ref

string

A reference ID used to correlate or track the message. This may
represent a parent or primary transaction reference.

ref1

string

Additional reference ID for sub-correlation or message grouping.
Usually used when multiple child transactions are involved.

ref2

string

Additional reference ID for further categorization or tracking
in workflows requiring multiple linked identifiers.

text

string

required

length ≤ 2000

Text message content encoded in UTF-8.
Maximum 2000 Unicode characters.

suggestions

array of objects

length ≤ 11

List of suggestions comprised of suggested reply and suggested
action chips that users can click.
Maximum 11 chips.

suggestions

Headers

api-key

string

required

API key generated from the Kaleyra account.

Responses

Language

URL

Loading…

Response

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

application/json

Prerequisites

200Message successfully submitted.

defaultError response.