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