Send Carousel RCS

Send 2 to 10 cards side by side that the customer can swipe; each card has a title, text, an image and an optional button.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Send 2 to 10 cards side by side that the customer can swipe; each card has a title, text, an image and an optional button.

FieldSend
bot_id, toalways
typecarousel
cards2 to 10 cards, each with title and description (and media_url if you want an image)
Card button (optional)on a card: suggestion_type + suggestion_text, and the field for that button below
ButtonAlso send
openUrlsuggestion_url
dialsuggestion_phone
viewLocationlatitude, longitude (and location_label if you want it)

The reply's request_id (15 characters, starts with R) is the same one your RCS webhook receives with each delivery update. Send a carousel as JSON (POST); the other message types also work as a GET request with query parameters.

Body Params
string
required

Your approved RCS bot: the Bot ID shown under the bot in RCS Manager → Bots (copy button), also in Settings → API Excel → RCS.

string
required

One 10-digit Indian mobile number (+91 / 91 in front is accepted).

string
enum
required
Defaults to carousel

Always carousel for a carousel.

Allowed:
cards
array of objects
required
length between 2 and 10

2 to 10 cards.

cards*
string
required
length ≤ 255
string
required
length ≤ 2000
string

Public image URL for this card (optional).

string
enum

Optional button on this card: openUrl, dial or viewLocation, with the same fields as below.

Allowed:
string
length ≤ 25

Button text, up to 25 characters.

string

openUrl: the link to open.

string

dial: the number to call, with country code.

number

viewLocation: latitude.

number

viewLocation: longitude.

string
length ≤ 100

viewLocation: name shown on the map (optional).

string
required
length ≤ 255
string
required
length ≤ 2000
string

Public image URL for this card (optional).

string
enum

Optional button on this card: openUrl, dial or viewLocation, with the same fields as below.

Allowed:
string
length ≤ 25

Button text, up to 25 characters.

string

openUrl: the link to open.

string

dial: the number to call, with country code.

number

viewLocation: latitude.

number

viewLocation: longitude.

string
length ≤ 100

viewLocation: name shown on the map (optional).

string

Optional value of your own, returned in the delivery webhook (also udf2, udf3).

Headers
string
required
Defaults to YOUR_API_KEY

Provide "YOUR_API_KEY".

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json