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:

{
  "app_id": "{{APP_ID}}",
  "recipient": {
    "contact_id": "{{CONTACT_ID}}"
  },
  "message": {
    "carousel_message": {
      "cards": [
        {
          "title": "Sign up for our newsletter",
          "description": "Our weekly newsletter is filled with deals and extra content!",
          "media_message": {
            "url": "https://1vxc0v12qhrm1e72gq1mmxkf-wpengine.netdna-ssl.com/wp-content/uploads/2019/05/Sinch-logo-Events.png"
          },
          "choices": [
            {
              "text_message": {
                "text": "Sign up here"
              }
            }
          ]
        },
        {
          "title": "Visit our website",
          "description": "You can view your account and place orders from our convenient dashboard.",
          "media_message": {
            "url": "https://1vxc0v12qhrm1e72gq1mmxkf-wpengine.netdna-ssl.com/wp-content/uploads/2019/05/Sinch-logo-Events.png"
          },
          "choices": [
            {
              "url_message": {
                "title": "Website",
                "url": "https://www.sinch.com"
              }
            }
          ]
        },
        {
          "title": "Call our customer support line",
          "description": "Our dedicated support staff can answer your questions and concerns.",
          "media_message": {
            "url": "https://1vxc0v12qhrm1e72gq1mmxkf-wpengine.netdna-ssl.com/wp-content/uploads/2019/05/Sinch-logo-Events.png"
          },
          "choices": [
            {
              "call_message": {
                "title": "Support line",
                "phone_number": "46732000000"
              }
            }
          ]
        }
      ]
    }
  }
}

The follow sections give examples of how carousel messages are rendered in each channel.

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.

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.