Cisco Cisco Computer Telephony Integration Option 8.5 Reference Guide

Page of 276
   
5-129
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 5      Application Level Interfaces
Client Control Service
HOLD_CALL_REQ
Use this message to place an existing call connection into the held state. The HOLD_CALL_REQ 
message is defined in 
:
The CTI Server sends the HOLD_CALL_CONF message, defined in 
, to confirm receipt of 
the request.
Table 5-107
HOLD_CALL_REQ Message Format 
Fixed Part
Field Name
Value
Data Type
Byte Size
MessageHeader
Standard message header. MessageType = 54.
MHDR
8
InvokeID
An ID for this request message, returned in the 
corresponding confirm message.
UINT
4
PeripheralID
The Unified ICM PeripheralID of the ACD 
where the call is located.
UINT
4
ConnectionCallID
The Call ID value assigned to the call by the 
peripheral or Unified ICM.
UINT
4
ConnectionDevice 
IDType
The type of device ID in the ConnectionDeviceID 
floating field (
USHORT
2
Reservation
TRUE to reserve the facility for reuse by the 
held call. Not appropriate for most non-ISDN 
telephones.
BOOL
2
Floating Part
Field Name
Value
Data Type
Max. 
Size
ConnectionDevice ID 
The device ID of the device associated with the 
connection.
STRING
64
AgentInstrument 
(optional)
The agent’s ACD instrument number.
STRING
64
Maximum message size (including header):
156
Table 5-108
HOLD_CALL_CONF Message Format
Field Name
Value
Data Type
Byte 
Size
MessageHeader
Standard message header. MessageType = 55.
MHDR
8
InvokeID
Set to the value of the InvokeID from the corresponding 
request message.
UINT
4
Maximum message size (including header): 
12