Our messenger supports more interactions than just user messages. It is possible for our bots send and receive commands straight from the host page where our messenger is configured.
The host webpage of our ServisBOT Messenger can receive notifications from our server (internally known as HostNotification) HostNotifications can be sent by as a Botnet Action or Node and are emitted to the host webpage by our messenger. To listen out for these notifications you can do the following.
const sbMessenger = ServisBot.init({ ... }); // Initial configuration of our messenger
sbMessenger.on('notification', function(message) {
// At the moment the message is just a simple string notification
console.log(message);
});
Messenger sends a limited set of events to the host page which can be used to determine user interaction during a conversation session. Current supported events are listed below.
Your host page can be configured as follows to respond to Messenger Notifications
const sbMessenger = ServisBot.init({ ...your config params });
// Setup event listener to handle Messenger events
sbMessenger.on('Messenger', (event) => {
/*
* Each Messenger event has a type and a value
* the type is related to the specific interaction type
* of the event
*/
console.log(`Type: ${event.type}, Value: ${event.value}`);
});
Event fired when the user opens the Messenger Roundel
{
"type": "ROUNDEL",
"value": "Opened"
}
Event fired when the user closes the Messenger Roudel
{
"type": "ROUNDEL",
"value": "Closed"
}
Event fired when the user interacts with the conversation for the first time during their session.
{
"type": "CONVERSATION",
"value": "First User Interaction"
}
Event fired when Messenger has loaded a conversation, and is ready to receive messages
{
"type": "CONVERSATION",
"value": "Ready"
"identity": "COGNITO_IDENTITY" // Identifies the user within our system
"converationId", "CONVERSATION_ID" // Identifies the conversation within our system
}
Private Host Notifications are notifications that do not get emitted to the Messenger host webpage. Private Host Notifications are captured by Messenger and handled internally.
The supported Private Host Notifications are:
The SB:::MessengerStyle notification takes the following form SB:::MessengerStyle:::MESSENGER_STYLE_ATTRIBUTE:::MESSENGER_STYLE_VALUE. Where MESSENGER_STYLE_ATTRIBUTE is the style you would like to update eg. ROUNDEL_BACKGROUND_COLOR (the background color of messengers roundel) and MESSENGER_STYLE_VALUE is the value you would like to provide eg. #FF0000.
This would be configured as follows - SB:::MessengerStyle:::ROUNDEL_BACKGROUND_COLOR:::#FF0000
Supported customizable attributes include
| Attribute | Description | Supported Value |
|---|---|---|
| MESSENGER_NAME | Updates the current title of Messenger | CSS Hex Value |
| MESSENGER_SUBITITLE | Updates the current subtitle of Messenger | CSS Hex Value |
| MESSENGER_LOGO | Updates the current avatar of messages within Messenger | URL Value |
| MESSENGER_BACKGROUND_IMAGE | Updates the current background image of Messenger | URL Value |
| MESSENGER_ROUNDEL_ICON | Updates the current icon used by Messengers' Roundel | URL Value |
| HEADER_BACKGROUND_COLOR | Updates the current header background color of Messenger | CSS Hex Value |
| HEADER_TEXT_COLOR | Updates the current header text color within Messenger | CSS Hex Value |
| FOOTER_BACKGROUND_COLOR | Updates the current footer background color of Messenger | CSS Hex Value |
| FOOTER_TEXT_COLOR | Updates the current footer text color of Messenger | CSS Hex Value |
| ROUNDEL_BACKGROUND_COLOR | Updates the current Roundel background color | CSS Hex Value |
| ROUNDEL_ICON_COLOR | Updates the current Roundel Icon color | CSS Hex Value |
| MESSENGER_BACKGROUND_COLOR | Updates the current background color or Messenger | CSS Hex Value |
| FOOTER_DISABLED_BACKGROUND_COLOR | Updates the current background color used by Messenger when the textinput is disabled | CSS Hex Value |
| FOOTER_DISABLED_TEXT_COLOR | Updates the current text color used by Messenger when the textinput is disabled | CSS Hex Value |
| BOT_MESSAGE_BACKGROUND_COLOR | Updates the current bot message background color | CSS Hex Value |
| BOT_MESSAGE_TEXT_COLOR | Updates the current bot message text color | CSS Hex Value |
| BOT_MESSAGE_BACKGROUND_SECONDARY_COLOR | Updates the current bot message secondary background color | CSS Hex Value |
| BOT_MESSAGE_TEXT_SECONDARY_COLOR | Updates the current bot message secondary text color | CSS Hex Value |
| BOT_MESSAGE_TERTIARY_COLOR | Updates the current bot message tertiary color | CSS Hex Value |
| SELECTABLE_INDICATOR_COLOR | Updates the current selectable indicator color | CSS Hex Value |
| USER_MESSAGE_BACKGROUND_COLOR | Updates the current user message background color | CSS Hex Value |
| USER_MESSAGE_TEXT_COLOR | Updates the current user message text color | CSS Hex Value |
| READ_ONLY_LINK_COLOR | Updates the current read only link color | CSS Hex Value |
| LIST_HEADER_BACKGROUND_COLOR | Updates the current list header background color | CSS Hex Value |
| WATERMARK_COLOR | Updates the current watermark color | CSS Hex Value |
These can be configured as part of your flow using the hostNotification node and entering either value into the Notification Message field.
Sending a Notification from Host Page to Bot can be done using page events. You use the following command to send the page event
const context = {
"alias":"my-alias",
"body":{
"some": {
"data": {
"stored":"here"
}
}
}
}
sbMessenger.pageEvent(context);
data provided in the body of the event data will be available at payload.user.context.
A string is also supported for sending the alias only without the body
sbMessenger.pageEvent('my-alias');
For setting up the worker look here