CALL_HELD_EVENT

Placing a call on hold sends to the client a CALL_HELD_EVENT message, defined in the following tables.

CALL_HELD_EVENT Fixed Part Message Body Format

Fixed part

Field name

Value

Data type

Byte size

reserved

This value is set to 0.

UINT

4

reserved

This value is set to 1.

UINT

4

reserved

This value is set to 21.

USHORT

2

ConnectionDeviceType

The type of device ID supplied in the ConnectionDeviceID floating field. See ConnectionDeviceType Values.

USHORT

2

CallID

The Call ID value assigned to this call by Unified CCX.

UINT

4

HoldingDeviceType

Indicates the device ID type supplied in the HoldingDeviceID floating field. See DeviceType Values.

USHORT

2

LocalConnectionState

The local end state of the connection. For more information, see LocalConnectionState (LCS) Values.

USHORT

2

EventCause

Indicates a reason or explanation for the event occurrence. See Call EventCause (CEC) Values.

USHORT

2

CALL_HELD_EVENT Floating Part Message Body Format

Floating part

Field name

Value

Data type

Maximum size

ConnectionDeviceID[25] (required)

The ID of the connection between the call and the device. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field.

STRING

64

HoldingDeviceID[31] (required)

The device ID of the device that activated the hold. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field.

STRING

64