(Update with the copy of version: Public) |
(Automated save: adding PEC_Migrated template.) |
||
Line 1: | Line 1: | ||
= Configuration = | = Configuration = | ||
+ | |||
+ | {{Template:PEC_Migrated}} | ||
+ | |||
+ | |||
== Description == | == Description == | ||
Callback and CallbackService share the configuration namespace '_genesys.widgets.callback'. Callback has UI options while CallbackService has connection options. | Callback and CallbackService share the configuration namespace '_genesys.widgets.callback'. Callback has UI options while CallbackService has connection options. |
Latest revision as of 22:37, 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.
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 |
This page was last edited on June 21, 2020, at 22:37.
Comments or questions about this documentation? Contact us for support!