Overview
The RCS carousel is a horizontally scrollable carousel of up to 10 vertical rich cards. Each card can include the following elements:
- Title text
- Subtitle text
- Image (which will be placed above the title, subtitle and buttons) - image is not required to be placed in a card
-
Up to 4 buttons (RCS limitation) with the following actions:
- Link
- Navigation
- Publish text
Carousel example image:
JSON Template Properties
| Property Name | Description | Type | Required |
|---|---|---|---|
| type | Types of basic elements supported by Structured Content framework. If using RCS Cards — type of header element should always be set to "vertical" or “horizontal,” per the wanted user experience. If using RCS Carousels — type of header element will always be “carousel” | Enum | Y |
| tag | Tag of template view, must be “generic” for RCS rich content templates. Within basic element objects, will be “title”/”subtitle”, which will indicate what text should be rendered in each of those elements (the title and subtitle have a default style in RCS) | Enum | Y |
| elements | Array of elements/templates. By using elements in your structured content template, you can send basic elements, such as simple text, images or buttons | Elements/Templates | Y |
| text | The message text in a “text” type element | String | Y |
| tooltip | Element tooltip. Used also for aira | String | N |
| url | Image URL in a “image” type element | String | Y |
| style | Basic structured content elements style object (for RCS this element will be ignored since style configuration is not supported) | Style elements | N |
| bold | Defines if text will be bold or not. Will always be set to ‘true’ in RCS cards and carousels. | Boolean | N |
| size | Defines the element size. Will always be set to ‘large’ in RCS cards and carousels. | Enum — small/medium/large | N |
| button | Buttons contain click and action properties that define the type of action set on user click operation | Object | N |
| click | Click objects contain the action type set on the click operation for each button | Object | N |
| action | Actions are a list of applicative user actions on buttons, which will run on the consumer side and will help them to achieve their operation. Button actions for RCS cards and carousels can be set to Publish text, Link or Navigate | Enum - “publishText”, “link”, “navigate” | N |
Carousel template code example
{
"type": "carousel",
"padding": 10,
"elements": [{
"type": "vertical",
"tag": "generic",
"elements": [{
"type": "vertical",
"elements": [{
"type": "image",
"url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRQ_w8UO-QDbk2S2ZLuiuePHB7j6Qb86DLsjwddhp_yq4WaL_LL",
"tooltip": "Flowers"
}, {
"type": "text",
"tag": "title",
"text": "Title",
"tooltip": "Title"
}, {
"type": "text",
"tag": "subtitle",
"text": "subtitle",
"tooltip": "subtitle"
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "publishText",
"text": "Add to cart pressed"
}]
}
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "link",
"name": "Flowers",
"uri": "https://www.pinterest.com/lyndawhite/beautiful-flowers/"
}]
}
}]
}]
},
{
"type": "vertical",
"tag": "generic",
"elements": [{
"type": "vertical",
"elements": [{
"type": "image",
"url": "https://i.pinimg.com/736x/cf/05/dc/cf05dc6becf9d387707597a788250a1c--blue-bridal-bouquets-bridal-flowers.jpg",
"tooltip": "Flowers"
}, {
"type": "text",
"tag": "title",
"text": "Title",
"tooltip": "Title"
}, {
"type": "text",
"tag": "subtitle",
"text": "subtitle",
"tooltip": "subtitle"
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "publishText",
"text": "Add to cart pressed"
}]
}
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "link",
"name": "Flowers",
"uri": "https://www.pinterest.com/lyndawhite/beautiful-flowers/"
}]
}
}]
}]
},
{
"type": "vertical",
"tag": "generic",
"elements": [{
"type": "vertical",
"elements": [{
"type": "image",
"url": "https://i.pinimg.com/736x/27/9a/d7/279ad7bfd3fe7ee87638a5ce064d25a5---year-old-girl-cut-flowers.jpg",
"tooltip": "Flowers"
}, {
"type": "text",
"tag": "title",
"text": "Title",
"tooltip": "Title"
}, {
"type": "text",
"tag": "subtitle",
"text": "subtitle",
"tooltip": "subtitle"
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "publishText",
"text": "Add to cart pressed"
}]
}
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "link",
"name": "Flowers",
"uri": "https://www.pinterest.com/lyndawhite/beautiful-flowers/"
}]
}
}]
}]
},
{
"type": "vertical",
"tag": "generic",
"elements": [{
"type": "vertical",
"elements": [{
"type": "image",
"url": "https://i.pinimg.com/736x/06/dc/b3/06dcb32c02c30a035b189ad267674f1c--pink-bouquet-floral-bouquets.jpg",
"tooltip": "Flowers"
}, {
"type": "text",
"tag": "title",
"text": "Title",
"tooltip": "Title"
}, {
"type": "text",
"tag": "subtitle",
"text": "subtitle",
"tooltip": "subtitle"
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "publishText",
"text": "Add to cart pressed"
}]
}
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "link",
"name": "Flowers",
"uri": "https://www.pinterest.com/lyndawhite/beautiful-flowers/"
}]
}
}]
}]
},
{
"type": "vertical",
"tag": "generic",
"elements": [{
"type": "vertical",
"elements": [{
"type": "image",
"url": "https://i.pinimg.com/736x/a8/28/26/a8282621d4fe30717de5fab28975b7a3--pink-peonies-pink-flowers.jpg",
"tooltip": "Flowers"
}, {
"type": "text",
"tag": "title",
"text": "Title",
"tooltip": "Title"
}, {
"type": "text",
"tag": "subtitle",
"text": "subtitle",
"tooltip": "subtitle"
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "publishText",
"text": "Add to cart pressed"
}]
}
}, {
"type": "button",
"tooltip": "Add to cart",
"title": "Add to cart",
"click": {
"actions": [{
"type": "link",
"name": "Flowers",
"uri": "https://www.pinterest.com/lyndawhite/beautiful-flowers/"
}]
}
}]
}]
}
]
}