ChoicesMessage

The ChoicesMessage message type supports multiple format types, including Buttons, QuickReplies, and Carousel. See Format Types for a list of supported message types and the format types they support.

Buttons

{
    "entryType": "Message",
    "id": "5392c0d8-1009-4f02-8b5e-3d8caa9a2789",
    "abstractMessage": {
        "messageType": "ChoicesMessage",
        "inReplyToMessageId": null,
        "id": "5392c0d8-1009-4f02-8b5e-3d8caa9a2789",
        "references": null,
        "choices": {
            "formatType": "Buttons",
            "text": "Hi, I'm MIAWAURA, a digital assistant.",
            "optionItems": [
                {
                    "itemType": "TitleOptionItem",
                    "titleItem": {
                        "itemType": "TitleItem",
                        "secondarySubTitle": null,
                        "title": "Order",
                        "subTitle": null,
                        "tertiarySubTitle": null,
                        "referenceId": null
                    },
                    "optionIdentifier": "94934018-2864-4140-966c-8b13ef2d81c5",
                    "optionId": null
                },
                {
                    "itemType": "TitleOptionItem",
                    "titleItem": {
                        "itemType": "TitleItem",
                        "secondarySubTitle": null,
                        "title": "Problem",
                        "subTitle": null,
                        "tertiarySubTitle": null,
                        "referenceId": null
                    },
                    "optionIdentifier": "bdaa48eb-afc9-4632-8e74-ad02c8b1e246",
                    "optionId": null
                },
                {
                    "itemType": "TitleOptionItem",
                    "titleItem": {
                        "itemType": "TitleItem",
                        "secondarySubTitle": null,
                        "title": "Product",
                        "subTitle": null,
                        "tertiarySubTitle": null,
                        "referenceId": null
                    },
                    "optionIdentifier": "d895739c-750b-4ec8-8e6c-b793da2a2855",
                    "optionId": null
                }
            ]
        }
    },
    "messageReason": null
}

QuickReplies

{
    "entryType": "Message",
    "id": "3bc957a5-e9e5-4ae9-a429-37b3779f2735",
    "abstractMessage": {
        "messageType": "ChoicesMessage",
        "inReplyToMessageId": null,
        "id": "3bc957a5-e9e5-4ae9-a429-37b3779f2735",
        "references": null,
        "choices": {
            "formatType": "QuickReplies",
            "images": [],
            "text": "Select a product",
            "optionItems": [
                {
                    "itemType": "TitleOptionItem",
                    "titleItem": {
                        "itemType": "TitleItem",
                        "secondarySubTitle": null,
                        "title": "Good Choice",
                        "subTitle": null,
                        "tertiarySubTitle": null,
                        "referenceId": null
                    },
                    "optionIdentifier": "d354dd81-4823-4cfb-a3e2-b28d0de1c19b",
                    "optionId": null
                },
                {
                    "itemType": "TitleOptionItem",
                    "titleItem": {
                        "itemType": "TitleItem",
                        "secondarySubTitle": null,
                        "title": "Great Choice",
                        "subTitle": null,
                        "tertiarySubTitle": null,
                        "referenceId": null
                    },
                    "optionIdentifier": "fe5554ff-12cf-472d-811b-88d887000f9b",
                    "optionId": null
                }
            ]
        }
    },
    "messageReason": null
}

Carousel

