Feedback
Contents
- Data types and message constants
- Message field data types
- Message header data format
- NAMEDVARIABLE data format
- NAMEDARRAY data format
- Floating FieldDataID Values
- DeviceType values
- LocalConnectionState (LCS) values
- Call EventCause (CEC) values
- SystemEventID values
- ConnectionDeviceType values
- Audio Codec Type values
- CallType values
- Control Failure (CF) values
- Unified CCX Error Code values
- Special values
- Unified CCX status values
- Disposition values
- Error (E) status codes
- Reason codes for agent state change
Data types and message constants
- Message field data types
- Message header data format
- NAMEDVARIABLE data format
- NAMEDARRAY data format
- Floating FieldDataID Values
- DeviceType values
- LocalConnectionState (LCS) values
- Call EventCause (CEC) values
- SystemEventID values
- ConnectionDeviceType values
- Audio Codec Type values
- CallType values
- Control Failure (CF) values
- Unified CCX Error Code values
- Special values
- Unified CCX status values
- Disposition values
- Error (E) status codes
- Reason codes for agent state change
Message field data types
Table 1 lists the definitions of all the types of data that can appear in a Unified CCX CTI message.
Table 1 Data Type Definitions Encoded using UTF-8 and can be a multi-byte or single byte (ASCII) string of length n.
Note In a UTF string, each character may take up more than one byte.
Unspecified data occupying n consecutive bytes (used only in the floating part of a message).
A date/time, expressed as the number of seconds since midnight January 1, 1970 Coordinated Universal Time (UTC).
Message header (see Table 1).
A named call context variable (see NAMEDVARIABLE data format).
A named call context array element (see NAMEDARRAY data format).
Message header data format
The Unified CCX CTI message header is in what is called the Message HeaDeR (MHDR) data format. This is a common format used for message headers that precede all messages exchanged between a client and a server. The following table defines the MHDR format.
Table 2 Message header (MHDR) format The length of the message in bytes, excluding the size of the message header (the first 8 bytes).
This identifies the type of message and has a unique numeric value used to determine the format of the remainder of the message.
Table 1 defines the all the messages in the message set with a unique MessageTypeID number that identifies each message. To enter a message type into a message header, enter the MessageTypeID number specified for that message in Table 1.
NAMEDVARIABLE data format
NAMEDVARIABLE data and NamedArray data are specially formatted floating data fields. There can be an arbitrary number of NamedVariable and NamedArray fields in a message, subject to a combined total limit of 2000 bytes.
The NAMEDVARIABLE data type is a call context variable that has been defined in the Unified CCX Script Editor. This variable length data type can appear in the floating part of a message and has the format defined in the following table.
For information on call context variables, see Cisco Unified Contact Center Express Scripting and Development Series: Volume 1, Getting Started with Scripts and Volume 2, Editor Step Reference at http://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html
NAMEDARRAY data format
There may be an arbitrary number of NamedVariable and NamedArray fields in a message, subject to a combined total limit of 2000 bytes.
The NAMEDARRAY data type is a call context variable that has been defined in the Unified CCX Script Editor. This variable length data type may appear in the floating part of a message and has the format defined in the following table.
For information on call context variables, see Cisco Unified Contact Center Express Scripting and Development Series: Volume 1, Getting Started with Scripts and Volume 2, Editor Step Reference at http://www.cisco.com/en/US/products/sw/custcosw/ps1846/tsd_products_support_series_home.html
Floating FieldDataID Values
DeviceType values
Table 1 lists the DeviceTypes that can be used in a Unified CCX CTI message with their descriptions and code numeric values. Message types that contain field names ending with ...ConnectionDeviceType or ...DeviceType use the DeviceType values listed in Table 1.
LocalConnectionState (LCS) values
The LocalConnectionState is the local end state of a connection.
Table 1 lists the local connection states that can be included in a Unified CCX CTI message with their descriptions and numeric code values.
Call EventCause (CEC) values
Table 1 lists the causes of events that can be included in Unified CCX CTI messages with their numeric code values. The EventCause data field is described in CallType fields. An example message type containing this field is the CALL_CLEARED_EVENT message.
SystemEventID values
Table 1 lists the system event IDs that can be included in the Unified CCX CTI SYSTEM_EVENT message, with their descriptions and numeric code values.
ConnectionDeviceType values
Table 1 lists the types of connecting devices that can be included in a Unified CCX CTI message with their descriptions and numeric code values.
CallType values
Table 1 lists the call types that can be included within a message with their descriptions and values.
For further information on CallType fields, see CallType fields.
Control Failure (CF) values
Table 1 lists the Control Failure code values that can appear in the CONTROL_FAILURE_CONF message.
Unified CCX Error Code values
Special values
Table 1 shows the numeric code values used to define sizes and limits, indicate special IDs, and unspecified data elements in Unified CCX CTI messages.
Unified CCX status values
Table 1 lists the numeric codes with their descriptions for the status of the Unified CCX. The SYSTEM_EVENT message contains the Unified CCX Status field.
Disposition values
Table 1 lists all the numeric call-party disposition numeric code values with their meanings that can occur in Unified CCX CTI messages.
Error (E) status codes
Table 1 lists the status codes with their numeric code values that may be included in the FAILURE_CONF and FAILURE_EVENT Unified CCX CTI messages.
Reason codes for agent state change
Table 1 lists the reason codes for agent state change, description, and their numeric code values for change in agent’s state that may be included in the AGENT_STATE_EVENT Unified CCX CTI messages.