Cisco Cisco IPCC Web Option Installation Guide

Page of 134
Appendix A       API Extensions
VLEngine HTTP API
A-12
Remote Silent Monitoring Installation and Administration Guide
initiateMonitorAgent
Tells VLEngine (which manages JTAPI connections) to tell appropriate Unified 
CM cluster (via JTAPI) to initiate a monitoring session for specified simulated 
supervisor phone. Parameters passed are for a phone registered to the same cluster 
and returned by determineAgentCluster request. Called by VLEngine upon receipt 
of successful return code from determineAgentCluster request. 
Parameters
correlationID: Unique ID for request, as generated by VLEngine. ID is specified 
so VLEngine can correlate response with its initial request, which allows it to run 
all HTTP request traffic over a single persistent socket. The correlationID must 
be alphanumeric, and is passed back in response message.
agentID: Agent ID to initiate monitoring.
phoneID: Device ID of simphone to initiate monitoring (e.g., 
SEP00005E000001).
lineID: Line DN on passed simphoneID to take call. 
Returns
Note
Each return is prefaced by string correlationID =<correlationID>&result= 
Parameter
Type
INVALID_PARAMETERS
One or more required parameters not specified
AGENT_NOT_TALKING
ID specified is valid, but agent is currently not 
active (i.e., logged in and talking) and therefore 
has no active call ID.
NO_PERMISSIONS
Specified caller does not have permissions 
required to monitor specified agent.
GENERAL_ERROR
See 
 topic in 
Chapter 7, Troubleshooting