Developer/IT > Whisbi API > API Reference > One-to-One > Introduction

Introduction

These are all the specific customization options for One-to-One. This will only apply if your Primary seed or Secondary seed belongs to a One-to-One service. You can learn more about the One-to-One here.

NameDescriptionRequired
pin Boolean True to show the PIN code on the bottom corner of the screen. You can learn more about the pin here. Optional
cmb Boolean True to enable the Call Me Back option. Keep in mind that this option requires the configuration of the Outbound Schedule. You can learn more about the Call me back here. Optional
onDesktop whisbi.otoDeviceInboundConfig An object containing the behavior properties of the widget when the page loads on desktop. Optional
onMobile whisbi.otoDeviceInboundConfig An object containing the behavior properties of the widget when the page loads on mobile. Optional
customInboundAction Boolean True to not open the phone’s dialer when user clicks the “call now” button. If using this option, you need to use the otoInboundClicked event to trigger the action you want. Optional
Default: false
visibilityType String It determines when the floating button is shown.0 to never show the floating button, 1 to always show the floating button, 2 to show the button only during your service’s opening hours, 3 to show the button only when the connected agents are available. It also applies to the widget if the autoOpen property is set to true. Optional
ratingType String Type of rating that will be shown to the user when the One-to-One session ends. ‘nps-emoji’ to show the Net Promoter Score survey with emojis, ‘nps-dots’ to show the Net Promoter Score survey with dots, ‘service-rating’ to show the survey to evaluate, from 1 to 5 stars, different aspects of the service, or ‘none’ if you don’t want to show any. Learn more about the rating types here. Optional
defaultUserPictures Array If defaultUserPictures is set, the real images of the agents and the name won’t be displayed until the session starts. Instead, a set of images will be displayed. A list of the image URLs is required. Optional
form whisbi.OneToOneFormConfig An object containing the fields showing up in the One-to-One form. Learn more about the form here. Optional
chatbot whisbi.OneToOneChatbotConfig An object containing all the chatbot related configuration. Optional
schedule whisbi.OneToOneScheduleConfig An object containing the fields showing up in the One-to-One schedule form. Learn more about the schedule here. Optional
autoOpen whisbi.otoAutoOpenConfig An object containing the behavior properties of the One-to-One widget when the page loads. Optional
texts whisbi.OneToOneTextsConfig The customizable texts of the One-to-One Widget Optional
styles whisbi.OneToOneStylesConfig The styling options for the One-to-One Widget Optional

EXAMPLE

var conf = {
version: '1.32.0',
api: {...},
general: {...},
oneToMany: {...},
oneToOne: {
pin: false,
cmb: false,
onDesktop: {
connectForm: true,
inbound: true
},
onMobile: {
connectForm: false,
inbound: true
},
phoneType: ''
visibilityType: 1,
ratingType: 'nps-emoji',
defaultUserPictures: [],
autoOpen: {
onDesktop: {
enabled: false,
closeable: true,
},
onMobile: {
enabled: false,
closeable: true,
}
},
texts: {
header: '',
formTitle: '',
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'
}
},
outOfHours: {
mainTitle: '',
subTitle: '',
},
thankYou: {
mainTitle: '',
subTitle: '',
}
},
styles: {
body: {
backgroundColor: ''
},
liveHelpRibbon: {
backgroundColor: '',
textColor: '',
},
floatingButton: {
onMobile: {
maxUserPictures: 1
}
}
},
form: {
name: {
visible: true,
mandatory: false,
},
email: {
visible: true,
mandatory: false,
},
phone: {
visible: true,
mandatory: false,
},
conversationalMode: true,
availableCountryCodes: [],
defaultCountryCode: '',
preferredCountryCodes: []
},
chatbot: {
configURL: '',
outOfHoursConfigURL: ''
},
schedule: {
name: {
visible: true,
mandatory: false,
},
email: {
visible: true,
mandatory: false,
},
availableHours: [
[['10:00','17:00']], //Monday
[['10:00','17:00']],
[['10:00','17:00']],
[['10:00','17:00']],
[['10:00','17:00']],
[], //In this case Saturdays are non-working days
[['10:00','13:00'], ['14:00','16:00']] //Sunday
],
timeInterval: 30,
maxBookingRange: 60,
exceptions: {
'01-04-2017': [
['12:00','14:00'],
['16:00','18:00']
],
'25-12-2017': [] //This day will be a non-working day
},
dateFormat: 'dd-mm-yy,
firstDayOfWeek: 1,
emailTo: ''
}
}
};
whisbi.setup(conf);
Copy Code