Send a Rich Card Carousel Message with Suggestion

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 Suggestion API sends a rich card carousel message using RCS, where each card includes media, title, description, and interactive suggestions. Suggestions can be either actions (which open URLs) or replies (which send postback data). This format is ideal for showcasing multiple offerings with direct engagement options.

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).

The SID can be viewed from the Kaleyra account.

Body Params

Request payload used to send a rich card carousel message with
suggestions.

Request payload for sending a rich card carousel message with
suggestions.

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 between 1 and 100

List of recipients' device addresses.

Up to 100 recipients are allowed.

A recipient can 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

required

Container for the rich cards included in the carousel.

suggestions

array of objects

List of message-level interactive suggestions.

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

Reference identifier used for message correlation or tracking.

ref1

string

Additional reference identifier used for correlation or tracking.

ref2

string

Additional reference identifier used for categorization or
tracking.

Headers

api-key

string

required

API key generated from the Kaleyra 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 response containing recipient details and the generated message ID.