Cisco Cisco Computer Telephony Integration OS 8.5 Developer's Guide
3-9
CTI Server Message Reference Guide (Protocol Version 9) Release 7.0(0)
Chapter 3 Messaging Conventions
Data Types
The MHDR data type is a common message header that precedes all messages exchanged between a CTI
client and the CTI Server.
client and the CTI Server.
defines the message header format.
Table 3-3
Message Header (MHDR) Format
Field Name
Value
Data Type Byte Size
MessageLength
The length of the message in bytes,
excluding the size of the message
header (the first 8 bytes).
excluding the size of the message
header (the first 8 bytes).
UINT
4
MessageType
The type of message. This value
determines the format of the
remainder of the message.
determines the format of the
remainder of the message.
UINT
4
The NAMEDVAR data type is a call context variable that has been defined in the ICM database
Expanded_Call_Variable_Table. This variable length data type may appear in the floating part of a
message and has the format shown in
Expanded_Call_Variable_Table. This variable length data type may appear in the floating part of a
message and has the format shown in
:
BOOL
Boolean (False = 0, True = 1)
2
STRING[n]
ASCII string of length n
n
UNSPEC[n]
Unspecified data occupying n
consecutive bytes
consecutive bytes
n
TIME
A date/time, expressed as the number of
seconds since midnight January 1, 1970
Coordinated Universal Time (UTC).
seconds since midnight January 1, 1970
Coordinated Universal Time (UTC).
4
MHDR
Message header (see
8
NAMEDVAR
A named call context variable (see
)
3 … 251
NAMEDARRAY
A named call context array element (see
)
4 … 252
TASKID
).
12
APPPATHID
Application path identifier (see
).
5
Table 3-4
Named Call Context Variable (NAMEDVAR) Format
Subfield
Value
Data Type Max. Size
Tag
NAMED_VARIABLE_TAG (= 82).
The floating field tag that indicates
that the following data is a named
call context variable.
The floating field tag that indicates
that the following data is a named
call context variable.
UCHAR
1
FieldLength
The total length of the
VariableName and Variable Value
fields, including the
null-termination bytes. The value of
this field may range from 3 to 251.
VariableName and Variable Value
fields, including the
null-termination bytes. The value of
this field may range from 3 to 251.
UCHAR
1
Table 3-2
Data Types (continued)
Data Type
Meaning
Byte Size