OPEN_REQ
The OPEN_REQ and the OPEN_CONF messages depict the session initialization message flow. Once a TCP connection has been established, a client attempts to initialize a communications session by sending to Unified CCX an OPEN_REQ message, defined in this section.
Note | The ServiceRequested mask determines if a client is in bridge mode or in agent mode. These two modes are mutually exclusive. Do not set agent-mode fields for a bridge-mode client. See Two Client Modes for Connecting with Unified CCX, for an explanation of agent and bridge modes. |
The square bracketed subscript number ending the field names for the data in the floating part of the message descriptions is the FieldDataID for that field. For example AgentID[194] means that 194 is the FieldDataID for the AgentID field.
|
Fixed part Field name |
Value |
Data type |
Byte size |
|---|---|---|---|
|
InvokeID |
A unique ID generated by the CTI client for each request message. This ID is returned in the corresponding confirmation message. |
UINT |
4 |
|
VersionNumber |
The version number of the interface requested by the client. This defines the version of all messages in the message set. |
UINT |
4 |
|
IdleTimeout |
The session idle timer, expressed in seconds. If the session is idle (no messages received) for this length of time, Unified CCX resets the TCP connection and awaits the establishment of a new session. This value must be at least 2 times the heartbeat interval but less than 120 seconds. |
UINT |
4 |
|
reserved |
Set this field to zero. |
UINT |
4 |
|
ServicesRequested |
A bitwise combination of the CTI Services listed in Table 1 that the client is to receive. |
UINT |
4 |
|
CallMsgMask |
A bitwise combination of the Unsolicited Call Event Message Masks listed in Table 1 that the client is to receive. |
UINT |
4 |
|
AgentStateMask |
A bitwise combination of Agent State Masks listed in Table 1 that the client is to receive. |
UINT |
4 |
|
ConfigMsgMask |
A bitwise combination of the Configuration Event masks listed in Table 1 that the client is to receive. |
UINT |
4 |
|
reserved |
Set this field to zero. |
UINT |
4 |
|
reserved |
Set this field to zero. |
UINT |
4 |
|
reserved |
Set this field to zero. |
UINT |
4 |
|
Floating part Field name |
Value |
Data type |
Maximum size |
|---|---|---|---|
|
ClientID (required)1
|
The user ID of the client. |
STRING |
64 |
|
ClientPassword[2] (required) |
The password of the user identified by clientID. ClientID and ClientPassword are optionally used to authenticate the client making the session open request. This field must be present even if authentication is not being used (they can be of zero length). |
UNSPEC |
64 |
|
ClientSignature[3] (optional) |
A character string that can be used to identify a client. |
STRING |
64 |
|
AgentExtension[4] (required for Agent mode) |
The agent’s ACD IP phone extension. For Agent mode, at least one of AgentExtension, AgentID, or AgentInstrument must be provided by the client. |
STRING |
16 |
|
AgentInstrument[6] (required for Agent mode) |
The agent’s IP phone number. For Agent mode, at least one of AgentExtension, AgentID, or AgentInstrument must be provided by the client. |
STRING |
64 |
|
AgentID[194] (required for Agent mode) |
The agent’s Unified CCX login. |
STRING |
129 |
Note | Unified CCX does not use the Client ID and Client Password (they can be of zero length). Even though the fields are required, Unified CCX Computer Telephony Integration ignores them. |