Skip to main content

Message Types

QuickReplies Message PreviewQuickReplies Message Preview
PayloadPreview

Text

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"text": "Welcome!"
}
}
Text Message Preview

Image

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"attachment": {
"type": "image",
"payload": {
"url": "https://xxxxxxxx.jpg"
}
}
}
}
Image Message Preview

Video

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"attachment": {
"type": "video",
"payload": {
"url": "https://xxxxxxxx.mp4"
}
}
}
}
Video Message Preview

File

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"attachment": {
"type": "file",
"payload": {
"url": "https://xxxxxxxx.pdf"
}
}
}
}
File Message Preview

Audio

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"attachment": {
"type": "audio",
"payload": {
"url": "https://xxxxxxxx.mp3"
}
}
}
}
Audio Message Preview

RichText

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message":{
"text":"xxx",
"fallback":"xxx",
"containsRichText":"true"
}
}
RichText Message Preview

RichCard

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"fallback": "xxxxx",
"richCard": {
"standaloneCard": {
"cardContent": {
"title": "Hello, world!",
"description": "Sent with Business Messages.",
"media": {
"height": "TALL",
"contentInfo": {
"altText": "xxxx",
"fileUrl": "https://xxxxxxxx.png",
"forceRefresh": "false"
}
},
"suggestions": [
{
"reply": {
"text": "Suggestion #1",
"postbackData": "suggestion_1"
}
},
{
"reply": {
"text": "Suggestion #2",
"postbackData": "suggestion_2"
}
}
]
}
}
}
}
}
Rich Card Example

RichCardCarousel

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"fallback": "xxx",
"richCard": {
"carouselCard": {
"cardWidth": "MEDIUM",
"cardContents": [
{
"title": "Card #1",
"description": "The description for card #1",
"suggestions": [
{
"reply": {
"text": "Card #1",
"postbackData": "card_1"
}
}
],
"media": {
"height": "MEDIUM",
"contentInfo": {
"fileUrl": "https://xxxxxxxx.png",
"forceRefresh": "false"
}
}
},
{
"title": "Card #2",
"description": "The description for card #2",
"suggestions": [
{
"reply": {
"text": "Card #2",
"postbackData": "card_2"
}
}
],
"media": {
"height": "MEDIUM",
"contentInfo": {
"fileUrl": "https://xxxxxxxx.png",
"forceRefresh": "false"
}
}
}
]
}
}
}
}
Rich Card Carousel Example

QuickReplies

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"messaging_type": "RESPONSE",
"message": {
"text": "Pick a color:",
"quick_replies": [
{
"content_type": "text",
"title": "xxx",
"payload": "<POSTBACK_PAYLOAD>",
"image_url": "https://xxxxxxxx.png"
},
{
"content_type": "text",
"title": "xxx",
"payload": "<POSTBACK_PAYLOAD>",
"image_url": "https://xxxxxxxx.png"
}
]
}
}

SuggestionResponse

{
"conversation_id": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx",
"message": {
"type": "suggestionResponse",
"text": "xxx",
"postbackData": "xxx"
}
}