SNAPSHOT_CALL_CONF

The SNAPSHOT_CALL_CONF message, defined in the following tables, confirms the processing completion of the requested Snapshot Call data.

SNAPSHOT_CALL_CONF Fixed Part Message Body Format

Fixed part

Field name

Value

Data type

Byte size

InvokeID

Set to the same value as the InvokeID from the corresponding request message.

UINT

4

CallType

This value is set to 0.

USHORT

2

reserved

This value is set to 0.

USHORT

2

NumCallDevices

The number of active devices associated with this call, up to a maximum of 16.

This value also indicates the number of CallCallID, CallConnectionDeviceType, CallConnectionDeviceID, CallDeviceType, CallDeviceID, and CallDeviceConnectionState floating fields 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

reserved

This value is set to 0.

USHORT

2

reserved

( Only available in CTI Protocol version 11 and later.)

This value is set to 0.

INT

4

SNAPSHOT_CALL_CONF Floating Part Message Body Format

Floating part

Field name

Value

Data type

Maximum size

ANI[8] (optional)

The calling line ID of the caller.

STRING

40

DNIS[10] (optional)

The DNIS provided with the call.

STRING

32

DialedNumber[11](optional)

The number dialed.

STRING

40

CallerEnteredDigits[12] (optional)

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

STRING

40

reserved[72] (required)

This value is set to 0.

UINT

4

reserved [73] (required)

This value is set to 0.

UINT

4

CallVariable1[13] (optional)

Call-related variable data.

STRING

40

CallVariable2[14]. (optional) through CallVariable9[21] (optional)

CallVariable10[22] (optional)

Call-related variable data.

STRING

40

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

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.

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

CallConnectionCallID[56] (optional)

The Call ID value assigned to one of the call device connections. There can be more than one CallCallID field in the message (see NumCallDevices, above).

UINT

4

CallConnectionDeviceType[57] (optional)

The connection type of the device supplied in the following CallConnectionDeviceID floating field. There can be more than one CallConnectionDeviceType fields in the message (see NumCallDevices, above). This field always immediately follows the corresponding CallConnectionCallID field. See ConnectionDeviceType Values.

USHORT

2

CallConnectionDeviceID[58] (optional)

The device ID of one of the call connections. There can be more than one CallConnectionDeviceID field in the message (see NumCallDevices, above). This field always immediately follows the corresponding CallConnectionDeviceType field. See ConnectionDeviceType Values.

STRING

64

CallDeviceType[59] (optional)

The device ID type of the device supplied in the following CallDeviceID floating field. See DeviceType Values.

There can be more than one CallDeviceType field in the message (see NumCallDevices, above). This field always immediately follows the corresponding CallConnectionDeviceID field.

USHORT

2

CallDeviceID[60] (optional)

The device ID of the subject device. There can be more than one CallDeviceID field in the message (see NumCallDevices, above). This field always immediately follows the corresponding CallDeviceType field.

STRING

64

CallDeviceConnectionState[61] (optional)

The local connection state of one of the call device connections. There can be more than one CallDeviceConnectionState field in the message (see NumCallDevices, above). This field always immediately follows the corresponding CallDeviceID field.

USHORT

2