There are various types of raw (unstructured) content that can be sent to your users. There are various types of message content that can be sent to your users:
Property | Description | Required |
---|---|---|
type | TEXT | Y |
text | String | Y |
Property | Description | Required |
---|---|---|
type | IMAGE | Y |
url | URL of the image file | Y |
.jpg
, .jpeg
, .png
, .gif
, .tiff
and .bmp
Property | Description | Required |
---|---|---|
type | AUDIO | Y |
url | URL of the audio file | Y |
.aac
, .flac
, .m4a
, .m4p
, .mp3
, .wav
, .wma
Property | Description | Required |
---|---|---|
type | VIDEO | Y |
url | URL of the video file | Y |
.mkv
, .gif
, .avi
, .wmv
, .rmvb
, .mp4
, .m4v
, .mpg
, .mpeg
, .3gp
Property | Description | Required |
---|---|---|
type | FILE | Y |
url | URL of the file attachment | Y |
.pdf
Carousel is a horizontal scrollable row of items, each composed of an image attachment, short description and buttons to request input from users.
Property | Description | Required |
---|---|---|
type | CAROUSEL | Y |
carousel | Array of carousel items; No maximum no. of elements | Y |
carousel | Array of carousel items | Y |
image_aspect_ratio | Set "horizontal" or "square"; Defaults to "horizontal" | N |
Property | Description | Required |
---|---|---|
title | String | Y |
subtitle | String | N |
image_url | URL of the image displayed | N |
default_action | Default website URL when users click on the image | N |
buttons | Array of buttons | N |
Property | Description | Required |
---|---|---|
type | BUTTON | Y |
text | String; Limited to 640 characters | Y |
buttons | Array of buttons; Maximum of 3 buttons that appear as call-to-action | Y |
text | String | Y |
buttons | Array of buttons | Y |
The URL Button can be used to open a web page in a new tab within the same browser.
Property | Description | Required |
---|---|---|
type | web_url | Y |
title | String | Y |
url | URL of the destination | Y |
The Postback Button helps invoke an action (usually sending an answer back) in your chatbot. You can set a payload to the button.
Property | Description | Required |
---|---|---|
type | postback | Y |
title | String | Y |
payload | Custom defined payload triggers | Y |
The Call Button can be used to initiate a phone call directly.
Property | Description | Required |
---|---|---|
type | phone_number | Y |
title | String | Y |
payload | Format must have "+" prefix followed by the country code, area code and local number without any space | Y |
Quick Reply provide a different way to present buttons in a message. It contains text and an optional image.
The only difference between Quick Reply and Button is that Quick Reply only appears once and will be dismissed once it is clicked, while Button remains on the message even it is clicked. This prevents the scenario where users could tap on the old Quick Reply buttons attached to previous messages in the conversation.
Property | Description | Required |
---|---|---|
type | QUICK_REPLIES | Y |
text | String | Y |
quickReplies | Array of quick reply buttons | Y |
Property | Description | Required |
---|---|---|
content_type | Can be set to "text" only | Y |
title | String; caption of button | Y |
payload | Custom defined payload trigger | Y |
List is a vertical list view of items to your users.
Property | Description | Required |
---|---|---|
type | LIST | Y |
list | Array of list view elements | Y |
buttons | A button associated on the list template message at the very end; Maximum of 1 button | N |
top_element_style | Set "compact" or "large"; Defaults to "large" | N |
Property | Description | Required |
---|---|---|
title | String | Y |
subtitle | String | N |
image_url | URL of image displayed for each item; Required for the first element if top_element_style is large | N |
default_action | Default website URL when users click on the element row | N |
Media is similar to a carousel without title and subtitle but it can also display video.
Property | Description | Required |
---|---|---|
type | MEDIA | Y |
media_type | Set "image" or "video" | Y |
buttons | Array of buttons | N |
Web Action is sent custom data to your website through the web chat plugin.
Property | Description | Required |
---|---|---|
type | WEB_ACTION | Y |
data | String or Object | Y |
To receive the response on your website, please see payload trigger.