Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 6: Line 6:
 
window._genesys.widgets.callback = {
 
window._genesys.widgets.callback = {
  
−
apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
+
apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
 
dataURL: 'http://fce-w0147.us.int.genesyslab.com:8010/genesys/1/service/callback/samples',
 
dataURL: 'http://fce-w0147.us.int.genesyslab.com:8010/genesys/1/service/callback/samples',
 
userData: {},
 
userData: {},
 
countryCodes: true,
 
countryCodes: true,
−
formValidation: false,
 
 
immediateCallback: true,
 
immediateCallback: true,
−
        scheduledCallback: true,
+
scheduledCallback: true,
−
        ewt: {
+
ewt: {
−
                queue: "chat_ewt_test",
+
display: true,
−
                immediateCallback: {
+
queue: 'chat_ewt_test',
−
                    thresholdMin: 10,
+
threshold: 2000
−
                    thresholdMax: 3000
 
 
                 }
 
                 }
 
         },
 
         },
Line 34: Line 32:
 
| countryCodes
 
| countryCodes
 
| boolean
 
| boolean
−
| Enable/disable country flags display for phone numbers.
+
| Enable/disable display of country codes for phone number.
 
| true
 
| true
 
| n/a
 
| n/a
Line 40: Line 38:
 
| immediateCallback
 
| immediateCallback
 
| boolean
 
| boolean
−
| Enable/disable the 'As Soon As Possible' option. Set value to true to enable.
+
| Enable/disable the immediate (As Soon As Possible) callback option.
 
| true
 
| true
 
| n/a
 
| n/a
Line 46: Line 44:
 
| scheduledCallback
 
| scheduledCallback
 
| boolean
 
| boolean
−
| Enable/disable the scheduling option. Set value to true to enable.
+
| Enable/disable the scheduling (Pick date & time) callback option.
 +
| 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 Callback. See [[Documentation:GWC:WidgetsAPI:CallbackCCRF|Customizable Callback Registration Form]]
 +
| A basic registration form is defined internally by default
 +
| n/a
 +
|-
 +
| ewt.display
 +
| boolean
 +
| To display Estimated Waiting Time details.
 
| true
 
| true
 
| n/a
 
| n/a
Line 54: Line 64:
 
| EWT service channel virtual queue.
 
| EWT service channel virtual queue.
 
| none
 
| none
−
| always required if the range for EWT is configured.
+
| always required if Estimated Waiting Time has to be displayed.
 
|-
 
|-
−
| ewt.immediateCallback.thresholdMin
+
| ewt.threshold
−
| string
+
| number
−
| If EWT is less than this minimum threshold value (seconds), the 'As Soon As Possible' option will be disabled.
+
| If EWT is less than this threshold value (seconds), wait time will not be shown.
−
| none
+
| 30
−
| none
+
| n/a
−
|-
 
−
| ewt.immediateCallback.thresholdMax
 
−
| string
 
−
| If EWT is more than this maximum threshold value (seconds), the 'As Soon As Possible' option will be disabled.  
 
−
| none
 
−
| none
 
 
|-
 
|-
−
| formValidation
+
| ewt.refreshInterval
−
| boolean
+
| number
−
| Enable/Disable browser form validations.
+
| Wait time is updated for every time interval (seconds) defined here.
−
| true
+
| 10
 
| n/a
 
| n/a
 
|-
 
|-

Revision as of 22:04, May 11, 2018

Configuration

Description

Callback and CallbackService share the configuration namespace '_genesys.widgets.callback'. Callback has UI options while CallbackService has connection options.

Example

window._genesys.widgets.callback = {

	apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
	dataURL: 'http://fce-w0147.us.int.genesyslab.com:8010/genesys/1/service/callback/samples',
	userData: {},
	countryCodes: true,
	immediateCallback: true,
	scheduledCallback: true,
	ewt: {
		display: true,
		queue: 'chat_ewt_test',
		threshold: 2000
                }
        },
};

Options

Name Type Description Default Required
countryCodes boolean Enable/disable display of country codes for phone number. true n/a
immediateCallback boolean Enable/disable the immediate (As Soon As Possible) callback option. true n/a
scheduledCallback boolean Enable/disable the scheduling (Pick date & time) callback option. 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 Callback. See Customizable Callback Registration Form A basic registration form is defined internally by default n/a
ewt.display boolean To display Estimated Waiting Time details. true n/a
ewt.queue string EWT service channel virtual queue. none always required if Estimated Waiting Time has to be displayed.
ewt.threshold number If EWT is less than this threshold value (seconds), wait time will not be shown. 30 n/a
ewt.refreshInterval number Wait time is updated for every time interval (seconds) defined here. 10 n/a
Comments or questions about this documentation? Contact us for support!