Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

Status
titlestring

unique service identifier

name

Status
titlestring

service name

enableService

Status
titleboolean

enable/disable service

checkMediaUrl

Status
titlestring

url of the REST webservice to check agent availability

checkMediaInterval

Status
titlenumber

milliseconds every how much the checkmedia must be called

widget

Status
titlestring

widget id associated with the service

enableChat

Status
titleboolean

enable/disable chat channel

enableCallbackNow

Status
titleboolean

enable/disable callback now

enableCallbackLater

Status
titleboolean

enable/disable callback later

enableClickToCall

Status
titleboolean

enable/disable click to call

enableScreensharing

Status
titleboolean

enable/disable screen sharing

restart_chat

Status
titleboolean

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

enableVideo

Status
titleboolean

video escalation option available during interaction

enableAudioNotifcation

Status
titleboolean

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

audioNotificationUrl

Status
titlestring

path to file audio to be reproduced for audio notification

enableBrowserNotification

Status
titleboolean

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

enableSendLink

Status
titleboolean

Enable feature for sending links (customer side)

enableSendDocument

Status
titleboolean

Enable feature for sending documents (customer side)

enableSendImageFeature

Status
titleboolean

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

enableSendDocumentFeature

Status
titleboolean

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

compatibilityErrorMessage

Status
titlelocalized 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

Status
titlestring

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

datacollection

Status
titlearray

list of datacollection id enabled

custom_css

Status
titlestring

path to custom css file

logo

Status
titlestring

path to logo image

language

Status
titlestring

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
titlestring

custom function to set language

proactivity

Status
titleobject

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

callbackNowParameters

Status
titlestring

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

callbackLaterParameters

Status
titlestring

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

checkCallbackAvailableParameters

Status
titlestring

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

botId

Status
titlestring

id of the bot aoosciated to the service

channel

Status
titlestring

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

enableBlur

Status
titleboolean

enable/disable video blur during video chat

webrtc

Status
titleobject

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

custom_cfg

Status
titleobject

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

enableLateEngagementChat

Status
titleboolean

enable/disable late engagement chat, i.e. starting the chat only after the customer has written the first message

Proactivity Rules

Name

Type

Description

engagementTimeout

Status
titlenumber

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
titlestring

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

engagementOnMove

Status
titlestring

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

engagementFunction

Status
titlestring

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
titlestring

WebSocket URI to connect to

sipDestination

Status
titlestring

The destination endpoint that wish to call

iconUrl

Status
titlestring

custom icon url