Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 490
   
6-35
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(3)
Chapter 6      Event Interfaces and Events
ICallEvents Interface
Table 6-31
OnCallEstablished Parameters
OnCallFailed
The OnCallFailed event is generated when a call is not completed. With this event the connection status 
becomes LCS_FAIL. This usually happens as a result of a MakeCall or a MakeConsultCall request, but 
can occur at any other point in the call’s lifetime if the call fails on an ACD. In this case, you should 
perform any required cleanup prior to arrival of an EndCall event.
Note
The events (CallConnectionCleared and CallCleared) received after the CallFailed event does not 
include a CallStatus because, until the call has ended, it is important to preserve the fact that this is a 
failed call. 
Syntax
C++:
void OnCallFailed(Arguments& args)
COM:
void OnCallFailed (IArguments * args)
VB:
session_OnCallFailed (ByVal args As CtiosCLIENTLib.IArguments
Keyword
Type
Description
ServiceNumber 
INT
The service that the call is attributed to, as known to the 
peripheral. May contain the special value NULL_ SERVICE 
when not applicable or not available.
ServiceID
INT
The Unified ICM ServiceID of the service that the call is 
attributed to. May contain the special value NULL_SERVICE 
when not applicable or not available.
SkillGroupNumber 
(Optional)
INT
The user-defined number of the agent SkillGroup the call is 
attributed to, as known to the peripheral. May contain the 
special value NULL_SKILL_GROUP when not applicable or 
not available.
SkillGroupID (Optional)
INT
The system-assigned identifier of the agent SkillGroup the 
call is attributed to. May contain the special value 
NULL_SKILL_GROUP when not applicable or not available.
SkillGroupPriority 
(Optional)
SHORT
The priority of the skill group, or 0 when skill group priority 
is not applicable or not available.
LineType
SHORT
Indicates the type of the teleset line.
EnablementMask
INT
Contains the bit-mask that specifies what buttons can be 
enabled or disabled when this call is the current call. See 
.
UniqueObjectID
STRING
An object ID that uniquely identifies the call object.
CallStatus
SHORT
The current status of the call.
ICMEnterpriseUniqueID 
(Optional)
STRING
Required only when the call is pre-routed.
TrunkNumber (optional)
INT
The number representing a trunk.
TrunkGroup Number 
(optional)
INT
The number representing a trunk group.