This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Data Types and Message Constants
This reference chapter includes the following miscellaneous message constant values.
Message Field Data TypesTable 1: Data Type Definitions , on page 2 lists the definitions of all the types of data that can appear in aUnified CCX CTI message.
Table 1: Data Type Definitions
Byte sizeMeaningData type
1Signed integer, -128 to 127CHAR
1Unsigned integer, 0 to 255UCHAR
2Signed integer, -32,768 to 32,767SHORT
2Unsigned integer, 0 to 65,535USHORT
4Signed Integer, -2,147,483,648 to 2,147,483,647INT
4Unsigned Integer, 0 to 4,294,967,295UINT
2Boolean (False = 0, True = 1)BOOL
nEncoded using UTF-8 and can be a multi-byte or single byte (ASCII)string of length n.
In a UTF string, each character may take up more than onebyte.
Note
(used only in the floating part of a message)
STRING[n]
nUnspecified data occupying n consecutive bytes (used only in thefloating part of a message).
UNSPEC[n]
4A date/time, expressed as the number of seconds since midnight January1, 1970 Coordinated Universal Time (UTC).
TIME
8Message header (see Table 2: Message Header (MHDR) Format , onpage 3).
MHDR
3… 251A named call context variable (see NAMEDVARIABLE Data Format,on page 3).
NAMEDVAR
4… 252A named call context array element (see NAMEDARRAYData Format,on page 4).
Data Types and Message ConstantsMessage Field Data Types
Message Header Data FormatThe Unified CCX CTI message header is in what is called the Message HeaDeR (MHDR) data format. Thisis a common format used for message headers that precede all messages exchanged between a client and aserver. The following table defines the MHDR format.
Table 2: Message Header (MHDR) Format
Byte SizeData TypeValueFixed partField Name
4UINTThe length of the message in bytes, excluding the sizeof the message header (the first 8 bytes).
BodyLength
4UINTThis identifies the type of message and has a uniquenumeric value used to determine the format of theremainder of the message.
Table 1 defines the all the messages in the messageset with a unique MessageTypeID number thatidentifies each message. To enter a message type intoa message header, enter the MessageTypeID numberspecified for that message in Table 1.
MessageTypeID
NAMEDVARIABLE Data FormatNAMEDVARIABLE data and NamedArray data are specially formatted floating data fields. There can bean arbitrary number of NamedVariable and NamedArray fields in a message, subject to a combined total limitof 2000 bytes.
The NAMEDVARIABLE data type is a call context variable that has been defined in the Unified CCX ScriptEditor. This variable length data type can appear in the floating part of a message and has the format definedin the following table.
Table 3: Named Call-Context Variable (NAMEDVAR) Format
Maximumsize
Data TypeValueSubfield
1UCHARNAMED_VARIABLE (= 82). This is the numericfloating field ID that indicates the following data isa named call-context variable.
FieldDataID
1UCHARThe total length of the VariableName andVariableValue fields, including the null-terminationbytes. The value of this field may range from 3 to251.
33STRINGThe null-terminated defined name of the variable.VariableName
211STRINGThe null-terminated value of the variable.VariableValue
For information on call context variables, see Cisco Unified Contact Center Express Scripting andDevelopmentSeries: 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 FormatThere may be an arbitrary number of NamedVariable and NamedArray fields in a message, subject to acombined total limit of 2000 bytes.
The NAMEDARRAY data type is a call context variable that has been defined in the Unified CCX ScriptEditor. This variable length data type may appear in the floating part of a message and has the format definedin the following table.
Table 4: Named Call Context Array Variable (NAMEDARRAY) Format
Maximumsize
Data TypeValueSubfield
1UCHARNAMED_ARRAY (= 83). The floating field tag thatindicates that the following data is a named callcontext array variable.
FieldDataID
1UCHARThe total length of the VariableIndex, VariableNameand VariableValue fields, including thenull-termination bytes. The value of this field mayrange from 4 to 252.
FieldLength
1UCHARThe index of the array variable.VariableIndex
33STRINGThe null-terminated defined name of the arrayvariable.
VariableName
211STRINGThe null-terminated value of the array variable.VariableValue
For information on call context variables, see Cisco Unified Contact Center Express Scripting andDevelopmentSeries: 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 ValuesThe following table lists all the FieldDataID numeric values that identify data fields in the floating part of aUnified CCX CTI message.
Table 5: Floating FieldDataID Values Organized by the FieldDataID Name
Data Types and Message ConstantsFloating FieldDataID Values
Floating FieldDataID nameID value
reserved209-216
MultilineAgentControl224
NumPeripherals228
DeviceType ValuesTable 6: DeviceType Values , on page 10 lists the DeviceTypes that can be used in a Unified CCX CTImessage 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 6: DeviceType Values, on page 10.
Table 6: DeviceType Values
ValueDescriptionDeviceType
0xffffNo device ID is provided.DEVID_NONE
0The provided device ID identifies an IP phone(extension).
DEVID_DEVICE_IDENTIFIER
70reserved
71reserved
72reserved
73The provided device ID identifies a CTI PORTDEVID_CTI_PORT
74The provided device ID identifies a ROUTEPOINT
DEVID_ROUTE_POINT
75reserved
76The provided device ID is the ID of an AGENTDevice (phone)
DEVID_AGENT_DEVICE
77The provided device ID is the ID of a QUEUEDEVID_QUEUE
78The provided device ID is the ID belonging toAgent's non-ACD extension.
LocalConnectionState (LCS) ValuesThe LocalConnectionState is the local end state of a connection.
Table 7: LocalConnectionState Values , on page 11 lists the local connection states that can be included ina Unified CCX CTI message with their descriptions and numeric code values.
Table 7: LocalConnectionState Values
ValueDescriptionLocalConnectionState
0xffffNot applicableLCS_NONE
0No relationship between call and device.LCS_NULL
1Device requesting service (“dialing”).LCS_INITIATE
2Device is alerting (“ringing”).LCS_ALERTING
3Device is actively participating in the call.LCS_CONNECT
4Device is inactively participating in the call.LCS_HOLD
5Device is stalled attempting to connect to a call, or a call is stalledattempting to connect to a device.
LCS_QUEUED
6A device-to-call or call-to-device connection attempt has beenaborted.
LCS_FAIL
Call EventCause (CEC) ValuesTable 8: EventCause Values , on page 11 lists the causes of events that can be included in Unified CCX CTImessages with their numeric code values. The EventCause data field is described in CallType Fields. Anexample message type containing this field is the CALL_CLEARED_EVENT message.
Data Types and Message ConstantsCall EventCause (CEC) Values
ValueEventCause
46CEC_SUPERVISOR_MONITOR
47CEC_SUPERVISOR_WHISPER
48CEC_SUPERVISOR_BARGE_IN
49CEC_SUPERVISOR_INTERCEPT
50CEC_CALL_PARTY_UPDATE_IND
Extended Call Cleared Event Causes
1001-1013reserved
1014CECX_DROP_HANDLED_OTHER
1015-1056reserved
SystemEventID ValuesTable 9: System Event ID Values , on page 13 lists the system event IDs that can be included in the UnifiedCCX CTI SYSTEM_EVENT message, with their descriptions and numeric code values.
Data Types and Message ConstantsSystemEventID Values
ValueDescriptionSystemEventID
10An Agent or Unified CCX device target hasbeen removed from service.
SYS_INSTRUMENT_OUT_OF_SERVICE
11An EnterpriseAgent or IPCC device target hasbeen returned to service.
SYS_INSTRUMENT_BACK_IN_SERVICE
ConnectionDeviceType ValuesTable 10: ConnectionDevice Type Values, on page 14 lists the types of connecting devices that can beincluded in a Unified CCX CTI message with their descriptions and numeric code values.
Table 10: ConnectionDevice Type Values
ValueDescriptionConnectionDeviceType
0xffffNo ConnectionDevice type is provided.CONNECTION_ID_NONE
0The ConnectionDevice type value is stable over time betweencalls.
CONNECTION_ID_STATIC
1The ConnectionDevice type value is dynamic and may changebetween calls.
CONNECTION_ID_DYNAMIC
Audio Codec Type ValuesTable 11: Code Values for Audio Codec Types
23Supervisor conferenced into call.CALLTYPE_ SUPERVISOR_BARGE_IN
24Supervisor replaces agent on call.CALLTYPE_ SUPERVISOR_INTERCEPT
25-26reserved
Control Failure (CF) ValuesTable 13: Control Failure Code Values , on page 16 lists the Control Failure code values that can appear inthe CONTROL_FAILURE_CONF message.
Table 13: Control Failure Code Values
ValueDescriptionFailureCode
0An error has occurred that is not one of thefollowing error types.
Data Types and Message ConstantsUnified CCX Error Code Values
ValueDescriptionUnified CCX Error Code
88057Number of concurrent recordings exceedsthe value of recording count available inthe Recording License.
CCX_RECORDING_LICENSE_LIMIT_EXCEEDED
Special ValuesTable 15: Special Values , on page 26 shows the numeric code values used to define sizes and limits, indicatespecial IDs, and unspecified data elements in Unified CCX CTI messages.
Table 15: Special Values
ValueDescriptionConstant
16The maximum number of call devices that canbe in a message list.
MAX_NUM_DEVICES
99In AGENT_STATE_EVENT messageMAX_CSQ_COUNT
64In AGENT_TEAM_CONFIG messageMAX_AGENTS
0xFFFFFFFFIndicates that no call ID is supplied.NULL_CALL_ID
0xFFFFFFFFIndicates that no Service is supplied.NULL_APPLICATION
0xFFFFFFFFIndicates that no CSQ is supplied.NULL_CSQ
0xFFFFIn message constantsNULL_LINEHANDLE
Unified CCX Status ValuesTable 16: Unified CCX Status Values , on page 26 lists the numeric codes with their descriptions for thestatus of the Unified CCX. The SYSTEM_EVENT message contains the Unified CCX Status field.
Table 16: Unified CCX Status Values
Mask valueDescriptionUnified CCX status
0x00000100The server is initializingCCX_INITIALIZING
0x00000200The server is shutting downCCX_SHUTTING_DOWN
0x00000500The server is in Partial ServiceCCX_PARTIAL_SERVICE
0x00000600The server failed to initializeCCX_OUT_OF_SERVICE
Disposition ValuesTable 17: Call-Party Disposition Values , on page 27 lists all the numeric call-party disposition numeric codevalues with their meanings that can occur in Unified CCX CTI messages.
Table 17: Call-Party Disposition Values
MeaningDisposition Code
reserved1-14
Redirected15
reserved16-27
reserved28
Announced Transfer29
Conferenced30
reserved31-52
Error (E) Status CodesTable 18: Error Status Codes , on page 27 lists the status codes with their numeric code values that may beincluded in the FAILURE_CONF and FAILURE_EVENT Unified CCX CTI messages.
Table 18: Error Status Codes
ValueDescriptionStatus code
0No error occurred.E_CTI_NO_ERROR
1The server does not support the protocol versionnumber requested by the client.
Data Types and Message ConstantsError (E) Status Codes
ValueDescriptionStatus code
94Indicates a JTAPI or Cisco UnifiedCommunications Manager problem.
E_CTI_JTAPI_CCM_PROBLEM
95reserved
96The client needs to resend theCONFIG_REQUEST_KEY_EVENT and theCONFIG_REQUEST_EVENT message.
E_CTI_AUTO_CONFIG_RESET
Reason Codes for Agent State ChangeTable 1 lists the reason codes for agent state change, description, and their numeric code values for changein agent’s state that may be included in the AGENT_STATE_EVENT Unified CCX CTI messages.
Table 19: Reason Codes for Agent State Change
ValueDescriptionReason codes for agent state change
32767The Agent logs in again.AGT_RELOGON
32766The Agent closes the CADAGT_CLOSE_CAD
32765Connection between theUnified CCX andCADis down.
AGT_CONN_DOWN
32764Unified CCX failure.CCX_FAILURE
32763The Agent did not answer the call.AGT_RNA
32762The Agent goes off-hook.AGT_OFFHOOK
32761The Agent receives a direct non-business call.AGT_NON_ICD
32760The Agent logs in.AGT_LOGON
32759The Agent's phone is down.AGT_PHONE_DOWN
32758The Agent's work timer expired.AGT_WORK_TIMER_EXP
32757Call Manager failover.CM_FAILOVER
32756The Agent's phone is up.AGT_PHONE_UP
32755The Agent's Call ended.AGT_CALL_ENDED
32754The Agent's device is restricted.AGT_DEVICE_RESTRICTED