Configuration

Description

WebChat and WebChatService share the configuration namespace '_genesys.cxwidget.webchat'. WebChat has UI options while WebChatServie has connection options.

Example

window._genesys.cxwidget.webchat = {

	apikey: 'm6gLKXREBMOK8VAlygOHHLLn3eNkgYjG',
	dataURL: 'https://api.genesyscloud.com/gms-chat/2/test',
	userData: {},
	emojis: true,
	actionsMenu: true,

	autoInvite: {

		enabled: false,
		timeToInviteSeconds: 10,
		inviteTimeoutSeconds: 30
	},

	chatButton: {

		enabled: true,
		template: '<div>CHAT NOW</div>',
		effect: 'fade',
		openDelay: 1000,
		effectDuration: 300,
		hideDuringInvite: true
	}
};

Options

Name	Type	Description	Default	Required
emojis	boolean	Enable/Disable Emoji menu inside chat message input	true
actionsMenu	boolean	Enable/Disable actions menu next to chat message input	true
autoInvite.enabled	boolean	Enable/Disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time	false
autoInvite.timeToInviteSeconds	number	Number of seconds of idle time before inviting customer to chat	5
autoInvite.inviteTimeoutSeconds	number	Nunber of seconds to wait, after showing invite, before closing chat invite	30
chatButton.enabled	boolean	Enable/Disable chat button on screen	false
chatButton.template	string	Custom HTML string template for chat button
chatButton.effect	string	Type of animation effect when revealing chat button. 'slide' or 'fade'	fade
chatButton.openDelay	number	Number of milliseconds before displaying chat button on screen	1000
chatButton.effectDuration	number	Length of animation effect in milliseconds	300
chatButton.hideDuringInvite	boolean	When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again.	true

Options

Option	Type	Description
chatButton.enabled	boolean	Enable/Disable chat button on screen
chatButton.openDelay	number	Number of milliseconds before displaying chat button on screen
chatButton.template	string	Custom HTML string template for chat button
chatButton.effect	string	Type of animation effect when revealing chat button. 'slide' or 'fade'
chatButton.effectDuration	number	Length of animation effect in milliseconds
chatButton.hideDuringInvite	boolean	When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again.
autoInvite.enabled	boolean	Enable/Disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time
autoInvite.timeToInviteSeconds	number	Number of seconds of idle time before inviting customer to chat
autoInvite.inviteTimeoutSeconds	number	Nunber of seconds to wait, after showing invite, before closing chat invite
emojis	boolean	Enable/Disable Emoji menu inside chat message input
actionsMenu	boolean	Enable/Disable actions menu next to chat message input