Fixed Part
|
MessageHeader
|
Standard
message header. MessageType = 3.
|
MHDR
|
8
|
InvokeID
|
An ID
for this request message, to be returned in the corresponding confirm message.
|
UINT
|
4
|
VersionNumber
|
The
version number of the interface requested by the CTI 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 time, the CTI Server resets the TCP connection and awaits
the establishment of a new session. This value is typically 4 times the
heartbeat interval used by the CTI client. If the CTI client does not use the
HEARTBEAT_REQ message, set this field to 0xFFFFFFFF.
|
UINT
|
4
|
PeripheralID
|
The Peripheral ID of the ACD whose events are of interest to the client. Required for Client Events service; otherwise, set
this field to 0xFFFFFFFF.
|
UINT
|
4
|
ServicesRequested
|
A
bitwise combination of the CTI Services listed in that the CTI client is
requesting.
|
UINT
|
4
|
CallMsgMask
|
A
bitwise combination of the Unsolicited Call Event Message Masks listed that the
CTI client wishes to receive.
|
UINT
|
4
|
AgentStateMask
|
A
bitwise combination of Agent State Masks that the CTI client wishes to receive.
|
UINT
|
4
|
ConfigMsgMask
|
A
bitwise combination of Configuration Event Masks that the CTI client wishes to
receive.
For bit
mask values, see the CONFIG_REQUEST_EVENT message ConfigInformation field.
|
UINT
|
4
|
Reserved1
|
Reserved
for future use; set to zero.
|
UINT
|
4
|
Reserved2
|
Reserved
for future use; set to zero.
|
UINT
|
4
|
Reserved3
|
Reserved
for future use; set to zero.
|
UINT
|
4
|
Floating Part
|
ClientID
(required)
|
The user
ID of the CTI client.
|
STRING
|
64
|
ClientPassword (required)
|
The
password of the user identified by ClientID. ClientID and Client Password are
optionally used to authenticate the CTI client making the session open request.
This field must be present even if authentication is not being used (it may be
of length zero).
|
UNSPEC
|
64
|
ClientSignature (optional)
|
A
character string appended to the Call Client History list when this CTI client
becomes associated with a call. If not provided, the ClientID is used.
|
STRING
|
64
|
AgentExtension
|
The
agent’s ACD teleset extension. For CLIENT EVENTS service, the CTI Client must
provide at least one of AgentExtension, AgentID, or AgentInstrument.
|
STRING
|
16
|
AgentID
|
The
agent’s ACD sign-in ID. For CLIENT EVENTS service, the CTI Client must provide
at least one of AgentExtension, AgentID, or AgentInstrument.
|
STRING
|
12
|
AgentInstrument
|
The
agent’s ACD instrument number. For CLIENT EVENTS service, the CTI Client must
provide at least one of AgentExtension, AgentID, or AgentInstrument.
|
STRING
|
64
|
ApplicationPathID
|
The ID
of an application path which contains configured MRD Peripheral combinations
for this Unified CCE-configured application instance.
|
INT
|
4
|
UniqueInstanceID
|
Optional field. Provided by the client to identify a unique instance of a client. If a
response for any request arrives from the OPC at the active CTI
Server and the original client request cannot be found using the
InvokeID, this field is used to find the requesting CTI Client
to send the response to.
|
STRING
|
64
|