All Message Types Organized by Class and Type
The table lists the message types by message class and by message type name. See the index for an alphabetical listing.
A "Solicit" message is a client message that makes a request of the server (Unified CCX). A "Solicited" message is a message Unified CCX sends to the client in response to a "solicit" message. For example: an OPEN_REQ and an OPEN_CONF message are a solicit and a solicited message respectively. An "unsolicited" message is one sent to the client that the client did not request; For example a SYSTEM_EVENT message.
|
Message class |
MessageTypeName |
Type ID # |
Sent by |
Solicit or Solicited |
Purpose |
|---|---|---|---|---|---|
|
Session messages |
OPEN_REQ |
3 |
Client |
Yes |
Requests the start of a communications session with Unified CCX. |
|
OPEN_CONF |
4 |
Unified CCX |
Yes |
Confirms to the client the starting of a session. | |
|
HEARTBEAT_REQ |
5 |
Client |
Yes |
Sends a HEARTBEAT_REQ message to Unified CCX whenever no messages have been sent for the heartbeat interval or sooner for the purpose of detecting and handling transmission failures. | |
|
HEARTBEAT_REQ |
6 |
Unified CCX |
Yes |
Confirms that the HEARTBEAT_REQ message has been received. | |
|
SYSTEM_EVENT |
31 |
Unified CCX |
No |
Indicates the Unified CCX server status or the agent’s device status changes. | |
|
CLOSE_REQ |
7 |
Client |
Yes |
Requests the termination of a session from a client. | |
|
CLOSE_CONF |
8 |
Unified CCX |
Yes |
Confirms the termination of a session. | |
|
Error messages |
FAILURE_CONF |
1 |
Unified CCX |
Yes |
Confirms a failure to process a client’s request |
|
FAILURE_EVENT |
2 |
Unified CCX |
No |
Notifies the client, without it having been requested, of a failure or an error. | |
|
Configuration messages |
CONFIG_REQUEST_KEY_EVENT |
230 |
Client |
Yes |
Requests the current configuration keys for various types of configuration data. |
|
CONFIG_KEY_EVENT |
231 |
Unified CCX |
Yes |
Provides the client with the requested configuration keys at the time of the client’s key request. | |
|
CONFIG_REQUEST_EVENT |
232 |
Client |
Yes |
Requests a complete set of configuration data. | |
|
CONFIG_BEGIN_EVENT |
233 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Signals the beginning of a consistent set of configuration data. | |
|
CONFIG_END_EVENT |
234 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Signals the end of a set of consistent configuration data. | |
|
CONFIG_TERMINAL_EVENT (Version 18 and later) |
276 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains terminal configuration data. | |
|
CONFIG_APPLICATION_EVENT |
235 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains application configuration data. | |
|
CONFIG_CSQ_EVENT |
236 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains CSQ configuration data. | |
|
CONFIG_AGENT_EVENT |
237 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains agent configuration data. | |
|
CONFIG_DEVICE_EVENT |
238 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains route point, agent extension, CTI port, or call control group configuration data | |
|
TEAM_CONFIG_REQ |
242 |
Client |
Yes |
Requests agent team configuration data. | |
|
TEAM_CONFIG_EVENT |
243 |
Unified CCX |
Yes (for initial upload) No (for updates) |
Contains team configuration data. | |
|
TEAM_CONFIG_CONF |
244 |
Unified CCX |
Yes |
Confirms the end of initial agent team configuration data. | |
|
Agent-State Messages |
AGENT_STATE_EVENT |
30 |
Unified CCX |
No |
Notifies clients that an agent state has changed. |
|
QUERY_AGENT_STATE_REQ |
36 |
Client |
Yes |
Queries the current state of an agent. | |
|
QUERY_AGENT_STATE _CONF |
37 |
Unified CCX |
Yes |
Provides the client with the agent state data that was requested. | |
|
SET_AGENT_STATE_REQ |
38 |
Client |
Yes |
Requests a change in the current state of an agent. | |
|
SET_AGENT_STATE_CONF |
39 |
Unified CCX |
Yes |
Confirms that Unified CCX has successfully processed the SET_AGENT_STATE_REQ message. | |
|
Call-Event Messages |
BEGIN_CALL_EVENT |
23 |
Unified CCX |
No |
Notifies the client of a new call and provides the initial call context data. |
|
END_CALL_EVENT |
24 |
Unified CCX |
No |
Notifies the client that the association between a call and its Unified CCX client is dissolved. | |
|
CALL_DATA_UPDATE_EVENT |
25 |
Unified CCX |
No |
Notifies the client of changes to a call’s context data and contains only the data that has changed. | |
|
CALL_DELIVERED_EVENT |
9 |
Unified CCX |
No |
Notifies the client that a call has arrived at a device. The call is delivered when the phone rings. | |
|
CALL_ESTABLISHED_EVENT |
10 |
Unified CCX |
No |
Notifies the client that a call has been answered and connected at a device. | |
|
CALL_HELD_EVENT |
11 |
Unified CCX |
No |
Notifies the client that a call has been placed on hold. | |
|
CALL_RETRIEVED_EVENT |
12 |
Unified CCX |
No |
Notifies the client that a call previously placed on hold has been resumed. | |
|
CALL_CLEARED_EVENT |
13 |
Unified CCX |
No |
Notifies the client that a call is terminated, normally when the last device disconnects from the call. | |
|
CALL_CONNECTION_CLEARED_EVENT |
14 |
Unified CCX |
No |
Notifies the client that a party dropped from a call. | |
|
CALL_ORIGINATED_EVENT |
15 |
Unified CCX |
No |
Notifies the client that a call is initiated at a monitored device. | |
|
CALL_FAILED_EVENT |
16 |
Unified CCX |
No |
Notifies the client that a call encountered an error. | |
|
CALL_CONFERENCED_EVENT |
17 |
Unified CCX |
No |
Notifies the client that a call has been joined with other(s) into a conference call. | |
|
CALL_TRANSFERRED_EVENT |
18 |
Unified CCX |
No |
Notifies the client that a call has been transferred. | |
|
CALL_DIVERTED_EVENT |
19 |
Unified CCX |
No |
Notifies the client that a call has been moved from one device to another. | |
|
CALL_SERVICE_INITIATED_EVENT |
20 |
Unified CCX |
No |
Notifies the client of an initiation of telecommunications service (dial tone) at a device. | |
|
CALL_QUEUED_EVENT |
21 |
Unified CCX |
No |
Notifies the client that a call has been placed in a queue pending the availability of an agent. | |
|
CALL_DEQUEUED_EVENT |
86 |
Unified CCX |
No |
Notifies the client that a call has been explicitly removed from a queue. | |
|
RTP_STARTED_EVENT (OPTIONAL) |
116 |
Unified CCX |
No |
Notifies the client that an RTP (Real-Time Protocol) voice media stream has been started. | |
|
RTP_STOPPED_EVENT (OPTIONAL) |
117 |
Unified CCX |
No |
Notifies the client that an RTP media stream has been stopped. | |
|
Client-Control (Call-Control) messages |
CONTROL_FAILURE_CONF |
35 |
Unified CCX |
Yes |
Confirms that the previously requested control-service function identified by the given invokeID was unsuccessful. |
|
ALTERNATE_CALL_REQ |
40 |
Client |
Yes |
Allows a client to request the combined action of placing an active call on hold and then either retrieving a previously held call or answering an alerting call at the same device. | |
|
ALTERNATE_CALL_CONF |
41 |
Unified CCX |
Yes |
Confirms the processing completion of the ALTERNATE_CALL_REQ message. | |
|
ANSWER_CALL_REQ |
42 |
Client |
Yes |
Allows a client to connect to an alerting call at the device which is alerting. | |
|
ANSWER_CALL_CONF |
43 |
Unified CCX |
Yes |
Confirms the processing completion of the ANSWER_CALL_REQ message. | |
|
CLEAR_CALL_REQ |
44 |
Client |
Yes |
Allows a client to release all devices from the specified call. | |
|
CLEAR_CALL_CONF |
45 |
Unified CCX |
Yes |
Confirms the processing completion of the CLEAR_CALL_REQ message. | |
|
CLEAR_CONNECTION_REQ |
46 |
Client |
Yes |
Allows a client to release a specific device connection from the specified call. | |
|
CLEAR_CONNECTION_CONF |
47 |
Unified CCX |
Yes |
Confirms the processing completion of the CLEAR_CONNECTION_REQ message. | |
|
CONFERENCE_CALL_REQ |
48 |
Client |
Yes |
Allows a client to complete a conference call by combining the consult call with the original call | |
|
CONFERENCE_CALL_CONF |
49 |
Unified CCX |
Yes |
Confirms the processing completion of the CONFERENCE_CALL_REQ message. | |
|
CONSULT_CALL_REQ |
50 |
Client |
Yes |
Allows the client to request the combined action of placing an active call on hold and then making a new call in order to make a conference call or to transfer the call. | |
|
CONSULT_CALL_CONF |
51 |
Unified CCX |
Yes |
Confirms the processing completion of the CONSULT_CALL_REQ message. | |
|
HOLD_CALL_REQ |
54 |
Client |
Yes |
Allows a client to place an existing call connection into the held state. | |
|
HOLD_CALL_CONF |
55 |
Unified CCX |
Yes |
Confirms the processing completion of the HOLD_CALL_REQ message. | |
|
MAKE_CALL_REQ |
56 |
Client |
Yes |
Allows a client to initiate a call. | |
|
MAKE_CALL_CONF |
57 |
Unified CCX |
Yes |
Confirms the processing completion of the MAKE_CALL_REQ message. | |
|
RECONNECT_CALL_REQ |
60 |
Client |
Yes |
Requests the combined action of clearing an active call and then retrieving an existing held call. | |
|
RECONNECT_CALL_CONF |
61 |
Unified CCX |
Yes |
Confirms the processing completion of the RECONNECT_CALL_REQ message. | |
|
RETRIEVE_CALL_REQ |
62 |
Client |
Yes |
Allows a client to retrieve an existing held call. | |
|
RETRIEVE_CALL_CONF |
63 |
Unified CCX |
Yes |
Confirms the processing completion of the RETRIEVE_CALL_REQ message. | |
|
TRANSFER_CALL_REQ |
64 |
Client |
Yes |
Allows a client to complete a transfer that was initiated by a consult. | |
|
TRANSFER_CALL_CONF |
65 |
Unified CCX |
Yes |
Confirms the processing completion of the TRANSFER_CALL_REQ message. | |
|
SEND_DTMF_SIGNAL_REQ |
91 |
Client |
Yes |
Allows a client to have the Unified CCX server transmit a sequence of DTMF tones on behalf of a call party. | |
|
SEND_DTMF_SIGNAL_CONF |
92 |
Unified CCX |
Yes |
Confirms the processing completion of the SEND_DTMF_SIGNAL_REQ message. | |
|
SET_CALL_DATA_REQ |
26 |
Client or Unified CCX |
Yes |
Requests the update of one or more call data. | |
|
SET_CALL_DATA_CONF |
27 |
Unified CCX |
Yes |
Confirms the processing completion of a previous SET_CALL_DATA_REQ message. | |
|
SUPERVISE_CALL_REQ |
124 |
Client |
Yes |
Requests (from a supervisor) a monitoring or barge-in operation. | |
|
SUPERVISE_CALL_CONF |
125 |
Unified CCX |
Yes |
Confirms the processing completion of a previous SUPERVISOR_CALL_REQ message. | |
|
SUPERVISOR_ASSIST_REQ |
118 |
Client |
Yes |
Requests (from an agent) supervisor assistance. | |
|
SUPERVISOR_ASSIST_CONF |
119 |
Unified CCX |
Yes |
Confirms the processing completion of a SUPERVISOR_ASSIST_REQ message. | |
|
SUPERVISOR_ASSIST_EVENT |
120 |
Unified CCX |
Yes |
Notifies the client that a supervisor assist request was sent by a Unified CCX client. | |
|
BAD_CALL_REQ |
139 |
Client |
Yes |
Allows a client to notify Unified CCX of the bad quality of a call. | |
|
BAD_CALL_CONF |
140 |
Unified CCX |
Yes |
Confirms the processing completion of the BAD_CALL_REQ message. | |
|
Miscellaneous messages |
QUERY_QUEUE_STATISTICS_REQ |
223 |
Client |
Yes |
Requests the current CSQ call handling statistics. |
|
QUERY_QUEUE_STATISTICS_CONF |
224 |
Unified CCX |
Yes |
Confirms the processing completion of a previous QUERY_AGENT_QUEUE_STATISTICS_REQ message. | |
|
QUERY_AGENT_QUEUE_STATISTICS_REQ |
239 |
Client |
Yes |
Requests the current agent call handling statistics. | |
|
QUERY_AGENT_QUEUE_STATISTICS_CONF |
240 |
Unified CCX |
Yes |
Confirms the processing completion of a QUERY_AGENT_QUEUE_STATISTICS_CONF message. | |
|
QUERY_DEVICE_INFO_REQ |
78 |
Client |
Yes |
Allows a client to retrieve general information about a specified device. | |
|
QUERY_DEVICE_INFO_CONF |
79 |
Unified CCX |
Yes |
Confirms the processing completion of a QUERY_DEVICE _INFO_REQ message. | |
|
QUERY_SUMMARY_STATISTICS_REQ |
225 |
Client |
Yes |
Requests system summary statistics for Unified CCX. To avoid impacting system performance, clients should not request statistics too frequently. | |
|
QUERY_SUMMARY_STATISTICS_CONF |
226 |
Unified CCX |
Yes |
Confirms the processing completion of a QUERY_SUMMARY_STATICS_REQ message. | |
|
SNAPSHOT_CALL_REQ |
82 |
Client |
Yes |
Allows a client to retrieve information on a specified call. | |
|
SNAPSHOT_CALL_CONF |
83 |
Unified CCX |
Yes |
Confirms the processing completion of a SNAPSHOT_CALL_REQ message. | |
|
SNAPSHOT_DEVICE_REQ |
84 |
Client |
Yes |
Allows a client to retrieve information on a specified device. | |
|
SNAPSHOT_DEVICE_CONF |
85 |
Unified CCX |
Yes |
Confirms the processing completion of a SNAPSHOT_DEVICE_REQ message. |