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 

Sample Payload
1{
2    "entryType": "Message",
3    "id": "5392c0d8-1009-4f02-8b5e-3d8caa9a2789",
4    "abstractMessage": {
5        "messageType": "ChoicesMessage",
6        "inReplyToMessageId": null,
7        "id": "5392c0d8-1009-4f02-8b5e-3d8caa9a2789",
8        "references": null,
9        "choices": {
10            "formatType": "Buttons",
11            "text": "Hi, I'm MIAWAURA, a digital assistant.",
12            "optionItems": [
13                {
14                    "itemType": "TitleOptionItem",
15                    "titleItem": {
16                        "itemType": "TitleItem",
17                        "secondarySubTitle": null,
18                        "title": "Order",
19                        "subTitle": null,
20                        "tertiarySubTitle": null,
21                        "referenceId": null
22                    },
23                    "optionIdentifier": "94934018-2864-4140-966c-8b13ef2d81c5",
24                    "optionId": null
25                },
26                {
27                    "itemType": "TitleOptionItem",
28                    "titleItem": {
29                        "itemType": "TitleItem",
30                        "secondarySubTitle": null,
31                        "title": "Problem",
32                        "subTitle": null,
33                        "tertiarySubTitle": null,
34                        "referenceId": null
35                    },
36                    "optionIdentifier": "bdaa48eb-afc9-4632-8e74-ad02c8b1e246",
37                    "optionId": null
38                },
39                {
40                    "itemType": "TitleOptionItem",
41                    "titleItem": {
42                        "itemType": "TitleItem",
43                        "secondarySubTitle": null,
44                        "title": "Product",
45                        "subTitle": null,
46                        "tertiarySubTitle": null,
47                        "referenceId": null
48                    },
49                    "optionIdentifier": "d895739c-750b-4ec8-8e6c-b793da2a2855",
50                    "optionId": null
51                }
52            ]
53        }
54    },
55    "messageReason": null
56}

QuickReplies 

Sample Payload
1{
2    "entryType": "Message",
3    "id": "3bc957a5-e9e5-4ae9-a429-37b3779f2735",
4    "abstractMessage": {
5        "messageType": "ChoicesMessage",
6        "inReplyToMessageId": null,
7        "id": "3bc957a5-e9e5-4ae9-a429-37b3779f2735",
8        "references": null,
9        "choices": {
10            "formatType": "QuickReplies",
11            "images": [],
12            "text": "Select a product",
13            "optionItems": [
14                {
15                    "itemType": "TitleOptionItem",
16                    "titleItem": {
17                        "itemType": "TitleItem",
18                        "secondarySubTitle": null,
19                        "title": "Good Choice",
20                        "subTitle": null,
21                        "tertiarySubTitle": null,
22                        "referenceId": null
23                    },
24                    "optionIdentifier": "d354dd81-4823-4cfb-a3e2-b28d0de1c19b",
25                    "optionId": null
26                },
27                {
28                    "itemType": "TitleOptionItem",
29                    "titleItem": {
30                        "itemType": "TitleItem",
31                        "secondarySubTitle": null,
32                        "title": "Great Choice",
33                        "subTitle": null,
34                        "tertiarySubTitle": null,
35                        "referenceId": null
36                    },
37                    "optionIdentifier": "fe5554ff-12cf-472d-811b-88d887000f9b",
38                    "optionId": null
39                }
40            ]
41        }
42    },
43    "messageReason": null
44}

Carousel 

