Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
= Configuration =
 
= 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 = {
+
{{Template:PEC_Migrated}}
  
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 = {
+
{{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/CallbackService-combined#Configuration.}}
 
 
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 JSON 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:Public]]
 
[[Category:V:PSAAS:Public]]

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.



Important
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/CallbackService-combined#Configuration.
This page was last edited on June 21, 2020, at 22:37.
Comments or questions about this documentation? Contact us for support!