Message Types: Outbound

Text

{
    "type": "text",
    "text": "Hello"
}

Image

{
    "type": "image",
    "originalUrl": "http://news-events.sleeping-out.co.za/wp-content/uploads/2015/11/rock-climbing.jpg"
}

Audio

{
    "type": "audio",
    "url": "https://www.buildquickbots.com/whatsapp/media/sample/audio/sample02.mp3"
}

Video

{
    "type": "video",
    "url": "https://www.buildquickbots.com/whatsapp/media/sample/video/sample02.mp4"
}

File

{
    "type": "file",
    "url": "https://www.buildquickbots.com/whatsapp/media/sample/excel/sample02.xlsx"
}

Quick Reply With Text Content

{
    "type": "quick_reply",
    "msgid": "msg001",
    "content": {
        "type": "text",
        "text": "What's your favourite color?"
    },
    "options": [
        "Red",
        "Green",
        "Yellow",
        "Blue"
    ]
}

Quick Reply with Image Content

{
    "type": "quick_reply",
    "msgid": "qr1",
    "content": {
        "type": "image",
        "url": "https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg",
        "text": "this is the body",
        "caption": "this is the footer"
    },
    "options": [
        {
            "type": "text",
            "title": "First",
            "postbackText": "dev-defined-postback1"
        },
        {
            "type": "text",
            "title": "Second",
            "postbackText": "dev-defined-postback2"
        }
    ]
}

Quick Reply with Video Content

{
    "type": "quick_reply",
    "msgid": "qr1",
    "content": {
        "type": "video",
        "url": "https://www.buildquickbots.com/whatsapp/media/sample/video/sample01.mp4",
        "text": "this is the body",
        "caption": "Sample video"
    },
    "options": [
        {
            "type": "text",
            "title": "First",
            "postbackText": "dev-defined-postback1"
        },
        {
            "type": "text",
            "title": "Second",
            "postbackText": "dev-defined-postback2"
        }
    ]
}

Quick Reply with Audio Content

{
    "type": "quick_reply",
    "content": {
        "type": "audio",
        "url": "https://www.buildquickbots.com/whatsapp/media/sample/audio/sample02.mp3"
    },
    "msgid": "rtyertaa",
    "options": [
        {
            "type": "text",
            "title": "Red",
            "iconurl": "http://www.freeiconspng.com/uploads/hand-like-thumb-icon--1.png"
        },
        {
            "type": "text",
            "title": "Blue",
            "iconurl": "http://www.freeiconspng.com/uploads/hand-like-thumb-icon--1.png"
        }
    ]
}

Quick Reply with File Content

{
    "type": "quick_reply",
    "msgid": "qr1",
    "content": {
        "type": "file",
        "url": "https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf",
        "text": "this is the body",
        "filename": "Sample file",
        "caption": "this is the footer"
    },
    "options": [
        {
            "type": "text",
            "title": "First",
            "postbackText": "dev-defined-postback1"
        },
        {
            "type": "text",
            "title": "Second",
            "postbackText": "dev-defined-postback2"
        }
    ]
}

Quick Reply with content Catalog

{
    "type": "quick_reply",
    "content": {
        "type": "catalogue",
        "imageaspectratio": "horizontal",
        "msgid": "cat_212",
        "items": [
            {
                "title": "White T Shirt",
                "subtitle": "Soft cotton t-shirt \nXs, S, M, L \n$10",
                "imgurl": "http://logonoid.com/images/batman-logo.png",
                "options": [
                    {
                        "type": "url",
                        "title": "View Details",
                        "url": "http://logonoid.com/images/batman-logo.png"
                    },
                    {
                        "type": "text",
                        "title": "Buy"
                    }
                ]
            }
        ]
    },
    "msgid": "rtyertaa",
    "options": [
        {
            "type": "text",
            "title": "Red",
            "iconurl": "http://www.freeiconspng.com/uploads/hand-like-thumb-icon--1.png"
        }
    ]
}

Survey

{
    "type": "survey",
    "question": "What would you like to do?",
    "msgid": "3er45",
    "options": [
        {
            "type": "url",
            "title": "view website",
            "url": "https://www.google.com/intl/en/chrome/demos/speech.html",
            "webview_height_ratio": "compact"
        }
    ]
}

Poll

{
    "type": "poll",
    "question": "Do you like ice-cream?"
}

Catalog

{
    "type": "catalogue",
    "message": "Choose any one of the following Catalogues:",
    "tag": "SHIPPING_UPDATE",
    "msgid": "gts123",
    "items": [
        {
            "title": "White T Shirt",
            "subtitle": "Soft cotton t-shirt \nXs, S, M, L \n",
            "imgurl": "https://ichef.bbci.co.uk/news/976/media/images/83351000/jpg/_83351965_explorer273lincolnshirewoldssouthpicturebynicholassilkstone.jpg",
            "defaultaction": {
                "type": "url",
                "title": "View Details",
                "url": "https://ichef.bbci.co.uk/news/976/media/images/83351000/jpg/_83351965_explorer273lincolnshirewoldssouthpicturebynicholassilkstone.jpg"
            },
            "options": [
                {
                    "type": "url",
                    "title": "Go to New FLow",
                    "url": "https://www.messenger.com/t/573295509671844?ref=eyJpbml0RmxvdyI6IkZsb3dCdWlsZGVyMDA5In0="
                },
                {
                    "type": "text",
                    "title": "Buy"
                }
            ]
        },
        {
            "title": "Grey T Shirt",
            "subtitle": "Soft cotton t-shirt \nXs, S, M, L \n",
            "imgurl": "https://static.pexels.com/photos/132037/pexels-photo-132037.jpeg",
            "options": [
                {
                    "type": "url",
                    "title": "View Details",
                    "url": "https://static.pexels.com/photos/132037/pexels-photo-132037.jpeg"
                },
                {
                    "type": "text",
                    "title": "Buy"
                }
            ]
        }
    ]
}

Recurring Notification Optin Request

{
    "type": "notification_optin",
    "imageURL": "https://media.contentapi.ea.com/content/dam/gin/images/2021/06/battlefield-2042-key-art.jpg.adapt.crop1x1.767p.jpg",
    "title": "Recurring Notifications Test",
    "postbackText": "Get the latest updates from the world of gaming",
    "frequency": "DAILY",
    "reOptin": true,
    "timezone": "Asia/Kolkata"
}

Recurring Notification

{
    "type": "text",
    "text": "Notification Message",
    "notificationToken": "6462548630986684668"
}

One-Time Notification Optin

{
    "type": "one_time_notification_optin",
    "title": "OT notification Title",
    "postbackText": "OT notification payload"
}

Follow UP Message Send To User Using One Time Notification Token

{
    "type": "text",
    "text": "Hello ",
    "oneTimeNotificationToken": "1706513330031914567"
}