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',
	cometD: false,
	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	Apigee Proxy secure token.	n/a	Yes, if using Apigee Proxy
endpoint	string	Manually select the endpoint to initiate the chat on.	n/a
dataURL	URL String	URL of GMS server.	n/a	Always
cometD	boolean	Enable or disable CometD using Websockets or Long-polling.	false
userData	object	Arbitrary JSON 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 (for example {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 (for example user navigated to a different site during chat and never ended the session).	60000