Jump to: navigation, search
(Created target blank page For Version: PSAAS:Public)
 
(Update with the copy of version: 8.5.0)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Configuration =
 +
== Description ==
 +
WebChat and WebChatService share the configuration namespace '_genesys.widgets.webchat'. WebChat has UI options while WebChatService has connection options.
 +
== Example ==
 +
<pre>
 +
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
 +
}
 +
};
 +
</pre>
 +
== 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
 +
|-
 +
| userData
 +
| object
 +
| Arbitrary JSON attached data to include when initiating a chat
 +
| {}
 +
|
 +
|-
 +
| ajaxTimeout
 +
| number
 +
| Number of milliseconds to wait before AJAX timeout
 +
| 3000
 +
|
 +
|-
 +
| 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
 +
|
 +
|-
 +
|}
 +
 
 +
[[Category:V:PSAAS:Public]]

Revision as of 13:39, August 10, 2017

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 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
userData object Arbitrary JSON attached data to include when initiating a chat {}
ajaxTimeout number Number of milliseconds to wait before AJAX timeout 3000
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
Comments or questions about this documentation? Contact us for support!