Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 4: Line 4:
 
== Example ==
 
== Example ==
 
<pre>
 
<pre>
−
window._genesys.cxwidget.stats = {
+
window._genesys.widgets.stats = {
  
 
ajaxTimeout: 3000,
 
ajaxTimeout: 3000,
Line 11: Line 11:
  
 
dataURL: 'http://10.0.0.121:7777/genesys/1/service/ewt-for-vq',
 
dataURL: 'http://10.0.0.121:7777/genesys/1/service/ewt-for-vq',
−
apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA'
+
apikey: 'n3exxxxxXREBMYjGxxxx8VA',
 +
apiVersion: 'v1',
 +
mode: 'urs2'
 
}
 
}
 
};
 
};
 
</pre>
 
</pre>
 +
 
== Options ==
 
== Options ==
 
{|
 
{|
Line 21: Line 24:
 
! Type
 
! Type
 
! Description
 
! Description
 +
! Accepted Values
 
! Default
 
! Default
 
! Required
 
! Required
Line 27: Line 31:
 
| number
 
| number
 
| Number of milliseconds to wait before AJAX timeout
 
| Number of milliseconds to wait before AJAX timeout
 +
| n/a
 
| 3000
 
| 3000
 
| n/a
 
| n/a
Line 32: Line 37:
 
| ewt.apikey
 
| ewt.apikey
 
| string
 
| string
−
| API access token. Please contact your Genesys representative to obtain your API access token.
+
| 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. <!--or v3 API.-->
 
|-
 
|-
 
| ewt.dataURL
 
| ewt.dataURL
 
| URL String
 
| URL String
−
| URL of GMS server
+
| URL of GMS<!--/v3--> API
 +
| n/a
 
| n/a
 
| n/a
 
| Always
 
| Always
 +
|-
 +
| 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' - [https://developer.genhtcc.com/reference/callback/Estimated-Wait-Time/index.html EWT v3]-->
 +
 +
Only GET request type with virtual queue name as query parameters are supported.
 +
| 'v1', 'v2'<!--, 'v3'-->
 +
| 'v1'
 +
| Yes, if using EWT v2 <!--or [https://developer.genhtcc.com/reference/callback/Estimated-Wait-Time/index.html EWT v3]--> dataURL
 +
|-
 +
| ewt.mode
 +
| string
 +
| 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.
 +
 +
 +
'urs2' for 'v1'
 +
'ewt2' for 'v2' <!--
 +
'mode2' for 'v3'-->
 +
| n/a
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 19:48, August 30, 2018

Configuration

Description

StatsService share the configuration namespace '_genesys.cxwidget.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 Accepted Values Default Required
ajaxTimeout number Number of milliseconds to wait before AJAX timeout n/a 3000 n/a
ewt.apikey string Apigee Proxy secure token. n/a n/a Yes, if using Apigee Proxy.
ewt.dataURL URL String URL of GMS API n/a n/a Always
ewt.apiVersion string Version of EWT API. 


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

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

'ewt1,'ewt2' or 'ewt3' for 'v2'
Will vary based on the above apiVersion as shown below. 


'urs2' for 'v1' 
'ewt2' for 'v2'
n/a
Comments or questions about this documentation? Contact us for support!