Carousel message

A carousel message is a message that features a number of horizontally-scrolling images or panes. You can send a carousel message by making a POST request to the /messages:send Conversation API endpoint with the following payload:

{}

Card message schema

A carousel message can take the following parameters and properties. Required parameters are marked.

required
Array of objects (Card Message)

A list of up to 10 cards.

Array of objects (Choice message)

Optional. Outer choices on the carousel level. The number of outer choices is limited to 3.

Note:

Not all channels support every parameter.

The following sections give examples of how card messages are rendered in each channel and specific parameter support:

WhatsApp

WhatsApp doesn't natively support carousel messages and so they're transcoded and sent as text messages by Conversation API. The following image gives an example of a carousel message.

Carousel Message

SMS

There is no native support for carousels in SMS. Messages are in plain text. The following image gives an example of a carousel message.

Carousel Message

Facebook Messenger

Facebook Messenger natively supports Carousel Messages. The media_message property only supports images. The following image gives an example of a carousel message.

Carousel Message

Instagram

Instagram natively supports carousel messages.

Note

Carousel outer choices are not supported.

The following image gives an example of a carousel message.

Carousel Message 1

Apple Messages for Business

Carousel messages are sent as a single text message with multiple attachments. Each card's information is converted to plain text and displayed below each attachment.

Supported:

Choice Message

Unsupported:

Choice Message

MMS

MMS doesn't natively support Carousel messages and so they're transcoded and sent as text messages by Conversation API.

The following image gives an example of a carousel message.

Carousel Message

RCS

RCS natively supports Carousel Messages. You can put from 1 to 10 cards in one message. Each card can consist of the elements described in the "Card Messages" section. If you send only one card, the message will be rendered as a normal Card Message. Additionally, RCS channel supports a maximum of 3 outer choices. You can put outer choices into the carousel_message.choices array field, and these choices will be rendered right after the displayed cards.

The following image gives an example of a carousel message.

Carousel Message

Viber Bot

Viber Bot channel natively supports carousel messages. The following image gives an example of a carousel message.

Carousel Message

Viber Business Messages

Viber Business Messagers doesn't support natively Carousel messages and so they're transcoded and sent as text messages by Conversation API. The following image gives an example of a carousel message.

Carousel Message

KakaoTalk

KakaoTalk doesn't natively support Carousel messages and so they're transcoded and sent as text message by Conversation API.

The Carousel message as text has a maximum length of 1000 characters.

LINE

LINE channel natively supports carousel messages. The following image gives an example of a carousel message.

For each card:

  • Title: max characters limit: 40
  • Description: max characters limit: 60
  • Choice Buttons:
    • Text Message Choice, with postback data. When clicking the button, Text will appear in the chat window, invisible postback data will be sent back.
    • URL Message Choice. When clicking the button, URL will be opened in the embedded browser.
    • Location Message Choice. When clicking the button, Google Map will be opened in the embedded browser.
    • Call Message Choice. When clicking the button, phone dial panel will be opened with prefilled number.

Carousel Message

WeChat

WeChat channel doesn't natively support Carousel messages. The following transcoding rules are applied to Conversation Carousel messages so they can be delivered on the WeChat channel.

All Cards are joined as a single message, for each card

  • Title: Converted to WeChat text.
  • Description: Converted to WeChat text.
  • Media: Converted to WeChat clickable links. Clicking the link will open media content.
  • Text Choices: Converted to WeChat clickable links. Clicking the link will send invisible postback_data back to the Conversation Callback URL. WeChat will also show link label in the chat Window.

    Text Choices

  • Call Choices: Converted to text after removed special characters from phone numbers. WeChat app will make a choice clickable if it detects valid phone number in the message. Clicking the phone number will display options such as Make Call, Send Message, etc.
  • Location Choice: Converted to Map URL. Refer to Location Message type for more details.
  • URL Choice: Converted to normal URL.

    Choices

Was this page helpful?