Configuration

Description

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

Example

window._genesys.widgets.webchat = {

	apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
	dataURL: 'https://api.genesyscloud.com/gms-chat/2/chat',

	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
apikey	string	API access token. Please contact your Genesys representative to obtain your API access token.	n/a	Yes
endpoint	string	Manually select the endpoint to initiate chat on.	n/a
dataURL	string (URL)	URL for GMS REST chat service.	n/a	Always
userData	object	Arbitrary attached data to include when initiating a chat.	{}
ajaxTimeout	number	Number of milliseconds to wait before AJAX timeout.	3000
xhrFields	object	Allows you to set the properties for the AJAX xhrFields object (e.g. {withCredentials: false}).	{withCredentials: false}
pollExceptionLimit	number	Number of successive poll exceptions (chat server offline) before WebChatService publishes 'chatServerWentOffline'.	5
restoreTimeout	number	Number of milliseconds before restore timeout. Prevents the chat session from restoring after a certain time away from the session (e.g. user navigated to a different site during chat and never ended the session).	60000