BEGIN_CALL_EVENT

The first association between a call and a client (a route point, a CTI port, or an agent phone to which the agent has logged in) generates a BEGIN_CALL_EVENT message to the client, providing the call ID and the initial call context data. This message is optional.

The CallID identifies the call, and the ConnectionDeviceType and ConnectionDeviceID uniquely identify the client’s local call connection, if any, or another valid call connection.

This message always precedes any other event messages for that call. Subsequent changes to the call context data (if any) result in CALL_DATA_UPDATE_EVENT messages containing the changed call data being sent to the client.

Note	There can be multiple calls with the same CallID value.

The following tables define the format of the BEGIN_CALL_EVENT message.

BEGIN_CALL_EVENT Fixed Part Message Body Format
Fixed part Field name	Value	Data type	Byte size
reserved	Set this value to 0.	UINT	4
reserved	Set this value to 1.	UINT	4
reserved	Set this value to 21.	USHORT	2
NumCTIClients	The number of clients previously associated with this call. This value also indicates the number of client signatures and timestamps that are present in the floating part of the message.	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
CallType	The general classification of the call type. See CallType Values.	USHORT	2
ConnectionDeviceType	The type of device ID supplied in the ConnectionDeviceID floating field. See Table 1	USHORT	2
CallID	The Call ID value assigned to this call by Unified CCX.	UINT	4
CalledPartyDisposition	Indicates the disposition of the called party. See Disposition Values.	USHORT	2

BEGIN_CALL_EVENT Floating Part Message Body Format

Floating part

Field name

Value

Data type

MaxSize

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

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

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