Developer/IT > Whisbi API > API Reference > Engage > Introduction

Introduction

These are all the specific customization options for Engage. This will only apply if your Primary seed belongs to an Engage service. You can learn more about Engage here.

NameDescriptionRequired
firstHLC Boolean Activate the Hybrid Lead Capture on top of the broadcast by switching the property to ‘true’. Optional
Default: false
visibilityType Integer It determines when the floating button is shown. 0 to never show the floating button, 1 to show the button when there is a Engage session running. Keep in mind that the floating button should only be hidden if the autoOpen property is set to true or if you are using your own button to launch the Whisbi widget. Optional
Default: 1
oneToOneDisplay Boolean true to make the Sell floating button appear when Engage is not live. This only applies when the Sell is configured as a secondary seed. Optional
Default: false
otoPin 
Boolean
Display ‘PIN to Whisbi’ when Engage is broadcasting and the widget has a secondarySeed (Sell) set.Optional
Default: false
autoOpen whisbi.otmAutoOpenConfig An object containing the behavior properties of the Sell widget when the page loads. Optional
disableLike Boolean If set to true, it won’t be possible to rate the agent, neither through the like button nor the rating screen that can be accessed through the top agent avatar. Moreover, the mute button changes its appearance and position in order to follow the design guidelines. Optional
Default: false
chatbot whisbi.OneToManyChatbotConfig The configuration of the Engage chatbot. You can learn more about the Chatbot here. Optional
texts whisbi.OneToManyTextsConfig The customizable texts of the Engage Widget Optional
styles whisbi.OneToManyStylesConfig The styling options for the Engage Widget Optional
activeViewerForm whisbi.OneToManyActiveViewerFormConfig Object containing the fields in the Engage form which appears when the customer enters a Engage live broadcast. Optional

EXAMPLE

var conf = {
version: '1.32.0',
api: {...},
general: {...},
oneToMany: {
firstHLC: false,
visibilityType: 1,
oneToOneDisplay: false,
autoOpen: {
onDesktop: {
enabled: false,
closeable: true,
},
onMobile: {
enabled: false,
closeable: true,
}
}
disableLike: false,
chatbot: {
minimumTime: 10,
minimumChats: 0,
externalURL: 'https://www.mycompany.com/',
pictureURL: '',
closeOnClick: true
},
texts: {
header: 'LIVE VIDEO CHAT',
liveHelpRibbon: '',
floatingButton: {
default: {
body: 'Do you have questions? Ask me now and get answers within few seconds!',
yesCTA: 'Yes',
noCTA: 'Not now'
},
returning: {
body: 'Can\'t find what you need? Ask me your questions now, I\'m here to help!',
yesCTA: 'Ask now',
noCTA: 'Maybe later'
}
},
chatbot: {
firstMessage: {
body: '',
bodyNoName: '',
yesCTA: '',
noCTA: ''
},
secondMessage: {
body: '',
bodyNoName: '',
yesCTA: ''
}
}
},
styles: {
body: {
backgroundColor: ''
},
floatingButton: {
blinkLabel: {
backgroundColor: '',
textColor: '',
}
},
liveHelpRibbon: {
backgroundColor: '',
textColor: '',
}
videoOverlay: '20%'
},
activeViewerForm: {
name: {
maxLength: 20,
maxWords: 2
}
}
},
oneToOne: {...},
events: {...}
};
whisbi.setup(conf);

Copy Code