CONSULT_CALL_REQ

The CONSULT_CALL_REQ message, defined in the following tables, requests the combined action of placing an active call on hold and then making a new call.

By default, the call context data of the active call is used to initialize the context data of the consultation call. A client can override some or all of this original call context in the consultation call by providing the desired values in this request.

CONSULT_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 active call by Unified CCX.	UINT	4
ActiveConnectionDeviceType	The connection type of the device supplied in the ActiveConnectionDeviceID floating field. See ConnectionDeviceType Values.	USHORT	2
reserved	Set this value to 0.	USHORT	2
reserved	Set this value to 0.	USHORT	2
ConsultType	Use following values: 0: Unspecified 1: Transfer 2: Conference	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

CONSULT_CALL_REQ Floating Part Message Body Format

Floating part

Field name

Value

Data type

Maximum size

ActiveConnectionDeviceID_[50] (required)

The device ID of the active call connection.

STRING

DialedNumber _[11] (required)

The number to be dialed to establish the new call.

STRING

AgentInstrument_[6] (optional)

The phone number of the agent’s IP phone that initiates the new call.

STRING

CallVariable1_[13] (optional)

Call-related variable data used in place of the corresponding variable from the active call.

STRING

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

…

CallVariable10_[22] (optional)

Call-related variable data that used in place of the corresponding variable from the active call.

STRING

CallWrapupData_[46] (optional)

Call-related wrapup data used in place of the corresponding data from the active call.

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