Service Object

id

STRING

unique service identifier

name

STRING

service name

enableService

BOOLEAN

enable/disable service

checkMediaUrl

STRING

url of the REST webservice to check agent availability

checkMediaInterval

NUMBER

milliseconds every how much the checkmedia must be called

widget

STRING

widget id associated with the service

enableChat

BOOLEAN

enable/disable chat channel

enableCallbackNow

BOOLEAN

enable/disable callback now

enableCallbackLater

BOOLEAN

enable/disable callback later

enableClickToCall

BOOLEAN

enable/disable click to call

enableScreensharing

BOOLEAN

enable/disable screen sharing

restart_chat

BOOLEAN

When a chat contact is terminated, configure to show again or not the engagement widget

enableVideo

BOOLEAN

video escalation option available during interaction

enableAudioNotifcation

BOOLEAN

Play a audio alert for each message received without focus on the page

audioNotificationUrl

STRING

path to file audio to be reproduced for audio notification

enableBrowserNotification

BOOLEAN

Show browser notification for each message reveiced without focus on the page

enableSendLink

BOOLEAN

Enable feature for sending links (customer side)

enableSendDocument

BOOLEAN

Enable feature for sending documents (customer side)

enableSendImageFeature

BOOLEAN

Enable feature for sending images (both agent and customer side)

enableSendDocumentFeature

BOOLEAN

Enable feature for sending documents (both agent and customer side)

compatibilityErrorMessage

LOCALIZED STRING : accepts a string representing the label to be displayed or an object whose key is the country code and whose value is the relative label to be displayed.
Example:
{
"it-it" : "Messaggio italiano",
"en-gb" : "English message"
}

Message to show if widget is not compatible based on parameters configured in generalSettings (browserCompatibility, deviceCompatibility)

rules

STRING

list of entrypoints identified by webpage URL. Entrypoint is evaluated as regular expression against with the page URL

datacollection

ARRAY

list of datacollection id enabled

custom_css

STRING

path to custom css file

logo

STRING

path to logo image

language

STRING

country code of the language used. can be overwritten by query string param in the sdk url or by language_fn parameter

language_fn

STRING

custom function to set language

proactivity

OBJECT

object containing the proactivity rules. Please see the table below for the complete list of the properties.

callbackNowParameters

STRING

string rapresentation of a JSON object with the parameters passed to the callback now request

callbackLaterParameters

STRING

string rapresentation of a JSON object with the parameters passed to the callback later request

checkCallbackAvailableParameters

STRING

string rapresentation of a JSON object with the parameters passed to the check callback available request

botId

STRING

id of the bot aoosciated to the service

channel

STRING

channel of the service. Can be one of the following: web, whatsapp, messenger, instagram

enableBlur

BOOLEAN

enable/disable video blur during video chat

webrtc

OBJECT

Object containing the webrtc configuration. Please see the table below for the parameters.

custom_cfg

OBJECT

object that can contains custom parameters passed to the request for a new contact

engagementTimeout

NUMBER

Delay used to show the widget, expressed in ms. Note: engagementTimeout is not compatible with other rules. You need to set engagementTimeout to 0 to evaluate the others.

If you need to evaluate multiple rules at the same time you should use engagementFunctuion,

engagementOnClick

STRING

Widget shows up when user clicks on the area identified by the css selector specified

engagementOnMove

STRING

Widget shows up when user move the mouse over the area identified by the css selector specified

engagementFunction

STRING

Expected a JS function returning a Promise resolved with true when the widget is supposed to show up.

This function is useful to create a proactivity rule based on custom business logic. E.G. when a user add into the cart an item with a value higher than 100$

websocketServerURL

STRING

WebSocket URI to connect to

sipDestination

STRING

The destination endpoint that wish to call

iconUrl

STRING

custom icon url