twilio/carousel

Twilio/carousel is a low friction, yet highly rich way to send an end user a selection of your services, products, or any options that fit the conversation.

• Send a horizontally scrolling list of carousel cards.
• Send media, text, call to action buttons, and quick reply buttons in each carousel card.
• Send any combination of quick reply, url, and phone call buttons in each card. Multiple of the same type of buttons are also allowed so long as there are 1 to 2 buttons in each card.
• Media can be images or videos.

WhatsApp, RCS (Coming Soon)

1. Have media URLs for each card ready prior to template creation.
2. Create twilio/carousel content template.
3. If it will be used on WhatsApp, approve the template.
4. Send the Content Template containing the carousel.

To send a Carousel to open a business initiated session or to reply within a 24 hour user initiated session, template approval is required.

body:

• Type: string
• Required: Yes
• Variable Support: Yes
• Description: Content of the initial message delivered to the end user above the carousel.

cards:

• Type: array
• Required: Yes
• Variable Support: No
• Description: Array of Carousel cards to be sent

title:

• Type: string
• Required: No
• Variable Support: Yes
• Description: Header text of each carousel card. Max character limit is 160 combined with body text.

body:

• Type: string
• Required: Yes
• Variable Support: Yes
• Description: Body text of each carousel card. Max character limit is 160 combined with body text.

media:

• Type: string
• Required: Yes
• Variable Support: Yes
• Description: The URL of the media appearing as the header of each card. Variables are only supported after the domain. For example: www.twilio.com/images/{{1}} . Only images and videos are supported within carousels.

actions:

• Type: array
• Required: Yes
• Variable Support: Yes
• Description: All Carousels must contain at least 1 button and at most 2 buttons. Buttons are defined using the actions array.

QUICK_REPLY:

• parameters
  • type: QUICK_REPLY
  • title: Button text of quick reply button. Appears in Body and ButtonText fields in inbound when selected by end user.
  • id: Not visible to end user. Appears in ButtonPayload fields in inbound when selected by end user.

URL:

• parameters
  • type: URL
  • title: Button text of URL redirect button. Variables are not supported. Max 25 chars.
  • url: URL opened when end user clicks the button. Variables are supported at the end of the url string.

PHONE:

• parameters
  • type: PHONE
  • title: Button text of URL redirect button. Variables are not supported. Max 25 chars.
  • phone: Phone number to call when the recipient taps the button. E.164 formatted. Variables are not supported.

Sending a carousel template using content templates is the same as sending other types of Content Templates. Click here to see an in-depth guide for how to send Content templates.