Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 506
   
9-34
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 9      Agent Object
Methods
Syntax
C++:
int SetAgentState(Arguments& args)
COM:
HRESULT SetAgentState (/*[in]*/ IArguments *args, /*[out,retval]*/ int * 
errorcode)
VB:
SetAgentState (args As CTIOSCLIENTLib.IArguments) As Long
Java:
int SetAgentState(Arguments args)
.NET:
CilError SetAgentState(Arguments args)
Input Parameters
args
Input parameter in the form of an Arguments array that contains one or more of the SetAgentState 
parameters listed in the following table.
Table 9-15
SetAgentState Parameters
Keyword
Type
Description
AgentState (required)
INT
The state to which to set the specified 
agent. The value of this field must be 
one of the values in 
AgentID (required)
STRING
*
The agent’s login ID.
AgentInstrument
STRING
*
The agent’s instrument number. 
Optional if Agent Extension is 
provided.
PositionID
STRING
*
Required for Alcatel only.
AgentPassword 
(optional)
STRING
*
The agent’s password.
AgentWorkMode 
(optional)
INT
A value representing the desired work 
mode of the agent. Used by ACM ECS 
with default value of ManualIn.
NumSkillGroups 
(optional)
INT
The number of Skill Groups that the 
agent is currently associated with, up to 
a maximum of 20. 
EventReasonCode 
(optional)
INT
Reason for logging out. Required for 
Unified CCE, optional for all other 
switches.
PeripheralID 
(optional)
INT
The Unified ICM Peripheral ID of the 
ACD the agent is attached to.
SkillGroupNumber 
(optional)
INT
The user-defined number of an agent 
skill group associated with the agent.
SkillGroupPriority 
(optional)
INT
The priority of an agent skill group 
associated with the agent.