Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 10: Line 10:
 
userData: {},
 
userData: {},
 
emojis: true,
 
emojis: true,
 +
uploadsEnabled: false,
 
confirmFormCloseEnabled: true,
 
confirmFormCloseEnabled: true,
 
actionsMenu: true,
 
actionsMenu: true,
Line 45: Line 46:
 
| Enable/disable Emoji menu inside chat message input.
 
| Enable/disable Emoji menu inside chat message input.
 
| true
 
| true
−
|  
+
| n/a
 +
|-
 +
| form
 +
| object
 +
| A JSON object containing a custom registration form definition. The JSON definition placed here becomes the default registration form layout for WebChat. See [[Documentation:GWC:WidgetsAPI:CustCRF|Customizable Chat Registration Form]]
 +
| A basic registration form is defined internally by default
 +
| n/a
 +
|-
 +
| uploadsEnabled
 +
| boolean
 +
| Show/Hide the Send File button. The button will be shown if the value is set to true.
 +
| false
 +
| n/a
 
|-
 
|-
 
| confirmFormCloseEnabled  
 
| confirmFormCloseEnabled  
Line 51: Line 64:
 
| Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form.
 
| Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form.
 
| true
 
| true
−
|  
+
| n/a
 
|-
 
|-
 
| timeFormat
 
| timeFormat
Line 57: Line 70:
 
| This sets the time format for the timestamps in this widget. It can be 12 or 24.
 
| This sets the time format for the timestamps in this widget. It can be 12 or 24.
 
| 12
 
| 12
−
|  
+
| false
 
|-
 
|-
 
| actionsMenu
 
| actionsMenu
Line 63: Line 76:
 
| Enable/disable actions menu next to chat message input.
 
| Enable/disable actions menu next to chat message input.
 
| true
 
| true
−
|  
+
| n/a
 
|-
 
|-
 
| maxMessageLength
 
| maxMessageLength
Line 69: Line 82:
 
| Set a character limit that the user can input into the message area during a chat. When max is reached, user cannot type any more. By default, no limit is imposed by the client.
 
| Set a character limit that the user can input into the message area during a chat. When max is reached, user cannot type any more. By default, no limit is imposed by the client.
 
| n/a
 
| n/a
−
|  
+
| n/a
 
|-
 
|-
 
| autoInvite.enabled
 
| autoInvite.enabled
Line 75: Line 88:
 
| Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time.
 
| Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time.
 
| false
 
| false
−
|  
+
| n/a
 
|-
 
|-
 
| autoInvite.timeToInviteSeconds
 
| autoInvite.timeToInviteSeconds
Line 81: Line 94:
 
| Number of seconds of idle time before inviting customer to chat.
 
| Number of seconds of idle time before inviting customer to chat.
 
| 5
 
| 5
−
|  
+
| n/a
 
|-
 
|-
 
| autoInvite.inviteTimeoutSeconds
 
| autoInvite.inviteTimeoutSeconds
Line 87: Line 100:
 
| Number of seconds to wait, after showing invite, before closing chat invite.
 
| Number of seconds to wait, after showing invite, before closing chat invite.
 
| 30
 
| 30
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.enabled
 
| chatButton.enabled
Line 93: Line 106:
 
| Enable/disable chat button on screen.
 
| Enable/disable chat button on screen.
 
| false
 
| false
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.template
 
| chatButton.template
Line 99: Line 112:
 
| Custom HTML string template for chat button.
 
| 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'><div class='cx-icon' data-icon='chat'></div><span class='i18n' data-message='ChatButton'></span></div></source>
 
| <source lang='java'><div class='cx-widget cx-webchat-chat-button' data-message='ChatButton' data-gcb-service-node='true'><div class='cx-icon' data-icon='chat'></div><span class='i18n' data-message='ChatButton'></span></div></source>
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.effect
 
| chatButton.effect
Line 105: Line 118:
 
| Type of animation effect when revealing chat button. 'slide' or 'fade'.
 
| Type of animation effect when revealing chat button. 'slide' or 'fade'.
 
| fade
 
| fade
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.openDelay
 
| chatButton.openDelay
Line 111: Line 124:
 
| Number of milliseconds before displaying chat button on screen.
 
| Number of milliseconds before displaying chat button on screen.
 
| 1000
 
| 1000
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.effectDuration
 
| chatButton.effectDuration
Line 117: Line 130:
 
| Length of animation effect in milliseconds
 
| Length of animation effect in milliseconds
 
| 300
 
| 300
−
|  
+
| n/a
 
|-
 
|-
 
| chatButton.hideDuringInvite
 
| chatButton.hideDuringInvite
Line 123: Line 136:
 
| When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again.
 
| When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again.
 
| true
 
| true
−
|  
+
| n/a
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 19:30, March 8, 2018

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,
	maxMessageLength: 140,

	autoInvite: {

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

	chatButton: {

		enabled: true,
		template: <div class='cx-icon' data-icon='chat'></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 n/a
form object A JSON object containing a custom registration form definition. The JSON definition placed here becomes the default registration form layout for WebChat. See Customizable Chat Registration Form A basic registration form is defined internally by default n/a
uploadsEnabled boolean Show/Hide the Send File button. The button will be shown if the value is set to true. false n/a
confirmFormCloseEnabled boolean Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form. true n/a
timeFormat number/string This sets the time format for the timestamps in this widget. It can be 12 or 24. 12 false
actionsMenu boolean Enable/disable actions menu next to chat message input. true n/a
maxMessageLength number Set a character limit that the user can input into the message area during a chat. When max is reached, user cannot type any more. By default, no limit is imposed by the client. n/a n/a
autoInvite.enabled boolean Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time. false n/a
autoInvite.timeToInviteSeconds number Number of seconds of idle time before inviting customer to chat. 5 n/a
autoInvite.inviteTimeoutSeconds number Number of seconds to wait, after showing invite, before closing chat invite. 30 n/a
chatButton.enabled boolean Enable/disable chat button on screen. false n/a
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'><div class='cx-icon' data-icon='chat'></div><span class='i18n' data-message='ChatButton'></span></div>
 n/a
chatButton.effect string Type of animation effect when revealing chat button. 'slide' or 'fade'. fade n/a
chatButton.openDelay number Number of milliseconds before displaying chat button on screen. 1000 n/a
chatButton.effectDuration number Length of animation effect in milliseconds 300 n/a
chatButton.hideDuringInvite boolean When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again. true n/a
Comments or questions about this documentation? Contact us for support!