Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide
3-10
CTI OS Developer’s Guide for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 3 CIL Coding Conventions
UniqueObjectID
Table 3-4
UniqueObjectID Components
Note
The CTI OS UniqueObjectID is not the same as the Unified ICM globally unique 64 bit key used in the
Unified ICME historical databases (herein called the ICMEnterpriseUniqueID), which exists only for
calls. The ICMEnterpriseUniqueID stays with the call even when the call is transferred between call
center sites, whereas the UniqueObjectID for a call is specific to its site (by PeripheralID,
ConnectionCallID, and ConnectionDeviceID).
Unified ICME historical databases (herein called the ICMEnterpriseUniqueID), which exists only for
calls. The ICMEnterpriseUniqueID stays with the call even when the call is transferred between call
center sites, whereas the UniqueObjectID for a call is specific to its site (by PeripheralID,
ConnectionCallID, and ConnectionDeviceID).
The ICMEnterpriseUniqueID in CTI OS takes the form of a variable-length string with the form
“icm.routercallkeyday.routercallkeycallid”
where routercallkeyday is the field Day in the Unified ICM Route_Call_Detail and
Termination_Call_Detail tables, and routercallkeycallid is the field RouterCallKey in the Unified ICM
Route_Call_Detail and Termination_Call_Detail tables.
Termination_Call_Detail tables, and routercallkeycallid is the field RouterCallKey in the Unified ICM
Route_Call_Detail and Termination_Call_Detail tables.
The CTI OS server enables certain types of monitor mode applications that track the pre-call notification
event (eTranslationRouteEvent or eAgentPrecallEvent) and seek to match the call data with the arrival
of an eCallBeginEvent.
event (eTranslationRouteEvent or eAgentPrecallEvent) and seek to match the call data with the arrival
of an eCallBeginEvent.
To do so, the application will receive the pre-call notification (for calls routed by Unified ICM (either
pre-route, post-route, or translation route), and create a record (object) using the
ICMEnterpriseUniqueID field as the with a unique key. Later, when the call arrives at the ACD, and is
pre-route, post-route, or translation route), and create a record (object) using the
ICMEnterpriseUniqueID field as the with a unique key. Later, when the call arrives at the ACD, and is
Object Type
Sample
UniqueObjectID
UniqueObjectID
Explanation
Call Object
call.5000.202.23901
The call object is uniquely identified
by its PeripheralID (5000, generated
by Unified ICM), ConnectionCallID
(202, generated by the PBX/ACD),
and its ConnectionDeviceID (23901,
generated by the PBX/ACD).
by its PeripheralID (5000, generated
by Unified ICM), ConnectionCallID
(202, generated by the PBX/ACD),
and its ConnectionDeviceID (23901,
generated by the PBX/ACD).
Agent Object
agent.5000.22866
The agent object is uniquely
identified by its PeripheralID (5000,
generated by Unified ICM), and its
agent ID.
identified by its PeripheralID (5000,
generated by Unified ICM), and its
agent ID.
Device Object
(for events only;
no CIL object)
(for events only;
no CIL object)
device.5000.23901
The device object is uniquely
identified by its PeripheralID (5000,
generated by Unified ICM), and its
instrument number (configured by
the PBX/ACD).
identified by its PeripheralID (5000,
generated by Unified ICM), and its
instrument number (configured by
the PBX/ACD).
SkillGroup
Object
Object
skillgroup.5000.77
The skill group object is uniquely
identified by its PeripheralID (5000,
generated by Unified ICM), and its
SkillGroupNumber (configured by
the PBX/ACD).
identified by its PeripheralID (5000,
generated by Unified ICM), and its
SkillGroupNumber (configured by
the PBX/ACD).
Team Object
(for events only;
no CIL object)
(for events only;
no CIL object)
team.5000.5001
The team object is uniquely
identified by its PeripheralID (5000,
generated by Unified ICM), and its
TeamID (5001, also generated by
Unified ICM).
identified by its PeripheralID (5000,
generated by Unified ICM), and its
TeamID (5001, also generated by
Unified ICM).