TRANSFER_CALL_REQ

The TRANSFER_CALL_REQ message, defined in the following tables, allows a client to transfer a held call with an active call at the same device.

This request merges the two calls with connections to a single common device. Both of the connections with the common device become NULL and their device IDs are released.

TRANSFER_CALL_REQ Fixed Part Message Body Format
Fixed part Field name	Value	Data type	Byte size
InvokeID	A unique ID generated by the CTI client for each request message. This ID is returned in the corresponding confirmation message.	UINT	4
reserved	Set this value to 1.	UINT	4
ActiveCallID	The Call ID value assigned to the currently active call by Unified CCX.	UINT	4
HeldCallID	The Call ID value assigned to the held call by Unified CCX.	UINT	4
ActiveConnectionDeviceType	The connection type of the device supplied in the ActiveConnectionDeviceID floating field. See ConnectionDeviceType Values.	USHORT	2
HeldConnectionDeviceType	The connection type of the device supplied in the HeldConnectionDeviceID floating field. See ConnectionDeviceType Values.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	BOOL	2
reserved	Set this value to 0.	BOOL	2
NumNamedVariables	The number of NamedVariable floating fields present in the floating part of the message.	USHORT	2
NumNamedArrays	The number of NamedArray floating fields present in the floating part of the message.	USHORT	2

TRANSFER_CALL_REQ Floating Part Message Body Format

Floating part

Field name

Value

Data type

Maximum size

ActiveConnectionDeviceID_[50] (required)

The device ID of the currently active call connection.

STRING

HeldConnectionDeviceID_[53] (optional)

The device ID of the held call connection. Either a HeldConnectionDeviceID or DialedNumber is required.

STRING

AgentInstrument_[6] (required)

The agent’s IP phone number.

STRING

DialedNumber_[11] (optional)

The telephone number dialed.

STRING

CallVariable1_[13] (optional)

Call-related variable data.

STRING

CallVariable2_[14]. (optional) through CallVariable9_[21] (optional)

…

CallVariable10_[22] (optional)

Call-related variable data.

STRING

CallWrapupData_[46] (optional)

Call-related wrapup data.

Note	This field is not supported for the CTI clients that connect with version 17 and above. The Wrap-Up Reason value is now expected in the NamedArray field with a key value.

STRING

NamedVariable_[82] (optional)

Call-related variable data that has a variable name defined in the Unified CCX Editor. See NAMEDVARIABLE Data Format, for the format of this field.

NAMEDVAR

251

NamedArray_[83] (optional)

Call-related variable data that has an array variable name defined in the Unified CCX Editor. See NAMEDARRAY Data Format, for the format of this field.

Note	The Wrap-Up Reason is now expected in the NamedArray field with the key name, CCWRAPUP. The maximum size of the Wrap-Up Reason value can be 40. A maximum number of five (5) Wrap-Up Reasons are allowed.

NAMEDARRAY

252

AccountCode_[78] (optional)

Account code used by CTI applications.

STRING