Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 23: Line 23:
 
! Type
 
! Type
 
! Description
 
! Description
−
! Accepted Values
 
 
! Default
 
! Default
 
! Required
 
! Required
 +
! Accepted Values
 
|-
 
|-
 
| ajaxTimeout
 
| ajaxTimeout
 
| number
 
| number
 
| Number of milliseconds to wait before AJAX timeout
 
| Number of milliseconds to wait before AJAX timeout
 +
| 3000
 
| n/a
 
| n/a
−
| 3000
 
 
| n/a
 
| n/a
 
|-
 
|-
Line 38: Line 38:
 
| Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value.
 
| Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value.
 
| n/a
 
| n/a
 +
| Yes, if using Apigee Proxy. or v3 API.
 
| n/a
 
| n/a
−
| Yes, if using Apigee Proxy. or v3 API.
 
 
|-
 
|-
 
| ewt.dataURL
 
| ewt.dataURL
 
| URL String
 
| URL String
−
| URL of GMS/v3 API
+
| URL to the API endpoint for Estimated Wait Time (EWT)
 +
| Always
 
| n/a
 
| n/a
 
| n/a
 
| n/a
−
| Always
 
 
|-
 
|-
 
| ewt.apiVersion
 
| ewt.apiVersion
Line 56: Line 56:
 
  'v1' - GMS EWT v1
 
  'v1' - GMS EWT v1
 
  'v2' - GMS EWT v2
 
  'v2' - GMS EWT v2
−
  'v3' - [https://developer.genhtcc.com/reference/callback/Estimated-Wait-Time/index.html EWT v3]
+
  'v3' - [https://developer.genesyscloud.com/reference/engagement/Estimated-Wait-Time/index.html EWT v3]
  
 
  Only GET request type with virtual queue name as query parameters are supported.
 
  Only GET request type with virtual queue name as query parameters are supported.
 +
| 'v1'
 +
| Yes, if using GMS EWT v2 or [https://developer.genesyscloud.com/reference/engagement/Estimated-Wait-Time/index.html EWT v3] dataURL
 
| 'v1', 'v2', 'v3'
 
| 'v1', 'v2', 'v3'
−
| 'v1'
 
−
| Yes, if using GMS EWT v2 or [https://developer.genhtcc.com/reference/callback/Estimated-Wait-Time/index.html EWT v3] dataURL
 
 
|-
 
|-
 
| ewt.mode
 
| ewt.mode
 
| string
 
| string
 
| EWT mode parameter for GMS/v3 API. This value will vary based on the above apiVersion.
 
| EWT mode parameter for GMS/v3 API. This value will vary based on the above apiVersion.
−
|
 
−
'urs','urs2' or 'stat' for 'v1'
 
−
 
−
'ewt1,'ewt2' or 'ewt3' for 'v2'
 
−
 
−
'mode1','mode2' or 'mode3' for 'v3'
 
 
| Will vary based on the above apiVersion as shown below.  
 
| Will vary based on the above apiVersion as shown below.  
  
Line 79: Line 73:
 
  'mode2' for 'v3'
 
  'mode2' for 'v3'
 
| n/a
 
| n/a
 +
|
 +
'urs','urs2' or 'stat' for 'v1'
 +
 +
'ewt1,'ewt2' or 'ewt3' for 'v2'
 +
 +
'mode1','mode2' or 'mode3' for 'v3'
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 18:44, December 4, 2018

Configuration

Description

StatsService share the configuration namespace '_genesys.widgets.stats'. StatsService has connection settings to fetch EWT details from each channel.

Example

window._genesys.widgets.stats = {

	ajaxTimeout: 3000,

	ewt: {

		dataURL: 'http://10.0.0.121:7777/genesys/1/service/ewt-for-vq',
		apikey: 'n3exxxxxXREBMYjGxxxx8VA',
		apiVersion: 'v1',
		mode: 'urs2'
	}
};

Options

Name Type Description Default Required Accepted Values
ajaxTimeout number Number of milliseconds to wait before AJAX timeout 3000 n/a n/a
ewt.apikey string Apigee Proxy secure token. If apiVersion is v3, this holds the x-api-key value. n/a Yes, if using Apigee Proxy. or v3 API. n/a
ewt.dataURL URL String URL to the API endpoint for Estimated Wait Time (EWT) Always n/a n/a
ewt.apiVersion string Version of EWT API. 


Note: This value determines the version of EWT API in GMS/v3. That is:
'v1' - GMS EWT v1
'v2' - GMS EWT v2
'v3' - EWT v3

Only GET request type with virtual queue name as query parameters are supported.
'v1' Yes, if using GMS EWT v2 or EWT v3 dataURL 'v1', 'v2', 'v3'
ewt.mode string EWT mode parameter for GMS/v3 API. This value will vary based on the above apiVersion. Will vary based on the above apiVersion as shown below. 


'urs2' for 'v1' 
'ewt2' for 'v2' 
'mode2' for 'v3'
n/a 
'urs','urs2' or 'stat' for 'v1' 

'ewt1,'ewt2' or 'ewt3' for 'v2' 

'mode1','mode2' or 'mode3' for 'v3'
Comments or questions about this documentation? Contact us for support!