Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide
6-56
CTI OS Developer’s Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 7.5(1)
Chapter 6 Event Interfaces and Events
IAgentEvents Interface
Syntax
C++:
void OnControlFailureConf(Arguments& args)
COM:
void OnControlFailureConf (IArguments * args)
VB:
session_OnControlFailureConf (ByVal args As CtiosCLIENTLib.IArguments)
Parameters
args
Arguments array containing the following fields.
Keyword
Type
Description
InvokeID
INT
InvokeID of the request that failed
FailureCode
SHORT
A value specifying the reason that the request failed. See
for a
list of the Control Failure Codes.
PeripheralError
Code
Code
INT
Peripheral-specific error data, if available. Zero otherwise.
AgentID
STRING Agent ID that represents a specific client.
UniqueObjectID STRING An object ID that uniquely identifies the call object.
MessageType
INT
Contains the CTI OS Command Request ID that failed to execute. The
message types that can be included in this parameter are those to used to
control Call, Agent State and Supervisor actions. Refer to
message types that can be included in this parameter are those to used to
control Call, Agent State and Supervisor actions. Refer to
for a complete list.
ErrorMessage
STRING String text containing the description of the failure.
Table 6-2
Control Failure Codes
Status Code
Description
Value
E_CTI_NO_ERROR
No error occurred.
0
E_CTI_INVALID_
VERSION
VERSION
The CTI Server does not support the protocol version number
requested by the CTI client.
requested by the CTI client.
1
E_CTI_INVALID_
MESSAGE_ TYPE
MESSAGE_ TYPE
A message with an invalid message type field was received.
2
E_CTI_INVALID_
FIELD_TAG
FIELD_TAG
A message with an invalid floating field tag was received.
3
E_CTI_SESSION_
NOT_OPEN
NOT_OPEN
No session is currently open on the connection.
4
E_CTI_SESSION_
ALREADY_ OPEN
ALREADY_ OPEN
A session is already open on the connection.
5
E_CTI_REQUIRED_
DATA_ MISSING
DATA_ MISSING
The request did not include one or more floating items that are
requir ed.
requir ed.
6
E_CTI_INVALID_
PERIPHERAL_ID
PERIPHERAL_ID
A message with an invalid PeripheralID value was received.
7
E_CTI_INVALID_
AGENT_ DATA
AGENT_ DATA
The provided agent data item(s) are invalid.
8