Send a Rich Card Carousel Message with Chiplist

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The Send a Rich Card Carousel Message with Chiplist API sends a rich card carousel message using RCS, enhanced with a chiplist (interactive reply buttons). Each card in the carousel includes media, title, description, and suggestions (actions or replies). The chiplist provides additional quick-reply options for user engagement.

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

Rich card carousel message with chiplist.

Payload for sending an RCS rich card carousel message with chiplist.

from

string

required

The service code unique to the RCS agent, specified when the RCS
agent is created or onboarded.

array of strings

required

length ≤ 100

List of recipients' device addresses. Up to 100 recipients are
allowed.

Each recipient can either be:

A phone number in E.164 format prefixed with the country code
without a plus sign.
A URI-like identification used to contact the user.

to*

richCardCarousel

object

Contains the details of the carousel of rich cards sent to the user's
device.

suggestions

array of objects

List of chiplist items. Suggestions can be reply chips or action
chips.

suggestions

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.

Headers

api-key

string

required

API key generated from the Kaleyra.io account.

Response

Language

URL

Loading…

Response

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

application/json

Prerequisites

200Successful message submission. The documented success response contains recipientDetails with the recipient address and generated message ID. Kaleyra's documentation does not explicitly specify the HTTP status code, so 200 is used here to represent the documented successful response.