All examples below must be sent within the body field of a message as shown below
Copy {
"receiver" : {
"contacts" : [
{
"identifierValue" : "+31612345678"
}
]
} ,
"body" : {...}
} Single cards
A carousel can contain between 1-10 cards. Each card must contain:
One of description, mediaUrl, actions
mediaURL must be a supported image type
A card supports up between 1-3 actions and can be a mix of reply, postback and url buttons
Single card with title and description
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card"
}
]
}
} Facebook
Instagram
Single card with title, description and actions
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
}
]
}
} Facebook
Instagram
Single card with image, title, description and actions
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card" ,
"mediaUrl" : "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
}
]
}
} Facebook
Instagram
Multiple cards
A carousel can contain up to 10 cards.
The format of each card can either be the same or mixed e.g. one card with title and description and one card with title, description and actions. Generally for display purposes it is recommend to keep the format of cards similar.
Multiple cards with title and description
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card"
} ,
{
"title" : "Card 2" ,
"description" : "Second card"
} ,
{
"title" : "Card 3" ,
"description" : "Third card"
}
]
}
} Facebook
Instagram
Multiple cards with title, description and actions
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
} ,
{
"title" : "Card 2" ,
"description" : "Second card" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
} ,
{
"title" : "Card 3" ,
"description" : "Third card" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
}
]
}
} Facebook
Instagram
Multiple cards with image title, description and actions
Body
Copy {
"type" : "carousel" ,
"carousel" : {
"items" : [
{
"title" : "Card 1" ,
"description" : "First card" ,
"mediaUrl" : "https://pbs.twimg.com/profile_images/1546538670936801280/ZBIxKfMq_400x400.jpg" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
} ,
{
"title" : "Card 2" ,
"description" : "Second card" ,
"mediaUrl" : "https://file-examples.com/storage/fe0d8be18a64c77e29903d0/2017/10/file_example_PNG_500kB.png" ,
"actions" : [
{
"type" : "reply" ,
"reply" : {
"text" : "reply"
}
} ,
{
"type" : "postback" ,
"postback" : {
"text" : "postback" ,
"payload" : "postback"
}
} ,
{
"type" : "link" ,
"link" : {
"url" : "https://www.messagebird.com" ,
"text" : "Visit MessageBird"
}
}
]
}
]
}
} Facebook
Instagram
Last updated 9 months ago
