Rich Media Message Buttons
Following is the JSON format for rich media message buttons used in the Conversationnode.
In most circumstances, you won't need this much detail. The user interface and documentation for the Conversationnode are sufficient. This detail may be of value to you if you want more information on the rich media buttons or you want to generate your own buttons from the conversation node advanced tab.
Link Buttons
The recipient clicks the link to open the URL in a new page in their web browser.
The node “object“ contains the payload.
{
"contentType": "LINK_BUTTON","object": {"text": "Click to visit the Five9 website","url": "https://www.five9.com/","default": false,"attributes": {"key" : "value","boolean" : true}}
}
|
Attribute |
Required |
Description |
|---|---|---|
|
text |
Yes |
Supply text for the button label. The recipient sees this text on the button. |
|
url |
Yes |
When the recipient clicks the link, the URL opens in a new page in their web browser. |
|
attributes |
Optional |
JSON object as key-value map. |
Reply Buttons
Commonly, the recipient receives more than one reply button in a message. Each reply button represents an option. The recipient clicks a reply button to make their choice and the other reply buttons disappear.
You cannot combine reply buttons with other types of buttons in the same message.
The node “object“ contains the payload.
{
"contentType": "REPLY_BUTTON","object": {"text": "Option One","response": "Clicked option one","image": "https://www.freeiconspng.com/img/44207","attributes": {"key": "value","boolean": true}}
}
|
Attribute |
Required |
Description |
|---|---|---|
|
text |
Yes |
Supply text for the button label. The recipient sees this text on the button. |
|
response |
Yes |
When the recipient clicks the button, the call flow routes to this node. |
|
image |
Optional |
To add an icon to the button label, supply the public URL to the icon. |
|
attributes |
Optional |
JSON object as key-value map. |
Postback Buttons
Once the recipient receives the postback button, they can click it any time in the conversation. They can click it multiple times in the conversation. Postback buttons do not disappear when clicked or when the conversation moves to the next message.
The node “object“ contains the payload.
{
"contentType": "POSTBACK_BUTTON","object": {"text": "Transfer to Agent","response": "QWERTY-1028434","attributes": {"key": "value","boolean": true}}
}
|
Attribute |
Required |
Description |
|---|---|---|
|
text |
Yes |
Supply text for the button label. The recipient sees this text on the button. |
|
response |
Yes |
When the recipient clicks the button, the call flow routes to this node. |
|
attributes |
Optional |
JSON object as key-value map. |
Location Buttons
Send this button to receive the location of the recipient.
{
"contentType": "LOCATION_REQUEST_BUTTON","object": {"text": "Click to send us your location","attributes": {"key": "value","boolean": true}}
}
|
Attribute |
Required |
Description |
|---|---|---|
|
text |
Yes |
Supply text for the button label. The recipient sees this text on the button. |
|
attributes |
Optional |
JSON object as key-value map. |