Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 508
   
9-22
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 9      Agent Object
Methods
E_CTIOS_INVALID_ARGUMENT -- null or invalid arguments were provided.
E_CTIOS_LOGIN_INCONSISTENT_ARGUMENTS -- Login request argument values for 
AgentId and/or PeripheralID do not match the values that were set by SetAgent() prior to the Login 
request.
Logout
The Logout method logs the agent out of the ACD. If the ACD configuration requires or supports other 
parameters, these can be passed in as logout parameters.  Examples are AgentPassword (required by 
Alcatel for Logout) or logout reason codes (supported on ACM ECS, Unified CCE).
Syntax
C++:
int Logout (Arguments& args)
COM:
HRESULT Logout (/*[in]*/ IArguments args, /*[out,retval]*/ int * errorcode)
VB:
Logout (args As CTIOSCLIENTLib.IArguments) As Long
Java:
int Logout(Arguments args)
.NET:
CilError Logout(Arguments args)
Input Parameters
args
Input parameter in the form of an Arguments array that contains the Logout parameters listed in 
.
Table 9-5
Logout Parameters
Keyword
Type
Description
EventReasonCode
INT
Reason for logging out. Required for 
Unified CCE, optional for all other 
switches.
AgentPassword 
(optional)
STRING
*
The agent’s password.
NumSkillGroups 
(optional)
INT
The number of Skill Groups that the agent 
is currently associated with, up to a 
maximum of 20. 
SkillGroupNumber 
(optional)
INT
The number of an agent skill group 
associated with the agent.
SkillGroupPriority 
(optional)
INT
The priority of an agent skill group 
associated with the agent.
AgentID (optional)
STRING
*
The agent’s login ID.
AgentInstrument
STRING
*
The agent’s instrument number. 
PeripheralID 
(optional)
INT
The Unified ICM Peripheral ID of the 
ACD the agent is attached to.