Jump to: navigation, search
(Created target blank page For Version: PSAAS:Julie)
 
(Update with the copy of version: Public)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Configuration =
 +
== Description ==
 +
Callback and CallbackService share the configuration namespace '_genesys.widgets.callback'. Callback has UI options while CallbackService has connection options.
 +
== Example ==
 +
<pre>
 +
// If using Callback API v1
 +
 
 +
window._genesys.widgets.callback = {
 +
 
 +
apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
 +
dataURL: 'http://fce-w0147.us.int.genesyslab.com:8010/genesys/1/service/callback/samples',
 +
userData: {},
 +
countryCodes: true
 +
};
 +
 
 +
// If using Callback API v3
 +
 
 +
window._genesys.widgets.callback = {
 +
 
 +
apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
 +
apiVersion: 'v3',
 +
serviceName: 'service',
 +
dataURL: 'http://internal-ges-000-int-prod-1052305864.us-west-1.elb.amazonaws.com:8080/callbacks',
 +
userData: {},
 +
countryCodes: true
 +
};
 +
</pre>
 +
 
 +
== Options ==
 +
{|
 +
|-
 +
! Name
 +
! Type
 +
! Description
 +
! Accepted Values
 +
! Default
 +
! Required
 +
|-
 +
| apikey
 +
| string
 +
| Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value.
 +
| n/a
 +
| n/a
 +
| Yes, if using Apigee Proxy
 +
|-
 +
| dataURL
 +
| URL String
 +
| URL to the API endpoint for Callback
 +
| n/a
 +
| n/a
 +
| Always
 +
|-
 +
| apiVersion
 +
| string
 +
| Version of Callback API
 +
 
 +
 
 +
Note: This value determines the version of Callback API in GMS/v3.
 +
| 'v1', 'v3'
 +
| 'v1'
 +
| Yes, if using [https://developer.genesyscloud.com/reference/engagement/Callbacks/index.html#bookCallbackExternal Callback v3] dataURL
 +
|-
 +
| serviceName
 +
| string
 +
| Service Name of Callback API in v3
 +
| n/a
 +
| n/a
 +
| Yes, if using [https://developer.genesyscloud.com/reference/engagement/Callbacks/index.html#bookCallbackExternal Callback v3] dataURL
 +
|-
 +
| userData
 +
| object
 +
| Arbitrary attached data to include while scheduling a callback
 +
| n/a
 +
| {}
 +
|
 +
|-
 +
| ajaxTimeout
 +
| number
 +
| Number of milliseconds to wait before AJAX timeout
 +
| n/a
 +
| 3000
 +
|
 +
|-
 +
|}
 +
 
 +
[[Category:V:PSAAS:Julie]]

Revision as of 16:59, June 7, 2019

Configuration

Description

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

Example

// If using Callback API v1

 window._genesys.widgets.callback = {

	apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
	dataURL: 'http://fce-w0147.us.int.genesyslab.com:8010/genesys/1/service/callback/samples',
	userData: {},
	countryCodes: true
};

// If using Callback API v3

window._genesys.widgets.callback = {

	apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA',
	apiVersion: 'v3',
	serviceName: 'service',
	dataURL: 'http://internal-ges-000-int-prod-1052305864.us-west-1.elb.amazonaws.com:8080/callbacks',
	userData: {},
	countryCodes: true
};

Options

Name Type Description Accepted Values Default Required
apikey string Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value. n/a n/a Yes, if using Apigee Proxy
dataURL URL String URL to the API endpoint for Callback n/a n/a Always
apiVersion string Version of Callback API 


Note: This value determines the version of Callback API in GMS/v3.
'v1', 'v3' 'v1' Yes, if using Callback v3 dataURL
serviceName string Service Name of Callback API in v3 n/a n/a Yes, if using Callback v3 dataURL
userData object Arbitrary attached data to include while scheduling a callback n/a {}
ajaxTimeout number Number of milliseconds to wait before AJAX timeout n/a 3000
Comments or questions about this documentation? Contact us for support!