CALL_DATA_UPDATE_EVENT
Changes to the call context data generate a CALL_DATA_UPDATE_EVENT to the client that contains only the items that have changed. This message is optional. The initial call context is provided in the BEGIN_CALL_EVENT message.
Note | This event MUST be sent if Unified CCX changes the call ID with no other notifying events such as CALL_CONFERENCED_EVENT or CALL_TRANSFERRED_EVENT. One circumstance in Unified CCX where this can happen is when a non-ACD call is transferred through a route point into the ACD system. In the 1-2-1 transfer model, when the call is transferred, call 1 is the resultant call but is unknown to monitoring systems. |
The CALL_DATA_UPDATE_EVENT message is defined in the following tables.
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 |
Set this value to 0. The number of clients 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 |
Set this value to 0. The number of NamedVariable floating fields present in the floating part of the message. |
USHORT |
2 |
NumNamedArrays |
Set this value to 0. 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 |
Set this value to 0. 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 |
NewConnectionDeviceType |
The type of device ID supplied in the NewConnectionDeviceID floating field. See ConnectionDeviceType Values. |
USHORT |
2 |
NewCallID |
The new Call ID value assigned to this call by Unified CCX. |
UINT |
4 |
CalledPartyDisposition |
The disposition of the called party. See Disposition Values. |
USHORT |
2 |
CampaignID |
The Campaign ID value. Set this field to zero if not used. |
UINT |
4 |
reserved |
Set this value to zero. |
UINT |
4 |
Floating part Field name |
Value |
Data type |
Maximum size | ||
---|---|---|---|---|---|
ConnectionDeviceID[25] (required) |
The previous ID of the call connection. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. |
STRING |
64 | ||
NewConnectionDeviceID[47] (required) |
The new ID of the call connection. In CTI Protocol Version 14, the general rules for the Primary.Actual Field Format will apply to this field. |
STRING |
64 | ||
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 |
40 | ||
CallerEnteredDigits[12] (optional) |
The digits entered by the caller in response to the IVR prompting. |
STRING |
40 | ||
CallVariable1[13] (optional) |
Call-related variable data. |
STRING |
40 | ||
CallVariable2[14]. (optional)throughCallVariable9[21] (optional) |
… |
… |
… | ||
CallVariable10[22] (optional) |
Call-related variable data. |
STRING |
40 | ||
CallWrapupData[46] (optional) |
Call-related wrapup data.
|
STRING |
40 | ||
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.
|
NAMEDARRAY |
252 | ||
CustomerPhoneNumber (optional) |
Customer phone number. |
STRING |
20 | ||
CustomerAccountNumber[96] (optional) |
Customer Account Number. |
STRING |
32 |