SET_CALL_DATA_REQ

This message is sent by a client or Unified CCX to set one or more call variables and/or call wrap-up data. The combination of CallID, ConnectionDeviceType, and ConnectionDeviceID uniquely identify the call to be operated on. Variables not provided in the message are not affected. See also Call Context Data.

The SET_CALL_DATA_REQ and SET_CALL_DATA_CONF messages are defined in the following table and in SET_CALL_DATA_CONF.

SET_CALL_DATA_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
ConnectionDeviceType	The type of device ID supplied in the ConnectionDeviceID floating field. See ConnectionDeviceType Values.	USHORT	2
CallID	The Call ID value assigned to the call by Unified CCX.	UINT	4
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
CallType	The general classification of the call type. See CallType Values, page 9-13.	USHORT	2
CalledPartyDisposition	Indicates the disposition of the called party. See Disposition Values, page 9-19.	USHORT	2
reserved	Set this value to 0.	UINT	4
reserved	Set this value to 1.	UINT	4

SET_CALL_DATA_REQ 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.

STRING

ANI_[8] (optional)

The calling line ID of the caller.

STRING

CallerEnteredDigits_[12] (optional)

The digits entered by the caller in response to IVR prompting.

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

CustomerAccountNumber_[96] (optional)

Customer Account Number.

STRING