| Message type | Content type | Allowed to POST? | Example of content | Notes |
|---|---|---|---|---|
| Message | string | ok | "This is a typical message!" |
You may receive HTML on GET messages. When you POST a message, the content will be HTML encoded. On POST (sending a message), these BBCode patterns become html [br] to <br /> [b] to <b> [/b] to </b> |
| Event | string | no | "USER_CONNECTED" |
Different events: |
| Intro | object | no |
{
"welcomeHeader": "Welcome to my chat solution",
"welcomeBody": "We are open for business",
"variables": [
{
"name": "Name",
"value": "Jan",
"secret": false
},
{
"name": " ID",
"value": "jan.rygh@puzzel.com",
"secret": false
},
{
"name": "Number of requests in queue",
"value": "1",
"secret": false
},
{
"name": "Favorite Color",
"value": "green",
"secret": false
}
]
} |
|
| Option | Array of strings | no | [ "Option 1", "This is option 2", "And this is number three" ] |
|
| OptionResult | object | ok |
{
"messageId": 762719,
"optionChoice": "This is option 2",
"cancelled": false
} |
|
| Command | object | no |
{
"command": "cobrowseCommand",
"commandId": "cobrowse_12345",
"showButton":true,
"buttonText":"Start",
"headerText":"Cobrowsing",
"stateText":"The cowbrosing session is initiated",
"data": {"code":"skdjhk-kjksdjhk-skj "}
} |
|
| Reaction | object | ok |
{
"messageId": 762726,
"reaction": "LIKE"
} |
reaction can be one of "LIKE","DISLIKE" or "CANCEL" |
| UserInfo | object | no |
{
"userType": "Human",
"avatarUrl": "",
} |
userType can be one of "Human" or "Bot". |
| JsonTemplate | object | no |
{
"template": "genericCard",
"image": {
"alt": "Photo of Lars Ropeid Selsås, CEO",
"position": "top",
"url": "https://static1.squarespace.com/static/5a82e68c4c326d50016f26b5/t/5ad991b0352f53638f5ff813/1524208053281/Lars-Ropeid-Selsas.jpg?format=750w"
},
"heading": {
"text": "Lars Ropeid Selsås"
},
"link": {
"text": "boost.ai",
"url": "https://www.boost.ai/about#block-yui_3_17_2_1_1540382792367_32636"
},
"body": {
"text": "Lars Ropeid Selsås is the Founder and Chief Exective Officer at boost.ai."
}
}
|
Not defined yet |