{
    "entryType": "Message",
    "id": "0d31b1fd-8a22-453a-a37b-a3af7d95e586",
    "abstractMessage": {
        "messageType": "ChoicesMessage",
        "inReplyToMessageId": null,
        "id": "0d31b1fd-8a22-453a-a37b-a3af7d95e586",
        "references": [
            {
                "recordId": "03SS70000004VbZ",
                "id": "7e193224-041d-4c62-95a0-f0349733c613"
            },
            {
                "recordId": "03SS70000004Vbe",
                "id": "366f479f-58fa-432e-8103-44a7a7af3764"
            },
            {
                "recordId": "03SS70000004VbP",
                "id": "972014c0-552a-4127-a109-ee28f86efaab"
            },
            {
                "recordId": "03SS70000004VbA",
                "id": "bede8005-233e-41eb-a47f-ca09bf487f72"
            }
        ],
        "choices": {
            "formatType": "Carousel",
            "items": [
                {
                    "titleItem": {
                        "itemType": "TitleImageItem",
                        "secondarySubTitle": null,
                        "title": "skiing",
                        "subTitle": "skiing subtitle",
                        "tertiarySubTitle": null,
                        "referenceId": null,
                        "imageSubTitle": null,
                        "imageId": "fc66a099-bf05-4687-95e8-f91008c249c3"
                    },
                    "interactionItems": [
                        {
                            "itemType": "TitleOptionItem",
                            "titleItem": {
                                "itemType": "TitleItem",
                                "secondarySubTitle": null,
                                "title": "Make a reservaton",
                                "subTitle": null,
                                "tertiarySubTitle": null,
                                "referenceId": null
                            },
                            "optionIdentifier": "656a7079-8848-4940-484a-e9fa988dff01",
                            "optionId": null
                        }
                    ]
                },
                {
                    "titleItem": {
                        "itemType": "TitleImageItem",
                        "secondarySubTitle": null,
                        "title": "Snowboarding",
                        "subTitle": "Snowboarding Subtitle",
                        "tertiarySubTitle": null,
                        "referenceId": null,
                        "imageSubTitle": null,
                        "imageId": "571e3425-58d0-44ea-9964-61ce5b6da7ef"
                    },
                    "interactionItems": [
                        {
                            "itemType": "TitleOptionItem",
                            "titleItem": {
                                "itemType": "TitleItem",
                                "secondarySubTitle": null,
                                "title": "Make a reservaton",
                                "subTitle": null,
                                "tertiarySubTitle": null,
                                "referenceId": null
                            },
                            "optionIdentifier": "c6990ede-9df5-b135-ce65-4c8e126a0145",
                            "optionId": null
                        }
                    ]
                },
                {
                    "titleItem": {
                        "itemType": "TitleImageItem",
                        "secondarySubTitle": null,
                        "title": "Hiking",
                        "subTitle": "Hiking Subtitle",
                        "tertiarySubTitle": null,
                        "referenceId": null,
                        "imageSubTitle": null,
                        "imageId": "bd8f4890-2640-4d94-8ac0-915155b672e8"
                    },
                    "interactionItems": [
                        {
                            "itemType": "TitleOptionItem",
                            "titleItem": {
                                "itemType": "TitleItem",
                                "secondarySubTitle": null,
                                "title": "Make a reservaton",
                                "subTitle": null,
                                "tertiarySubTitle": null,
                                "referenceId": null
                            },
                            "optionIdentifier": "4c384ce6-e856-1f16-76a6-2b7bf894fa1b",
                            "optionId": null
                        }
                    ]
                },
                {
                    "titleItem": {
                        "itemType": "TitleImageItem",
                        "secondarySubTitle": null,
                        "title": "Camping",
                        "subTitle": "Camping Subtitle",
                        "tertiarySubTitle": null,
                        "referenceId": null,
                        "imageSubTitle": null,
                        "imageId": "8ffb4ca0-534d-4e52-ba8f-e4c7fec0ab16"
                    },
                    "interactionItems": [
                        {
                            "itemType": "TitleOptionItem",
                            "titleItem": {
                                "itemType": "TitleItem",
                                "secondarySubTitle": null,
                                "title": "Make a reservaton",
                                "subTitle": null,
                                "tertiarySubTitle": null,
                                "referenceId": null
                            },
                            "optionIdentifier": "607eea44-baa5-401a-3229-9162a6bd2fda",
                            "optionId": null
                        }
                    ]
                }
            ],
            "images": [
                {
                    "assetType": "ImageAsset",
                    "description": null,
                    "id": "8ffb4ca0-534d-4e52-ba8f-e4c7fec0ab16",
                    "mimeType": "image/jpeg",
                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Campingsjpg?oid=00DS70000000Ty5&v=1",
                    "referenceId": "bede8005-233e-41eb-a47f-ca09bf487f72"
                },
                {
                    "assetType": "ImageAsset",
                    "description": null,
                    "id": "fc66a099-bf05-4687-95e8-f91008c249c3",
                    "mimeType": "image/jpeg",
                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Skiingsjpg?oid=00DS70000000Ty5&v=1",
                    "referenceId": "7e193224-041d-4c62-95a0-f0349733c613"
                },
                {
                    "assetType": "ImageAsset",
                    "description": null,
                    "id": "571e3425-58d0-44ea-9964-61ce5b6da7ef",
                    "mimeType": "image/jpeg",
                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Snowboardingsjpg?oid=00DS70000000Ty5&v=1",
                    "referenceId": "366f479f-58fa-432e-8103-44a7a7af3764"
                },
                {
                    "assetType": "ImageAsset",
                    "description": null,
                    "id": "bd8f4890-2640-4d94-8ac0-915155b672e8",
                    "mimeType": "image/jpeg",
                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Hikingsjpg?oid=00DS70000000Ty5&v=1",
                    "referenceId": "972014c0-552a-4127-a109-ee28f86efaab"
                }
            ]
        }
    },
    "messageReason": null
}