Cisco Cisco IPCC Web Option Installation Guide
A-3
Remote Silent Monitoring Installation and Administration Guide
Appendix A API Extensions
VLEngine HTTP API
canMonitorAgentID.jsp
Checks validity of agent ID, if the agent is logged in, and if the supervisor has the
necessary permissions to monitor the agent. Called by the VXML script before
calling monitorAgent on the PhoneSim service. Called by the VRU call flow
script (VXML, IP IVR, CVP).
necessary permissions to monitor the agent. Called by the VXML script before
calling monitorAgent on the PhoneSim service. Called by the VRU call flow
script (VXML, IP IVR, CVP).
Parameters
agentID: ID of agent to be checked.
supervisorID: ID of supervisor (i.e., caller) to be checked. Set to 0 to not perform
supervisor permission-type checks (e.g., only agent availability checks will
happen, where the system checks that the agent is logged in and talking).
supervisor permission-type checks (e.g., only agent availability checks will
happen, where the system checks that the agent is logged in and talking).
outputFormat: Specifies format of returned data:
plain: Returned data contains no formatting. For example, a
CREDENTIALS_VALID result will be returned as simple text (i.e.,
CREDENTIALS_VALID). This output method is appropriate for
hand-written VXML scripts or anything that can perform a HTML request
and process the result directly.
CREDENTIALS_VALID result will be returned as simple text (i.e.,
CREDENTIALS_VALID). This output method is appropriate for
hand-written VXML scripts or anything that can perform a HTML request
and process the result directly.
vxml: Returned data is formatted in result variable of returned VXML
document. Returned page has an <exit> statement that specifies a result
variable in its namelist parameter, which contains the return code for the
operation. This output format is appropriate for IP IVR’s VoiceBrowser step.
document. Returned page has an <exit> statement that specifies a result
variable in its namelist parameter, which contains the return code for the
operation. This output format is appropriate for IP IVR’s VoiceBrowser step.
vxml-cvp: VXML output, which includes extra data that makes it usable by
a CVP studio call flow (e.g., specifying the output as a VXML sub-dialog,
contains Audium tags, etc.).
a CVP studio call flow (e.g., specifying the output as a VXML sub-dialog,
contains Audium tags, etc.).
INVALID_PARAMETERS One or more required parameters not specified
GENERAL_ERROR
GENERAL_ERROR
See
topic in
Chapter 7, Troubleshooting
Parameter
Type