Sample Payload
1{
2    "entryType": "Message",
3    "id": "0d31b1fd-8a22-453a-a37b-a3af7d95e586",
4    "abstractMessage": {
5        "messageType": "ChoicesMessage",
6        "inReplyToMessageId": null,
7        "id": "0d31b1fd-8a22-453a-a37b-a3af7d95e586",
8        "references": [
9            {
10                "recordId": "03SS70000004VbZ",
11                "id": "7e193224-041d-4c62-95a0-f0349733c613"
12            },
13            {
14                "recordId": "03SS70000004Vbe",
15                "id": "366f479f-58fa-432e-8103-44a7a7af3764"
16            },
17            {
18                "recordId": "03SS70000004VbP",
19                "id": "972014c0-552a-4127-a109-ee28f86efaab"
20            },
21            {
22                "recordId": "03SS70000004VbA",
23                "id": "bede8005-233e-41eb-a47f-ca09bf487f72"
24            }
25        ],
26        "choices": {
27            "formatType": "Carousel",
28            "items": [
29                {
30                    "titleItem": {
31                        "itemType": "TitleImageItem",
32                        "secondarySubTitle": null,
33                        "title": "skiing",
34                        "subTitle": "skiing subtitle",
35                        "tertiarySubTitle": null,
36                        "referenceId": null,
37                        "imageSubTitle": null,
38                        "imageId": "fc66a099-bf05-4687-95e8-f91008c249c3"
39                    },
40                    "interactionItems": [
41                        {
42                            "itemType": "TitleOptionItem",
43                            "titleItem": {
44                                "itemType": "TitleItem",
45                                "secondarySubTitle": null,
46                                "title": "Make a reservaton",
47                                "subTitle": null,
48                                "tertiarySubTitle": null,
49                                "referenceId": null
50                            },
51                            "optionIdentifier": "656a7079-8848-4940-484a-e9fa988dff01",
52                            "optionId": null
53                        }
54                    ]
55                },
56                {
57                    "titleItem": {
58                        "itemType": "TitleImageItem",
59                        "secondarySubTitle": null,
60                        "title": "Snowboarding",
61                        "subTitle": "Snowboarding Subtitle",
62                        "tertiarySubTitle": null,
63                        "referenceId": null,
64                        "imageSubTitle": null,
65                        "imageId": "571e3425-58d0-44ea-9964-61ce5b6da7ef"
66                    },
67                    "interactionItems": [
68                        {
69                            "itemType": "TitleOptionItem",
70                            "titleItem": {
71                                "itemType": "TitleItem",
72                                "secondarySubTitle": null,
73                                "title": "Make a reservaton",
74                                "subTitle": null,
75                                "tertiarySubTitle": null,
76                                "referenceId": null
77                            },
78                            "optionIdentifier": "c6990ede-9df5-b135-ce65-4c8e126a0145",
79                            "optionId": null
80                        }
81                    ]
82                },
83                {
84                    "titleItem": {
85                        "itemType": "TitleImageItem",
86                        "secondarySubTitle": null,
87                        "title": "Hiking",
88                        "subTitle": "Hiking Subtitle",
89                        "tertiarySubTitle": null,
90                        "referenceId": null,
91                        "imageSubTitle": null,
92                        "imageId": "bd8f4890-2640-4d94-8ac0-915155b672e8"
93                    },
94                    "interactionItems": [
95                        {
96                            "itemType": "TitleOptionItem",
97                            "titleItem": {
98                                "itemType": "TitleItem",
99                                "secondarySubTitle": null,
100                                "title": "Make a reservaton",
101                                "subTitle": null,
102                                "tertiarySubTitle": null,
103                                "referenceId": null
104                            },
105                            "optionIdentifier": "4c384ce6-e856-1f16-76a6-2b7bf894fa1b",
106                            "optionId": null
107                        }
108                    ]
109                },
110                {
111                    "titleItem": {
112                        "itemType": "TitleImageItem",
113                        "secondarySubTitle": null,
114                        "title": "Camping",
115                        "subTitle": "Camping Subtitle",
116                        "tertiarySubTitle": null,
117                        "referenceId": null,
118                        "imageSubTitle": null,
119                        "imageId": "8ffb4ca0-534d-4e52-ba8f-e4c7fec0ab16"
120                    },
121                    "interactionItems": [
122                        {
123                            "itemType": "TitleOptionItem",
124                            "titleItem": {
125                                "itemType": "TitleItem",
126                                "secondarySubTitle": null,
127                                "title": "Make a reservaton",
128                                "subTitle": null,
129                                "tertiarySubTitle": null,
130                                "referenceId": null
131                            },
132                            "optionIdentifier": "607eea44-baa5-401a-3229-9162a6bd2fda",
133                            "optionId": null
134                        }
135                    ]
136                }
137            ],
138            "images": [
139                {
140                    "assetType": "ImageAsset",
141                    "description": null,
142                    "id": "8ffb4ca0-534d-4e52-ba8f-e4c7fec0ab16",
143                    "mimeType": "image/jpeg",
144                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Campingsjpg?oid=00DS70000000Ty5&v=1",
145                    "referenceId": "bede8005-233e-41eb-a47f-ca09bf487f72"
146                },
147                {
148                    "assetType": "ImageAsset",
149                    "description": null,
150                    "id": "fc66a099-bf05-4687-95e8-f91008c249c3",
151                    "mimeType": "image/jpeg",
152                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Skiingsjpg?oid=00DS70000000Ty5&v=1",
153                    "referenceId": "7e193224-041d-4c62-95a0-f0349733c613"
154                },
155                {
156                    "assetType": "ImageAsset",
157                    "description": null,
158                    "id": "571e3425-58d0-44ea-9964-61ce5b6da7ef",
159                    "mimeType": "image/jpeg",
160                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Snowboardingsjpg?oid=00DS70000000Ty5&v=1",
161                    "referenceId": "366f479f-58fa-432e-8103-44a7a7af3764"
162                },
163                {
164                    "assetType": "ImageAsset",
165                    "description": null,
166                    "id": "bd8f4890-2640-4d94-8ac0-915155b672e8",
167                    "mimeType": "image/jpeg",
168                    "assetUrl": "https://de1.stmfb.file.stm.force.com/file-asset-public/Hikingsjpg?oid=00DS70000000Ty5&v=1",
169                    "referenceId": "972014c0-552a-4127-a109-ee28f86efaab"
170                }
171            ]
172        }
173    },
174    "messageReason": null
175}