Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide
9-21
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 9 Agent Object
Methods
*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.
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.
** Either AgentID or LoginName is required.
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 Login request is successful, it returns a CIL_OK CtiOs_Enums.CilError code In addition, the
requesting client should expect an AgentStateChange event if the request is successful with an
Arguments member with keyword “AgentState” and value of the agent’s current state. (See
GetAgentState for possible values.)
requesting client should expect an AgentStateChange event if the request is successful with an
Arguments member with keyword “AgentState” and value of the agent’s current state. (See
GetAgentState for possible values.)
If the Login request is unsuccessful, the client will receive an OnControlFailureConf event and the
request will return one of the following CtiOs_Enums.CilError codes:
request will return one of the following CtiOs_Enums.CilError codes:
•
E_CTIOS_INVALID_SESSION -- either the agent is not associated with the session or the session
is not connected.
is not connected.
AgentWorkMode
(optional)
(optional)
INT
A value representing the desired work
mode of the agent. Used by Avaya
Communications Manager (ACM) ECS
with default value of ManualIn.
mode of the agent. Used by Avaya
Communications Manager (ACM) ECS
with default value of ManualIn.
NumSkillGroups
(optional)
(optional)
INT
The number of Skill Groups that the agent
is currently associated with, up to a
maximum of 20.
is currently associated with, up to a
maximum of 20.
PeripheralID
(optional)
(optional)
INT
The Unified ICM Peripheral ID of the
ACD the agent is attached to.
ACD the agent is attached to.
SkillGroupNumber
(optional)
(optional)
INT
The user-defined number of an agent skill
group associated with the agent.
group associated with the agent.
SkillGroupPriority
(optional)
(optional)
INT
The priority of an agent skill group
associated with the agent.
associated with the agent.
Agent CallMode
INT
A value that indicates the agent's call
mode. Valid values are call-by-call (3)
and nailed-up (4).
mode. Valid values are call-by-call (3)
and nailed-up (4).
AgentRemote
Number
Number
STRING
The phone number that the agent uses for
remote login.
remote login.
RemoteLogin
INT
A value that indicates the agent is
configured for remote login as a remote
agent.
configured for remote login as a remote
agent.
Keyword
Type
Description