Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 506
C H A P T E R
   
9-1
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
9
Agent Object
The Agent object provides developers using the CTI OS Client Interface Library with an interface to 
Agent behavior. The Agent object exposes methods to perform all agent behaviors, such as logging in 
and setting the agent’s state.
The object stores specific agent information as properties, including the AgentID, AgentPassword, 
AgentInstrument, AgentExtension, and SkillGroups. When the agent is logged into an ACD, the agent 
object receives updates through AgentStateEvents and Agent Statistics updates. 
The Agent object can be used in two different modes:
In Agent Mode, the application should create an Agent object and inform the Session about the agent 
using Session.SetAgent()
In Monitor Mode, the client application sets a message filter, and if the event stream involves events 
for Agent objects, those objects will be dynamically created at the CIL as needed. 
Agent Object Properties 
 lists the agent object properties.
Note
The data type listed for each keyword is the standardized data type discussed in the section 
 See 
 for the appropriate language 
specific types for these keywords.
Table 9-1
Agent Object Properties
.
Keyword
Type
Description
AgentAvailability 
Status
INT
One of the following values: UNKNOWN (-1), NOT 
AVAILABLE (0), ICM AVAILABLE (1), or 
APPLICATION AVAILABLE (2).
Agent CallMode
INT
A value that indicates the agent's call mode. Valid values are 
call-by-call (3) and nailed-up (4).
AgentExtension
STRING
*
Extension associated by ACD to agent.
AgentID
STRING
*
Can be set prior to Login or after Logout. 
AgentInstrument STRING
*
Instrument associated by ACD to agent.
AgentRemote Number
STRING
The phone number that the agent uses for remote login.