Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide

Page of 490
   
6-59
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 6      Event Interfaces and Events
IAgentEvents Interface
OnControlFailureConf
The OnControlFailureConf event is generated when the previously issued request, identified by the 
InvokeID field failed. It is sent in place of the corresponding confirmation message for that request.
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.
Table 6-62
OnControlFailureConf Parameters
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
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 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-63
Control Failure Codes
Status Code
Description
Value
E_CTI_NO_ERROR
No error occurred.
0
E_CTI_INVALID_ 
VERSION
The CTI Server does not support the protocol version number 
requested by the CTI client.
1
E_CTI_INVALID_ 
MESSAGE_ TYPE
A message with an invalid message type field was received.
2
E_CTI_INVALID_ 
FIELD_TAG
A message with an invalid floating field tag was received.
3
E_CTI_SESSION_ 
NOT_OPEN
No session is currently open on the connection.
4