(Update with the copy of version: draft) |
(Update with the copy of version: draft) |
||
Line 4: | Line 4: | ||
== Example == | == Example == | ||
<pre> | <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 = { | window._genesys.widgets.callback = { | ||
apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA', | apikey: 'n3eNkgXXXXXXXXOXXXXXXXXA', | ||
− | dataURL: 'http:// | + | apiVersion: 'v3', |
+ | serviceName: 'service', | ||
+ | dataURL: 'http://internal-ges-000-int-prod-1052305864.us-west-1.elb.amazonaws.com:8080/callbacks', | ||
userData: {}, | userData: {}, | ||
countryCodes: true | countryCodes: true | ||
Line 19: | Line 33: | ||
! Type | ! Type | ||
! Description | ! Description | ||
+ | ! Accepted Values | ||
! Default | ! Default | ||
! Required | ! Required | ||
Line 24: | Line 39: | ||
| apikey | | apikey | ||
| string | | string | ||
− | | | + | | Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value. |
+ | | n/a | ||
| n/a | | n/a | ||
− | | Yes | + | | Yes, if using Apigee Proxy |
|- | |- | ||
| dataURL | | dataURL | ||
| URL String | | URL String | ||
| URL of GMS callback server | | URL of GMS callback server | ||
+ | | n/a | ||
| n/a | | n/a | ||
| Always | | 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.genhtcc.com/reference/callback/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.genhtcc.com/reference/callback/Callbacks/index.html#bookCallbackExternal Callback v3] dataURL | ||
|- | |- | ||
| userData | | userData | ||
| object | | object | ||
| Arbitrary JSON attached data to include while scheduling a callback | | Arbitrary JSON attached data to include while scheduling a callback | ||
+ | | n/a | ||
| {} | | {} | ||
| | | | ||
Line 43: | Line 78: | ||
| number | | number | ||
| Number of milliseconds to wait before AJAX timeout | | Number of milliseconds to wait before AJAX timeout | ||
+ | | n/a | ||
| 3000 | | 3000 | ||
| | | |
Revision as of 19:43, September 26, 2018
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 of GMS callback server | 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 JSON 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!