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,
 +
uploadsEnabled: false,
 +
confirmFormCloseEnabled: 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
 +
|-
 +
| emojis
 +
| boolean
 +
| Enable/disable Emoji menu inside chat message input
 +
| true
 +
|
 +
|-
 +
| confirmFormCloseEnabled
 +
| boolean
 +
| Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form.
 +
| 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
 +
| Number 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.
 +
| <source lang='java'><div class='cx-widget cx-webchat-chat-button' data-message='ChatButton' data-gcb-service-node='true'><span class='i18n' data-message='ChatButton'></span></div></source>
 +
|
 +
|-
 +
| 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
 +
|
 +
|-
 +
|}
 +
 
 +
[[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,
	uploadsEnabled: false,
	confirmFormCloseEnabled: 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
confirmFormCloseEnabled boolean Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form. 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 Number 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. 
<div class='cx-widget cx-webchat-chat-button' data-message='ChatButton' data-gcb-service-node='true'><span class='i18n' data-message='ChatButton'></span></div>
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
Comments or questions about this documentation? Contact us for support!