Developer's Guide

3-11
CTI Server Message Reference Guide (Protocol Version 15) for Cisco Unified Contact Center Enterprise
Release 8.5(1)
Chapter 3 Messaging Conventions
Data Types
Data Types
Table 3-2 lists the data types that define fields within messages. All numeric data longer than one byte
are transmitted in order of most significant byte to least significant byte. This is the canonical network
byte order defined by TCP/IP standards.
The MHDR data type is a common message header that precedes all messages exchanged between a CTI
client and the CTI Server. Table 3-3 defines the message header format.
249 AGENT_GREETING_CONTROL_REQ Stop the greeting that is playing; disable or
enable the Agent Greeting feature for this
current login session.
250 AGENT_GREETING_CONTROL_CONF Confirmation of
AGENT_GREETING_CONTROL_REQ.
Table 3-1 Message Set (continued)
Number Message Type Purpose
Ta b l e 3 - 2 Da t a Ty p e s
Data Type Meaning Byte Size
CHAR Signed integer, -128 to 127. 1
UCHAR Unsigned integer, 0 to 255. 1
SHORT Signed integer, -32,768 to 32,767. 2
USHORT Unsigned integer, 0 to 65,535. 2
INT Signed Integer, -2,147,483,648 to 2,147,483,647. 4
UINT Unsigned Integer, 0 to 4,294,967,295. 4
BOOL Boolean (False = 0, True = 1). 2
STRING[n] ASCII string of length n. n
UNSPEC[n] Unspecified data occupying n consecutive bytes. n
TIME A date/time, expressed as the number of seconds since midnight
January 1, 1970 Coordinated Universal Time (UTC).
4
MHDR Message header (see Table 3-3). 8
NAMEDVAR A named call context variable (see Table 3-4). 3 … 251
NAMEDARRAY A named call context array element (see Table 3-5). 4 … 252
TASKID Task group identifier (see Table 3-6). 12
APPPATHID Application path identifier (see Table 3-7). 5
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).
UINT 4
MessageType The type of message. This value determines the format of
the remainder of the message.
UINT 4