Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 500
   
13-10
CTI OS Developer’s Guide for Cisco ICM/IPCC Enterprise & Hosted Editions
Cisco CTI OS Release 7.2(1)
Chapter 13      SilentMonitorManager Object
Methods
Syntax 
C++:
 int StartSilentMonitorRequest (Arguments & args, unsigned short * SMSessionKey );
COM:
  
HRESULT StartSilentMonitorRequest ( /*[in]*/ IArguments * args, /*/[out]*/ unsigned 
short * SMSessionKey, /*[out,retval]*/ int * errorcode );
VB:
 
StartSilentMonitorRequest int (ByVal args as CTIOSCLIENTLIB.IArguments, ByRef 
SMSessionKey AsLong) As Long
Parameters
args
Arguments array that contains the parameters listed in 
. All parameters are required.
Table 13-10
StartSilentMonitorRequest Arguments Array Parameters 
Keyword
Type
Description
AgentID or DeviceID
STRING
AgentID or DeviceID of the target to 
monitor. Specify either an AgentID or a 
DeviceID, not both,
PeripheralID 
INT
ID of the peripheral associated with the 
agent or device.
MonitoringIPAddress 
STRING
TCP/IP address of the system receiving 
audio.
MonitoringIPPort 
INT
TCP/IP port where the monitoring 
application is listening for audio.
HeartbeatInterval 
INT
Interval in seconds between heartbeats.
HeartbeatTimeout 
INT
Seconds elapsing before a Silent 
Monitor session is aborted because of 
no heartbeats received from the 
monitored peer.
SMSessionKey
An output parameter that contains the unique key to the started silent monitor session. This key must 
be used to perform any action on the currently active silent monitor session.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
Return Values
Default CTI OS return values. See 
Remarks
If the DeviceID is used, there must be an agent associated with the device. The session will timeout if 
there is no agent logged into the device. An established silent monitor session will end if the associated 
agent logs out of the device.