CALL_DELIVERED_EVENT

The arrival of a call at any device on Unified CCX generates a CALL_DELIVERED_EVENT message to the client. This event generally indicates the called device is ringing. This is defined in the following tables.

The LocalConnectionState field can be used to distinguish between those cases of the call arriving at the switch and those cases of the call arriving at an agent IP phone.

CALL_DELIVERED_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
reserved	This value is set to 0xffff.	USHORT	2
lineType (Version 14 and later)	The type of line that helps to identify a business call or a non-business call. This value is set to 3 for a business call and 10 for a non-business call.	USHORT	2
ApplicationID	The Application ID of the call.	UINT	4
reserved	This value is set to 0xffffffff.	UINT	4
CSQID	The Contact Service Queue ID of the call.	UINT	4
reserved	This value is set to 0xffffffff.	UINT	4
reserved	This value is set to 0.	USHORT	2
AlertingDeviceType	Indicates the device ID type supplied in the AlertingDeviceID floating field. See DeviceType Values.	USHORT	2
CallingDeviceType	Indicates the device ID type supplied in the CallingDeviceID floating field. See DeviceType Values.	USHORT	2
CalledDeviceType	Indicates the device ID type supplied in the CalledDeviceID floating field. See DeviceType Values.	USHORT	2
LastRedirectDeviceType	Indicates the type of the device ID supplied in the LastRedirectDeviceID 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
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

CALL_DELIVERED_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

AlertingDeviceID_[26] (required)

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

STRING

CallingDeviceID_[27] (optional)

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

STRING

CalledDeviceID_[28] (required)

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

STRING

LastRedirectDeviceID_[29] (optional)

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

STRING

SecondaryCallID_[202] (optional)

The ID of the consultation Call that Unified CCX placed from the CTI port to the agent IP phone.

UINT

ANI_[8](optional)

ANI (Automatic Number Identification). The telephone number of the person making the call. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field.

STRING

UserToUserInfo_[9] (optional)

The user-to-user information element.

UNSPEC

131

DNIS_[10](optional)

The DNIS (Dialed Number Identification Service) provided with the call; that is, the number associated with a call on a switch. This can be different, though often it is not, from the number the caller dialed. This is different if the call is transferred. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field.

STRING

DialedNumber_[11] (optional)

The telephone number dialed. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field.

STRING

CallerEnteredDigits_[12](optional)

The digits entered by the caller in response to the 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 would now be returned in the NamedArray field.

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 Reasons are returned in the NamedArray fields with the key name, CCWRAPUP for the CTI clients that connect with version 17 and above. 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