Name | Type | Description | ||||
|---|---|---|---|---|---|---|
id |
| unique service identifier | ||||
name |
| service name | ||||
enableService |
| enable/disable service | ||||
checkMediaUrl |
| url of the REST webservice to check agent availability | ||||
checkMediaInterval |
| milliseconds every how much the checkmedia must be called | ||||
widget |
| widget id associated with the service | ||||
enableChat |
| enable/disable chat channel | ||||
enableCallbackNow |
| enable/disable callback now | ||||
enableCallbackLater |
| enable/disable callback later | ||||
enableClickToCall |
| enable/disable click to call | ||||
enableScreensharing |
| enable/disable screen sharing | ||||
restart_chat |
| When a chat contact is terminated, configure to show again or not the engagement widget | ||||
enableVideo |
| video escalation option available during interaction | ||||
enableAudioNotifcation |
| Play a audio alert for each message received without focus on the page | ||||
audioNotificationUrl |
| path to file audio to be reproduced for audio notification | ||||
enableBrowserNotification |
| Show browser notification for each message reveiced without focus on the page | ||||
enableSendLink |
| Enable feature for sending links (customer side) | ||||
enableSendDocument |
| Enable feature for sending documents (customer side) | ||||
enableSendImageFeature |
| Enable feature for sending images (both agent and customer side) | ||||
enableSendDocumentFeature |
| Enable feature for sending documents (both agent and customer side) | ||||
compatibilityErrorMessage |
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 |
| list of entrypoints identified by webpage URL. Entrypoint is evaluated as regular expression against with the page URL | ||||
datacollection |
| list of datacollection id enabled | ||||
custom_css |
| path to custom css file | ||||
logo |
| path to logo image | ||||
language |
| country code of the language used. can be overwritten by query string param in the sdk url or by language_fn parameter | ||||
language_fn |
| custom function to set language | ||||
proactivity |
| object containing the proactivity rules. Please see the table below for the complete list of the properties. | ||||
callbackNowParameters |
| string rapresentation of a JSON object with the parameters passed to the callback now request | ||||
callbackLaterParameters |
| string rapresentation of a JSON object with the parameters passed to the callback later request | ||||
checkCallbackAvailableParameters |
| string rapresentation of a JSON object with the parameters passed to the check callback available request | ||||
botId |
| id of the bot aoosciated to the service | ||||
channel |
| channel of the service. Can be one of the following: web, whatsapp, messenger, instagram | ||||
enableBlur |
| enable/disable video blur during video chat | ||||
webrtc |
| Object containing the webrtc configuration. Please see the table below for the parameters. | ||||
custom_cfg |
| object that can contains custom parameters passed to the request for a new contact | ||||
enableLateEngagementChat |
| enable/disable late engagement chat, i.e. starting the chat only after the customer has written the first message | ||||
surveyExpireInMinutes |
| time window within which you can answer an open question in a WhatsApp survey | ||||
enableAutostartChat |
| enables the chat to start automatically as soon as the checkmedia returns a positive result |
Proactivity Rules
Name | Type | Description | ||||
|---|---|---|---|---|---|---|
engagementTimeout |
| 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 |
| Widget shows up when user clicks on the area identified by the css selector specified | ||||
engagementOnMove |
| Widget shows up when user move the mouse over the area identified by the css selector specified | ||||
engagementFunction |
| 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$ |
...