Cisco Cisco Computer Telephony Integration Option 8.5 Developer's Guide
5-171
CTI Server Message Reference Guide (Protocol Version 9) Release 7.0(0)
Chapter 5 Application Level Interfaces
Server Service
Server Service
A server application specifies the new service type CTI_SERVICE_SERVER to identify itself as server
application. The server application then registers each service that it wishes to provide by sending a new
message, REGISTER_SERVICE_REQ, to the CTI Server. When a CTI client application requests a
service that is provided by a server application, such as CallRecording, the CTIServer selects a registered
server application and forwards the client request to the server application. If no server is registered for
the desired service the client request is refused with an E_CTI_NO_SERVER_FOR_REQUEST error.
application. The server application then registers each service that it wishes to provide by sending a new
message, REGISTER_SERVICE_REQ, to the CTI Server. When a CTI client application requests a
service that is provided by a server application, such as CallRecording, the CTIServer selects a registered
server application and forwards the client request to the server application. If no server is registered for
the desired service the client request is refused with an E_CTI_NO_SERVER_FOR_REQUEST error.
The server service optionally allows multiple server applications to supply the same service. The
ServerMode registration parameter determines how a server is selected to handle a given request. All
server applications that wish to provide the same service must use the same ServerMode:
ServerMode registration parameter determines how a server is selected to handle a given request. All
server applications that wish to provide the same service must use the same ServerMode:
•
Exclusive. The first server application to register the service is the only one to serve requests. All
other requests to register a server application for that service are refused with an
E_CTI_NO_SERVER_FOR_REQUEST.
other requests to register a server application for that service are refused with an
E_CTI_NO_SERVER_FOR_REQUEST.
•
Round-Robin. Multiple server applications may register the service. The server application that has
been waiting the longest for a request of this service type is chosen to service the request.
been waiting the longest for a request of this service type is chosen to service the request.
•
Parallel. Multiple server applications may register the service. Every request is sent to all registered
servers concurrently. Every server response is forwarded back to the requesting client.
servers concurrently. Every server response is forwarded back to the requesting client.
REGISTER_SERVICE_REQ
Initially, the only service that server applications may provide is call recording by registering the
“Cisco:CallRecording” service using a REGISTER_SERVICE_REQ message, defined in
“Cisco:CallRecording” service using a REGISTER_SERVICE_REQ message, defined in
:
Table 5-136
REGISTER_SERVICE_REQ Message Format
Fixed Part
Field Name
Field Name
Value
Data Type Byte Size
MessageHeader
Standard message header.
MessageType = 143.
MessageType = 143.
MHDR
8
InvokeID
An ID for this request message that
will be returned in the
corresponding confirm message.
will be returned in the
corresponding confirm message.
UINT
4
ServerMode
The method the CTI Server is to use
to select among multiple server
applications that register to provide
this service. All servers must
specify the same ServerMode, one
of the following values:
to select among multiple server
applications that register to provide
this service. All servers must
specify the same ServerMode, one
of the following values:
0: Exclusive;
1: Round-Robin;
2: Parallel.
USHORT
2
Floating Part
Field Name
Field Name
Value
Data Type Max. Size