Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Configuration =
 
= 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',
+
{{Template:PEC_Migrated}}
−
dataURL: 'https://api.genesyscloud.com/gms-chat/2/chat',
 
  
−
userData: {},
 
−
emojis: true,
 
−
actionsMenu: true,
 
  
−
autoInvite: {
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/WebChatService-combined#Configuration.}}
−
 
 
−
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
 
−
| 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
 
−
|
 
−
|-
 
−
|}
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 23:28, June 21, 2020

Configuration

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/WebChatService-combined#Configuration.
This page was last edited on June 21, 2020, at 23:28.
Comments or questions about this documentation? Contact us for support!