Cisco Cisco Unified Contact Center Enterprise 9.0(2) Installation Guide
A-7
Remote Silent Monitoring Installation and Administration Guide
Appendix A API Extensions
VLEngine HTTP API
Returns
getAgentList.jsp
Returns a sub-dialog with list of currently talking agents, as called by VRU.
Format of returned data, and how it is used, is specified by hasTTS parameter.
Called by VRU call flow script (VXML, IP IVR, or CVP).
Format of returned data, and how it is used, is specified by hasTTS parameter.
Called by VRU call flow script (VXML, IP IVR, or CVP).
Parameters
supervisorID: ID of supervisor (i.e., caller) requesting list of agents, filtered to
supervisor’s team members. If set to zero, team filtering is not performed.
supervisor’s team members. If set to zero, team filtering is not performed.
outputFormat: Specifies format of returned data:
plain: Equivalent to vxml (below).
vxml: Returned data is formatted in result variable of returned VXML
document. Returned page has <exit> statement that specifies result variable
in its namelist parameter, which contains return code for operation. This
output format is appropriate for IP IVR’s VoiceBrowser step.
document. Returned page has <exit> statement that specifies result variable
in its namelist parameter, which contains return code for operation. This
output format is appropriate for IP IVR’s VoiceBrowser step.
Parameter
Type
<TEXTUAL DATA>
The conversation sub-dialog VXML page, as
per outputFormat parameter. The returned
VXML document or sub-dialog will also exit or
return one of the parameters listed below
(INVALID_USER_ID, SUCCESS, etc.).
per outputFormat parameter. The returned
VXML document or sub-dialog will also exit or
return one of the parameters listed below
(INVALID_USER_ID, SUCCESS, etc.).
INVALID_AGENT_ID
Agent ID is invalid
INVALID_USER_ID
Caller’s user ID is invalid
INVALID_PARAMETERS
One or more required parameters not specified
AGENT_NOT_TALKING
Agent ID is valid, but agent is not currently
active (i.e., logged in and talking) and therefore
has no active call ID
active (i.e., logged in and talking) and therefore
has no active call ID
GENERAL_ERROR
See
topic in
Chapter 7, Troubleshooting
SUCCESS
Operation was successful