Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 490
   
9-20
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 9      Agent Object
Methods
Logout
The Logout method logs the agent out of the ACD. If the ACD configuration requires or supports other 
parameters, you can pass these 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
*The CTI OS server imposes no restriction on the maximum length of this string. However, such 
restrictions are generally imposed by your switch/ACD and Cisco CTI Server. Consult the 
documentation for the switch/ACD or CTI Server for information on length restrictions for this string.
errorcode
An output parameter (return parameter in VB) that contains an error code from 
 in 
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.