Cisco Cisco Computer Telephony Integration Option 10.5 Reference Guide
5-104
CTI Server Message Reference Guide (Protocol Version 14) for Cisco Unified ICM/Contact Center Enterprise & Hosted
Release 8.0(1)
Chapter 5 Application Level Interfaces
Miscellaneous Service
The CTIServer forwards the START_RECORDING_REQ message to one or more servers applications
that have registered the “Cisco:CallRecording” service. The recording server will return the
START_RECORDING_CONF message when call recording has been activated. Upon receipt of the
START_RECORDING_CONF, the CTI Server forwards the response to the requesting CTI Client:
that have registered the “Cisco:CallRecording” service. The recording server will return the
START_RECORDING_CONF message when call recording has been activated. Upon receipt of the
START_RECORDING_CONF, the CTI Server forwards the response to the requesting CTI Client:
AgentExtension
The agent’s ACD teleset extension. For requesting clients
with ALL EVENTS or PERIPHERAL MONITOR service,
at least one of AgentExtension, AgentID, or
AgentInstrument must be provided.
with ALL EVENTS or PERIPHERAL MONITOR service,
at least one of AgentExtension, AgentID, or
AgentInstrument must be provided.
STRING
16
AgentID
The agent’s ACD login ID. For requesting clients with ALL
EVENTS or PERIPHERAL MONITOR service, at least
one of AgentExtension, AgentID, or AgentInstrument must
be provided.
EVENTS or PERIPHERAL MONITOR service, at least
one of AgentExtension, AgentID, or AgentInstrument must
be provided.
STRING
12
AgentInstrument
The agent’s ACD instrument number. For requesting
clients with ALL EVENTS or PERIPHERAL MONITOR
service, at least one of AgentExtension, AgentID, or
AgentInstrument must be provided.
clients with ALL EVENTS or PERIPHERAL MONITOR
service, at least one of AgentExtension, AgentID, or
AgentInstrument must be provided.
STRING
64
ClientAddressIPV6
(not supported by
Unified ICM)
(not supported by
Unified ICM)
The IP Address of the CTI client. Where supported this
may replace ClientAddress; one but not both must be
present.
may replace ClientAddress; one but not both must be
present.
STRING
16
Maximum message size (including header)
280
Table 5-80
START_RECORDING_REQ Message Format (continued)
Table 5-81
START_RECORDING _CONF Message Format
Fixed Part
Field Name
Value
Data Type
Byte
Size
Size
MessageHeader
Standard message header. MessageType = 148.
MHDR
8
InvokeID
Set to the same value as the InvokeID from the
corresponding request message.
corresponding request message.
UINT
4
SessionID
A value that uniquely identifies the server application
session providing the call recording service that should be
supplied by the client in the STOP_RECORDING_REQ
message that terminates this recording. Server applications
should set this field to 0xffffffff if the subsequent STOP_
RECORDING_REQ should be sent only to that server, or set
to zero if the STOP_RECORDING_REQ may be sent to any
registered server.
session providing the call recording service that should be
supplied by the client in the STOP_RECORDING_REQ
message that terminates this recording. Server applications
should set this field to 0xffffffff if the subsequent STOP_
RECORDING_REQ should be sent only to that server, or set
to zero if the STOP_RECORDING_REQ may be sent to any
registered server.
UINT
4
ServerData
An ID or other server value associated with this call
recording that should be supplied by the client in the
STOP_RECORDING_REQ message that terminates this
recording.
recording that should be supplied by the client in the
STOP_RECORDING_REQ message that terminates this
recording.
UINT
4
Floating Part
Field Name
Value
Data Type
Max.
Size
Size