|
|
| Line 1: |
Line 1: |
| | = Configuration = | | = Configuration = |
| − | == Description ==
| + | {{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/WebChat-combined#Configuration.}} |
| − | 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,
| |
| − | 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
| |
| − | },
| |
| − | | |
| − | minimizeOnMobileRestore: false,
| |
| − | | |
| − | markdown: false
| |
| − | };
| |
| − | </pre>
| |
| − | | |
| − | == Options ==
| |
| − | {|
| |
| − | |-
| |
| − | ! Name
| |
| − | ! Type
| |
| − | ! Description
| |
| − | ! Default
| |
| − | ! Required
| |
| − | |-
| |
| − | | emojis
| |
| − | | boolean
| |
| − | | Enable/disable Emoji menu inside chat message input. Emojis are supported using unicode characters and the list includes ☺ U+263A (smile), 👍 U+1F44D (thumbs up) and ☹ U+2639 (sad).
| |
| − | | false | |
| − | | 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 [[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
| |
| − | | 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.
| |
| − | | 500
| |
| − | | n/a
| |
| − | |-
| |
| − | | charCountEnabled
| |
| − | | boolean
| |
| − | | Show/Hide the number of characters remaining in the input message area while the user is typing.
| |
| − | | false
| |
| − | | n/a
| |
| − | |-
| |
| − | | autoInvite.enabled
| |
| − | | boolean
| |
| − | | Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time.
| |
| − | | |
| − | | |
| − | Note: In case of running Widgets in lazy load mode, this option requires WebChat plugin to be [[AppConfiguration#Options|pre-loaded]].
| |
| − | | 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.
| |
| − | | |
| − | | |
| − | Note: In case of running Widgets in lazy load mode, this option requires WebChat plugin to be [[AppConfiguration#Options|pre-loaded]].
| |
| − | | false
| |
| − | | n/a
| |
| − | |-
| |
| − | | 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'><div class='cx-icon' data-icon='chat'></div><span class='i18n' data-message='ChatButton'></span></div></source>
| |
| − | | 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
| |
| − | |-
| |
| − | | markdown
| |
| − | | boolean
| |
| − | | Enable/disable the markdown feature for chat messages.
| |
| − | | false
| |
| − | | n/a
| |
| − | |}
| |
| − | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
