RBR-ITG-Unify OpenScape Voice Integration Guide V1.4

Unify OpenScape Voice
Integration Guide
RBRITG1001 V1.4
The copyright in this work is vested in Red Box Recorders Limited and the document is issued in confidence for the purpose only for which it is supplied. It
must not be reproduced in whole or in part or used for tendering or manufacturing purposes except under an agreement or with the consent of Red Box
Recorders Limited and then only on the condition that this notice is included in any such reproduction. No information as to the contents or subject matter
of this document or any part thereof arising directly or indirectly there from shall be given orally or in writing or communicated in any matter whatsoever to
any third party being an individual firm or company or any employee thereof without the prior consent in writing of Red Box Recorders Limited. Registered
office: Bradmore Business Park, Loughborough Road, Bradmore, Nottingham, NG11 6QA. Registered in England No.4186453.
www.redboxvoice.com
T +44(0)115 937 7100 E info@redboxvoice.com
© Copyright Red Box Recorders Limited 2020. All rights reserved.
Integration Guide
Contents
Introduction........................................................................................................................................4
Unify OpenScape Voice – Call Recording Overview..........................................................................4
SIP Call Flow....................................................................................................................................5
Resiliency ........................................................................................................................................6
Specifications & Requirements ...........................................................................................................7
Tested Configuration.......................................................................................................................7
Call Recording Capabilities ..............................................................................................................7
Call Metadata..............................................................................................................................7
Integration Dependent Features .................................................................................................8
Prerequisites ...................................................................................................................................9
Recorder/Licensing .....................................................................................................................9
OpenScape Voice Switch .............................................................................................................9
OpenScape Contact Center SDK Runtime .................................................................................. 10
Networking Considerations ........................................................................................................... 11
Codec Support .............................................................................................................................. 12
Security......................................................................................................................................... 13
Secure SIP ................................................................................................................................. 13
Secure RTP ................................................................................................................................ 14
Registration .................................................................................................................................. 15
OpenScape Voice Layer 3 Failover ................................................................................................. 15
OpenScape Contact Center ........................................................................................................... 16
Configuration.................................................................................................................................... 17
Configure RTP Collector ................................................................................................................ 17
Configure SIP RAM ........................................................................................................................ 19
CTI Server Config........................................................................................................................... 22
Configure Devices ......................................................................................................................... 25
Add Devices .............................................................................................................................. 25
Remove Devices ........................................................................................................................ 25
Enable/Disable Devices for Recording ....................................................................................... 25
www.redboxvoice.com
© Copyright Red Box Recorders Limited 2020 Page 2 of 28
Integration Guide
Log Files ........................................................................................................................................ 26

RTP Collector............................................................................................................................. 26
SIP RAM .................................................................................................................................... 26
OpenScape CTI Server Log ......................................................................................................... 26
CTI Only PP Log ......................................................................................................................... 27
OpenScape Voice – Specific Recorder Alarms .................................................................................... 28
www.redboxvoice.com
Integration Guide
Introduction
This guide provides a technical overview of the Red Box call recording integration for Unify
OpenScape Voice (OSV), and provides install/config details. The guide is designed for system
administrators, as well as installation and support engineers.
Note that other Unify telephony systems such as OpenScape Business and OpenScape 4000 require
different Red Box integration drivers – this guide is for OpenScape Voice only.
The OpenScape Voice integration builds on the SIP Active integration by using CSTA to provide CTI
overlay. This guide provides information specific to OpenScape Voice with general SIP Active details
as needed.
Note that this version of the OpenScape Voice Integration Guide (Version 1.4)
provides config information specific to Quantify 5A and above. For Quantify 4C
and below please refer to Version 1.2.
Unify OpenScape Voice – Call Recording Overview

Red Box provides an active call recording integration for OSV SIP phones. The recorder integrates
with the OSV switch using CSTA for metadata and SIP media. Call metadata is delivered to the
recorder from the OSV Web Service using the CSTA protocol. The media RTP stream is established
using SIP between the OSV Media Server and the Red Box recorder server.
When OpenScape Contact Centre is required as part of the OpenScape Voice and Red Box
integration, the OpenScape Contact Center Service connects to the recorder allowing contact centre
specific call metadata to be captured (see “Call Metadata” on page 7 for more details). Contact
center call audio is still recorded via SIP connection between the OpenScape Voice Media Server
and recorder.
Sample recording call flow for external PSTN and internal interactions - with Primary / Secondary Resiliency.
www.redboxvoice.com
Integration Guide
The Red Box OpenScape Voice integration uses a SIP extension (OSV Subscriber with Silent
Monitoring Supervisor feature enabled), configured within the OpenScape Voice Common
Management Platform (CMP) to silently monitor other extensions (OSV Subscribers with Silent
Monitoring Agent feature enabled). The list of OSV Subscribers to be recorded is configured on the
Red Box recorder server so that they are actively monitored and recorded on call activity. The
Subscriber details are populated in the Quantify Recording Device list on the recorder (Configuration
> Management > Recording) where they can be set to Recording Enabled or Disabled as required.
SIP Call Flow

The process for call capture for SIP has been enhanced to allow capture of up to 1000 concurrent
stereo calls. The RTP Collector process was introduced to allow multi-NIC capture of audio data.
1. SIP message exchange between the OSV Media Server and Red
Box Recorder.
2. SIP RAM requests RTP Collector session.
3. RTP Collector provides endpoint for audio delivery.
4. Audio sent from OSV Media Server to RTP Collector for recording.
www.redboxvoice.com
Integration Guide
Resiliency
The SIP integration allows for Primary/Secondary resiliency (Parallel mode).
Two recorders can be configured as a Primary/Secondary Parallel Pair to provide resilience. In this
configuration there are two identical recorders each recording the same calls and having the same
configuration, except one is configured as a Parallel Primary and the other as a Parallel Secondary. In
the event of a critical error (failure) of the Primary recorder, the Secondary recorder will trigger into
an active state and continue to record without loss of recordings. This is described further in the
“Server Options & Topologies” Quick Question topic.
www.redboxvoice.com
Integration Guide
Specifications & Requirements

Tested Configuration
Red Box have conducted full integration testing of OSV V9 R3.34.5 with Quantify 5A using generic SIP
softphones and the following physical Unify SIP phones:
• OpenScape Desk Phone CP200

• OpenScape Desk Phone CP600
• OpenStage 15G
• OpenStage 40G
• OpenStage 60G
For the latest information on software versions and compatibility testing, please refer to the latest
release notes available from the relevant software release folder.
Call Recording Capabilities

Call Metadata
The following searchable call metadata will be captured for each recorded call.
• Call Start Time
• Call End Time
• Call Duration
• Call Direction
• Caller Number
• Called Number
• Extension
• Other Party
• Agent ID*
• Agent Name*
*Note that agent information is not included within the CSTA, therefore must be configured to
connect directly to OpenScape Contact Center (OSCC) to acquire agent information.
www.redboxvoice.com
Integration Guide
Integration Dependent Features
Recording
Supported Media Voice
Mono/Stereo Recording Mono
Record Internal Calls Y
Record Encrypted Calls* Y
Codecs See “Codec Support” on page 12
Single Call Through Hold Y
Device Enablement * Auto Enable
Silence Suppression * Y
Discard Call on Silence * N
Recording Alarms Y
Recorder
Recommended Resiliency Model Parallel
Additional Supported Resiliency Model N
Hosted (Multi-Tenancy) Y
Quantify
Linked Calls Y
Blacklisting Y
Daily System Check N
Call Brokers
Export Broker Y
Bloomberg Broker N
Other Features
DTMF Detection (PCI Suppression) Y
Replay to Phone* Y
Requires CTI Feed to Record Y
* Just to clarify a few features:
Record Encrypted Calls: Not compatible with NAS Compression.
Device Enablement: Indicates if new devices are automatically enabled or disabled for recording.
Configurable – default is automatically enabled.
Silence Suppression: Recording of silence is suppressed. Only supported for the G.711 Codec. Not supported
for SRTP.
Discard Call on Silence: Discard recording the entire call if the call consists completely of silence.
Replay to Phone: Replay call audio through a phone rather than a PC. Calls recorded using certain audio
codecs or SRTP cannot currently be replayed using Replay to Phone.
Due to the nature of silent monitoring, all calls are recorded in mono. There is no separation of local
and remote speech available with this integration.
www.redboxvoice.com
Integration Guide
Prerequisites
Recorder/Licensing
The Red Box call recording integration for Unify OpenScape Voice is supported in Quantify Version 5A
or later.
The recorder must be licensed (PP License) for Active Recording, with the OpenScape Voice option.
There are no known compatibility limitations for this integration with other recording types.
However, co-locating the recorder with other SIP integrations may invoke conflicting SIP port usage –
you will need to consider this when designing the solution.
OpenScape Voice Switch

This Integration Guide doesn’t provide details on general configuration of the customer’s OSV switch.
However, there are a few configuration requirements needed in order to integrate with the Red Box
Recorder.
The OpenScape Voice switch needs to be configured with an additional Subscriber in the CMP that
the recorder server will use to acquire call audio. Each recorder that is connected to the OSV Switch
requires its own Subscriber configuration – each Subscriber must be configured with the Silent
Monitoring Supervisor feature set to Active. The Subscriber(s) used by the recorder(s) must be
configured to use the same SIP transport as the recorder side.
Any Subscribers that are required to be “visible” to the recorder(s) must be configured with the Silent
Monitor Agent feature set to Active. As stated previously, each device to be recorded must also be
enabled for recording in the Quantify Recording Devices list (Configuration > Management >
Recording).
www.redboxvoice.com
Integration Guide
Unify Common Management Platform (CMP) – Example Subscriber Configuration
A conference resource is used by the Silent Monitoring Supervisor Subscriber for each concurrent call
being recorded. The customer will need to ensure that sufficient conference resources are available
within the OSV switch to support the maximum expected concurrent call recording activities.
The total number of concurrent recording channels is limited by the number of conference channels
available on the OSV Media Server. When resilient recording is being used, each recorder will
“consume” these channels.
Note: The provisioning of the OSV Media Server should allow for the channels consumed by the
recorder, as well as channels expected to be used for telephony – this should be calculated on a per
recorder basis.
OpenScape Contact Center SDK Runtime

In order to integrate OpenScape Contact Center with the Red Box recorder, you need to install the
OpenScape Contact Center SDK Runtime on the recorder – this is can only be obtained from Unify.
The version of OpenScape Contact Center SDK Runtime must match the version of OpenScape
Contact Center that is installed on the customer’s system.
www.redboxvoice.com
Integration Guide
Networking Considerations
Sufficient network bandwidth between the Red Box recorder and OSV Switch is required to support
the necessary concurrent call recordings. This can be calculated using the following formula:
bandwidth = bitrate x channels
Where bitrate is the codec bitrate and channels is the number of concurrent channels to be recorded
(times one for mono, or two for stereo).
The following statements are true for a 1000 BASE-T network. Throughput for a 100 BASE-TX
network will be significantly less. Due to the small size and high frequency of RTP packets, it’s not
possible to utilise the full potential bandwidth before the network becomes a bottleneck and packet
loss ensues.
• Once the required bandwidth breaches the 70 Mbps threshold, we recommend that a
dedicated network adapter is added for media traffic. This will avoid the availability of
services such as Quantify applications, being affected by high recorder load.
• A further network adapter should be added for each additional 100 Mbps of required
network bandwidth.
See “Configure RTP Collector” on page 17 for details on specifying which network adapters to utilise
for media traffic.
Where the OSV Switch and Red Box recorder reside on separate network subnets, the Switch must
be able to route to the recorder, and similarly the recorder must also be able to route to the Switch.
The following ports must be open on any firewall between the Red Box recorder and the OSV Switch:
Port Protocol Purpose
1040 TCP CSTA communication between the Red Box recorder and OSV
Web Service(s).
5060 TCP + UDP SIP communication between OSV Media Server and Red Box
recorder.
5061 TCP + UDP Secure SIP communication between OSV Media Server and Red
Box recorder.
25000 - 65000 UDP RTP and RTCP communication between OSV Media Server and
Red Box recorder.
Note that these are default ports – you can change these as detailed in “Configuration” on page 17.
Also note that the ports detailed above are specifically for this integration. Other ports are required
for generic Red Box Recorder functionality and are detailed in the appropriate documentation.
www.redboxvoice.com
Integration Guide
Codec Support
A wide range of codecs are supported. See “Configure SIP RAM” on page 19 for details on setting
codec priority.
The table below shows the currently supported codecs and some key attributes. Attention should be
paid to the bitrate and Mean Opinion Score (MOS). The bitrate indicates how much network
bandwidth and storage will be required per mono RTP stream (double this figure for stereo). The
MOS indicates the quality of the resulting audio. As a general rule:
higher compression = lower bitrate = lower MOS
Codec Algorithm Bitrate (Kbps) Sampling Frequency Audio Bandwidth MOS

(Hz)
G.711 PCM 64 8000 300 Hz – 3400 Hz 4.10
G.722 SB-ADPCM 48, 56, 64 16000 50 Hz – 7 kHz 4.10
G.722.1 MLT 24, 32 16000 50 Hz – 7 kHz 4.00
G.723.1 ACELP 5.3 8000 3.62
MP-MLQ 6.3 8000 3.90
G.726 ADPCM 16 8000 200 Hz – 3400 Hz
24 8000 3.50
32 8000 4.10
40 8000
G.728 LD-CELP 16 8000 3.61
G.729 CS-ACELP 8 8000 140 Hz – 3600 Hz 3.92
G.729A CS-ACELP 8 8000 140 Hz – 3600 Hz 3.70
AMR ACELP Variable (4.75 – 12.2) 8000 3.50 – 4.10
AMR-WB ACELP Variable (6.6 – 23.85) 16000
IMA ADPCM 32 8000
ADPCM 44.1 11025
64 16000
88.2 22050
GSM RPE-LTP 13 8000 3.60
06.10
Opus LPC Variable (6 – 510) 8000 4 kHz
12000 6 kHz
16000 8 kHz
24000 12 kHz
48000 20 kHz
www.redboxvoice.com
Integration Guide
Security
To ensure security of data on-the-wire, Red Box supports Secure SIP and Secure RTP (SRTP). SRTP
keys are negotiated in the SDP using SDES (mechanism of negotiating security keys). We recommend
using Secure SIP in conjunction with SRTP to keep the SRTP keys from being compromised.
Secure SIP
To provide a secure SIP interface, TLS and DTLS are supported as SIP transports. See “Configure SIP
RAM” on page 19 for more information on how to set the enabled SIP transports. The following
protocol versions are supported. Previous insecure protocol versions are not supported.
• TLS 1.3
• TLS 1.2
• DTLS 1.2
SIPS URIs are supported, but not required with either TLS or DTLS transports.
The cipher suites (listed below) are supported in order of preference. On first start with either TLS or
DTLS transports enabled, the Diffie-Hellman (DH) parameters are automatically generated. This only
happens once on first start but takes several minutes to complete. The OpenSSL command line
window must not be closed during this operation.
1. TLS_AES_256_GCM_SHA384
2. TLS_CHACHA20_POLY1305_SHA256
3. TLS_AES_128_GCM_SHA256
4. TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
5. TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
6. TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
7. TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
8. TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
9. TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
10. TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
11. TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
12. TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
13. TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
14. TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
15. TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
16. TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
17. TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
18. TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
19. TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
20. TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
21. TLS_DHE_RSA_WITH_AES_256_CBC_SHA
www.redboxvoice.com
Integration Guide
22. TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
23. TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
24. TLS_DHE_RSA_WITH_AES_128_CBC_SHA
25. TLS_RSA_WITH_AES_256_GCM_SHA384
26. TLS_RSA_WITH_AES_128_GCM_SHA256
27. TLS_RSA_WITH_AES_256_CBC_SHA256
28. TLS_RSA_WITH_AES_128_CBC_SHA256
29. TLS_RSA_WITH_AES_256_CBC_SHA
30. TLS_RSA_WITH_AES_128_CBC_SHA
Secure RTP
Secure RTP operates in three modes:
• Best Effort (default): If an SDP offer with a supported crypto attribute is received, Red Box
will respond with a crypto attribute in its SDP answer and SRTP will be used for the media
session. The SDP media protocol may be either RTP/AVP or RTP/SAVP.
• Mandatory: If an SDP offer with media protocol RTP/SAVP and a supported crypto attribute
is received, Red Box will respond with RTP/SAVP and a crypto attribute and SRTP will be used
for the media session. Otherwise, the session will be rejected with a SIP 488 response.
• Disabled: If an SDP offer with media protocol RTP/AVP is received, Red Box will respond with
RTP/AVP and RTP will be used for the media session. Otherwise, the session will be rejected
with a SIP 488 response. See “Configure SIP RAM” on page 19 for more information on how
to set the SRTP mode.
The following cipher suites are supported in order of preference.
• AEAD_AES_256_GCM (RFC 7714)
• AEAD_AES_128_GCM (RFC 7714)
• AES_256_CM_HMAC_SHA1_80 (RFC 6188)
• AES_CM_128_HMAC_SHA1_80 (RFC 3711)
• AES_CM_128_HMAC_SHA1_32 (RFC 3711)
SRTP data is stored in its encrypted form. This is for performance reasons as cryptographic
operations i.e. decryption, are slow. The SRTP keys are stored alongside the SRTP data. If it is
required that this data remain secure at rest, the Media Encryption Red Box recorder feature should
be enabled. This will encrypt the SRTP keys so that they remain uncompromised. SRTP data will not
be double encrypted.
www.redboxvoice.com
Integration Guide
Because SRTP data is stored in its encrypted form, it is incompatible with NAS Compression. NAS
Compression should not be used in conjunction with SRTP. Doing so will result in unrecoverable loss
of data.
Session Parameters
The following SDES session parameters from RFC 4568 are supported. The far end may use them to
override the session defaults. These overrides will be honoured by the recorder.
• UNENCRYPTED_SRTP: SRTP will not be encrypted. This is useful where regulations do not
permit encryption, but data integrity is still desired.
• UNAUTHENTICATED_SRTP: SRTP will not be authenticated. This is not recommended.
• UNENCRYPTED_SRTCP: SRTCP will be authenticated, but not encrypted. This is useful where
regulations do not permit encryption, but data integrity is still desired.
Secure RTCP
If SRTP is in use, Red Box will also expect any RTCP to be secure (SRTCP). Receiver Reports
transmitted will be secured using SRTCP and the negotiated keys.
Registration
Registration is a mechanism of associating a user’s Address of Record (AoR) (User URI/ID) with one or
more devices (e.g. phone, mobile phone). A few things to consider are:
• Some integrations require the Red Box Recorder to register with a SIP registrar. For example,
the recorder registers as a user that can be conferenced into a call as a silent monitor, thus
establishing a call recording session.
• In situations where user authentication is required, digest authentication is supported.
• If the route from the recorder to the registrar can traverse one or more SIP proxies, SIP
outbound (RFC 5626) is supported.
See the “Configure SIP RAM” on page 19 for information on how to configure registration.
OpenScape Voice Layer 3 Failover

Red Box supports OpenScape Voice Layer 3 failover - this is where the OpenScape Voice has been
configured with a secondary node (often called a switch) that is usually geographically separated on a
separate IP subnet. If the primary node fails, the secondary node will take over maintaining a
resilient telephony system. Red Box fit into this solution design by connecting to both nodes in the
system.
The primary focus of Unify’s OpenScape Voice failover strategy is to preserve existing calls and
maintain the capability to make new ones. At present, this does not include conferencing additional
participants into existing calls. The silent monitoring method of voice recording is essentially a
www.redboxvoice.com
Integration Guide
conference. This means that an existing call cannot be recorded once it is modified in such a way that
requires Red Box to enact a new silent monitor. This includes the following features:
• Conference
• Hold & Retrieve
• Transfer
An affected recording will manifest as an overlay call with either no underlying audio call or an
underlying audio call containing an automated message. New calls are not affected by this limitation.
OpenScape Contact Center

Where OpenScape Contact Center (OSCC) is in use and recording of agent information is desired, Red
Box supports acquisition of agent information from OpenScape Contact Center. The following agent
information is available:
• Agent ID
• Agent Name
For information of how to configure OSCC, see “CTI Server Config” on page 22.
www.redboxvoice.com
Integration Guide
Configuration
This section contains configuration guidelines to enable call recording for OpenScape Voice following
a “standard” Red Box recorder installation licensed for Active Recording with the OpenScape Voice
option.
1. Configure the recorder to register as the Silent Monitoring Supervisor – this is the Subscriber
you registered on the OSV using the Common Management Platform (see “OpenScape Voice
Switch” on page 9).
2. If OpenScape Contact Center is required – run the OpenScape Contact Center SDK Runtime
(see “OpenScape Contact Center SDK Runtime” on page 10).
3. Configure the RTP Collector – see “Configure RTP Collector” on page 17 .
4. Configure the SIP RAM – see “Configure SIP RAM” on page 19.
5. Configure the recorder to connect to the OpenScape Voice CSTA Web Service(s) – see “CTI
Server Config” on page 22.
6. Restart the recorder to apply the changes.
7. Configure devices to record – see “Configure Devices” on page 25.
Configure RTP Collector

The RTP Collector works in sync with the SIP RAM. The SIP RAM manages the SIP dialog and the RTP
Collector owns the RTP session. The RTP Collector configuration is specified in
C:\RAM\RTPCollector\RTPCollector.ini and is automatically generated with default values on first
start. An example is shown below:
[RBRLogging]
LogLevel=WARNING
[MediaPorts]
Min=25000
Max=65000
[NetworkAdapters]
Count=2
Adapter.0={55D59A72-47FE-49E8-AC77-33C07E550ECA}
Adapter.1={3EEF4061-C8E4-46FC-9DA7-E61766C04B01}
[{55D59A72-47FE-49E8-AC77-33C07E550ECA}]
IPv4Address=169.254.253.20
Use=0
[{3EEF4061-C8E4-46FC-9DA7-E61766C04B01}]
IPv4Address=10.0.2.15
Use=1
[Suppression]
StartSequence=*123
StopSequence=#123
www.redboxvoice.com
Integration Guide
[RBRLogging]LogLevel
Sets the log level of the application – increase this to gain insight during debugging. Default is
WARNING. Possible values, in increasing verbosity order, are:
• ERROR
• PRINT
• WARNING
• MESSAGE
• INFO
[NetworkAdapters]
The RTP Collector discovers all available network adapters on start-up – they’re listed by their
Windows device name (GUID). The adapter’s IPv4 address is displayed for ease of identification. By
default, all adapters are enabled for media traffic. Enable or disable adapters as needed:
Use=0 (don’t use) Use=1 (use)
For high load systems, we recommend that a network adapter is reserved for Quantify and other
services – see “Networking Considerations” on page 11.
[MediaPorts]Min
The beginning of the media port range. Default is 25000.
[MediaPorts]Max
The end of the media port range. Default is 65000.
[Suppression]StartSequence
The sequence of DTMF digits required to start audio suppression on the current call. Default is empty
(disables the feature).
[Suppression]StopSequence
The sequence of DTMF digits required to stop audio suppression on the current call. Default is empty
(disables the feature). Should not be the same as the start sequence for obvious reasons.
www.redboxvoice.com
Integration Guide
Configure SIP RAM

The SIP RAM configuration is specified in C:\RAM\RAM.ini. An example is shown below.
[SIPRAMSettings]
Protocol=any
SIPPort=5060
MaxConcurrentCalls=1000
[SecureConnections]
ServerCertificatePath=C:\LTR\Config\Certs\MyCertificate.crt
ServerKeyPath=C:\LTR\Config\Keys\MyPrivateKey.keyswitch
[SRTP]
OfferSRTP=0
[SIPRegistration1]
AoR=sip:user@example.com;transport=tls
OutboundProxy=proxy1.example.com
[SIPRegistration2]
AoR=sip:user@example.com;transport=tls
OutboundProxy=proxy2.example.com
[Codecs]
Count=23
0=G.711 mu-law
1=GSM 06.10723.1
3=ADPCM 32 kbit/s
4=ADPCM 64 kbit/s
5=G.711 a-law
6=G.722
7=G.728
8=ADPCM 44.1 kbit/s
9=ADPCM 88.2 kbit/s
10=G.729
11=G.722.1 24 kbit/s 16 Khz
12=G.722.1 32 kbit/s 16 Khz
13=G.722.1 24 kbit/s 32 Khz
14=G.722.1 32 kbit/s 32 Khz
15=G.722.1 48 kbit/s 32 Khz
16=G.726 16 kbit/s
17=G.726 24 kbit/s
18=G.726 32 kbit/s
19=G.726 40 kbit/s
20=AMR Narrow-Band
21=AMR Wide-Band
22=Opus
www.redboxvoice.com
Integration Guide
[SIPRAMSettings]Protocol
The SIP transport protocol to use. Set this to “any” or the specific protocol used by the OSV – this is in
CMP > Subscriber Configuration > Connections > Silent Monitoring Supervisor.
[SIPRAMSettings]SIPPort
The port to listen for SIP communications on. Default is 5060.
[SIPRAMSettings]MaxConcurrentCalls
The number of active sessions allowed before new sessions will be rejected with a SIP 503 response.
Default (and maximum) is 1000.
[SecureConnections]ServerCertificatePath
The path to the server certificate that identifies the Red Box recorder. This is only required where TLS
or DTLS transports are in use. The certificate file must be PEM encoded.
Certificates for any trusted CAs should be placed in C:\LTR\Config\TrustedCAs. Again, these
certificate files must be PEM encoded. The OSV Media Server(s) connecting via TLS or DTLS will be
verified against these CAs.
[SecureConnections]ServerKeyPath
The path to the private key for the Red Box recorder. This is only required where TLS or DTLS
transports are in use. The key file must be PEM encoded.
[SRTP]OfferSRTP
Controls the SRTP mode – must be set to 0 (for OpenScape Voice) to disable SRTP.
[SIPRegistration<N>]AoR
Where N is an incremental index beginning with 1. The Address of Record to register should be of the
form:
<schema>:<user>@<domain>[:<port>][;transport=<protocol>]
Where:
• Schema is either sip or sips.
• User is the user to register i.e. Silent Monitoring Supervisor.*
• Domain is the domain to which the user belongs.
• Port (optional) default: 5060 for udp and tcp, 5061 for tls and dtls. An integer between 1 and
65535.
• Protocol (optional) default: udp if [SIPRAMSettings]Protocol=any, otherwise the specified
protocol. Acceptable values are udp, tcp, tls, and dtls.
*Where DNS is available, it is recommended to use the SIP Domain Name instead of the IP address of
the OSV node. The recorder will use DNS SRV to resolve this and send the registration to the correct
www.redboxvoice.com
Integration Guide
endpoint. This is most useful where L3 failover of the OSV is used. If DNS is not available,
registrations must be configured for each OSV node.
[SIPRegistration<N>]Password
The password to use when presented with an authentication challenge. Will be removed on first start
and the value encrypted and stored in [SIPRegistration<N>]Password.Encrypted.
[SIPRegistration<N>]Password.Encrypted
The encrypted password. Do not modify.
[SIPRegistration<N>]OutboundProxy
The address or host of the outbound proxy. Optional.
[Codecs]
This section contains the enabled codecs in priority order. Values must be entered as described
below (case and whitespace sensitive). Possible values are as follows:
• G.711 a-law
• G.711 mu-law
• G.722
• G.722.1 24 kbit/s 16 Khz
• G.722.1 32 kbit/s 16 Khz
• G.722.1 24 kbit/s 32 Khz
• G.722.1 32 kbit/s 32 Khz
• G.722.1 48 kbit/s 32 Khz
• G.723.1
• G.726 16 kbit/s
• G.726 24 kbit/s
• G.726 32 kbit/s
• G.726 40 kbit/s
• G.728
• G.729
• ADPCM 32 kbit/s
• ADPCM 44.1 kbit/s
• ADPCM 64 kbit/s
• ADPCM 88.2 kbit/s
• AMR Narrow-Band
• AMR Wide-Band
• GSM 06.10
• Opus
www.redboxvoice.com
Integration Guide
CTI Server Config

The OpenScape CTI Server configuration is specified in C:\LTR\Config\CTIServer_OpenScape.ini.
Edit the C:\LTR\Config\CTIServer_OpenScape.ini file on the recorder server to configure CSTA
settings for the OpenScape Voice integration. You’ll need to restart the recorder to apply the
changes. Here is an example of what this file should look like:
[General]
LocalAddress=172.16.250.149
CstaServiceCount=1
ContactCenterCount=1
[CstaService1]
Platform=OpenScapeVoice
MonitorSupervisor=441159777110
Username=
Password=
PasswordEntropy=
NodeAddress1=172.16.242.24
NodePort1=1040
NodeAddress2=172.16.243.24
NodePort2=1040
HeartbeatPeriodSeconds=10
[ContactCenter1]
Address=10.10.1.1
Port=6000
AgentId=CCUser
Password=AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAUkkDtS05602rDoPlmKwGVwQAAAACAAAAAAAQZgAAAAEAACAAAA
PasswordEntropy=byMQLmU3zZQbifMteOj+QPjsCyQ=
[General]LocalAddress
Set this to the recorder’s IP address. This setting must be configured. No default is provided. The
local host address (127.0.0.1) must not be used.
[General]CstaServiceCount
The number of CSTA services to start. Default is 1. With OpenScape Voice L3, a primary/secondary
node cluster count as one CSTA service.
[General]ContactCenterCount
The number of OpenScape Contact Center connections to start. Note that this attribute must have
the US spelling of “center” in order to work with the OpenScape Contact Center SDK. Default is 0.
[CstaService<N>]Platform
The type of CSTA service that will be started. No default is provided. For OpenScape Voice, this must
be set to OpenScapeVoice.
www.redboxvoice.com
Integration Guide
[CstaService<N>]MonitorSupervisor
This setting must match the Directory Number (DN) for the SIP extension used by the recorder
(defined in the Unify Common Management Platform – OSV Subscriber with Silent Monitoring
Supervisor). The number should appear without the “+” but with the fully qualified number, as
illustrated above. This setting must be configured. No default is provided.
[CstaService<N>]Username
Not used for OpenScape Voice. Leave blank.
[CstaService<N>]Password
[CstaService<N>]PasswordEntropy
[CstaService<N>]NodeAddress1
CSTA Manager Virtual IP 1. This setting must be configured. No default is provided.
The virtual IPs of the CSTA Manager can found in the CMP, go to:
Configuration > OpenScape Voice > Administration > Signalling Management > CSTA.
www.redboxvoice.com
Integration Guide
[CstaService<N>]NodePort1
The TCP Listener port number. The default is 1040 for OpenScape Voice, it is also found in the CMP
CSTA Settings page as previously described.
[CstaService<N>]NodeAddress2
CSTA Manager Virtual IP 2. No default is provided. This setting is optional and is only required for
Layer 3 failover.
[CstaService<N>]NodePort2
The TCP Listener port number. Default is 1040 for OpenScape Voice, it is also found in the CMP CSTA
Settings page as previously described.
[CstaService<N>]HeartbeatPeriodSeconds
The frequency in seconds at which heartbeat messages are presented to the OpenScape Voice.
Default is every 10 seconds.
[ContactCenter<N>]Address
The IP address of the OpenScape Contact Center server. No default is provided.
[ContactCenter<N>]Port
The port number on that is used to connect to the OpenScape Contact Center server using a TCP
connection. Default 6000.
[ContactCenter<N>]AgentId
This is the AgentName that the recorder will use to connect to the OpenScape Contact Center
service. No default is provided.
[ContactCenter<N>]Password
The password of the AgentName that the recorder will use to log into OpenScape Contact Center
service. Default is no password.
[ContactCenter]PasswordEntropy
Leave blank when setting the Password field above. This field is autogenerated when the recorder
starts and must not be modified.
www.redboxvoice.com
Integration Guide
Configure Devices
Add Devices
To add devices to your system:
1. For each Subscriber that is required to be “visible” to the recorder, set the Silent Monitor
Agent feature to Active in the CMP – see “OpenScape Voice Switch” on page 9.
2. Add devices to the recorder using the Quantify Register Devices page (Configuration > Setup
> Register Devices).
• Complete the device registration fields. Select “OpenScape Voice (Active)” from the
Device Type drop down. You can add a single device or a range of devices.
• The prefix is the sequence of digits that are prepended to the short dial extension
number to form the Fully Qualified Device Number. The extension is the short dial
extension number for the device.
• A single device requires the prefix and an extension number.
• A range of devices require the prefix, first and last extension.
Note that you must add and review the devices before you register them.
• The state of the registration will be listed next to each device in the table.
Remove Devices
If you need to “remove” a device, the easiest thing to do is simply disable it for recording on the
recorder. If you really need to remove it, you need to:
1. Disable the Silent Monitor Agent feature for the device in the OSV Common Management
Platform.
2. Delete the device from the Quantify Recording Devices list on the recorder (Configuration >
Management > Recording).
Enable/Disable Devices for Recording

To enable/disable devices for recording, login to the recorder as a system administrator and go to
Configuration > Management > Recording. For more details of this configuration page, please refer
to the “How Do I Manage Channels/Devices” Quick Question topic.
www.redboxvoice.com
Integration Guide
Log Files
The following log files are provided on the recorder server:
• RTP Collector – C:\LTR\Logs\RTPCollector.txt and RTPCollector.Stats.txt
• SIP RAM – C:\LTR\Logs\SIP_RAMLog15.txt and C:\LTR\Logs\SIP messages.txt
• OpenScape CTI Server – C:\LTR\Logs\CTIServer_OpenScape.txt
• CTI Only PP – C:\LTR\Logs\PP_CTIOnly.txt
RTP Collector
The RTP Collector log is stored in C:\LTR\Logs\RTPCollector.txt – it logs any issues processing media.
To define the logging level, set the [RBRLogging]LogLevel in the
C:\RAM\RTPCollector\RTPCollector.ini file to one of the following values:
• INFO
• MESSAGE
• WARNING
• PRINT
• ERROR
The RTP Collector Stats log is stored in C:\LTR\Logs\RTPCollector.Stats.txt – it logs the up-time and
in-progress session count every 5 minutes.
SIP RAM
The SIP RAM log is stored in C:\LTR\Logs\SIP_RAMLog15.txt – it logs any issues processing SIP. To
define the logging level, set the [RBRLogging]LogLevel in the
C:\LTR\Config\logging\SIP_RAM.log.config file to one of the warning levels as listed above.
The SIP Message log is stored in C:\LTR\Logs\SIP messages.txt – it logs all sent and received SIP
messages.
OpenScape CTI Server Log

The OpenScape CTI Server logs is stored in C:\LTR\Logs\CTIServer_OpenScape.txt – it logs any issues
processing CSTA metadata. To define the logging level, set the [RBRLogging]LogLevel in the
C:\LTR\Config\CTIServer_OpenScape.exe.config file to one of the following:
• ALL
• DEBUG
• WARN
• ERROR
• OFF
www.redboxvoice.com
Integration Guide
CTI Only PP Log

The CTI Only PP log is stored in C:\LTR\Logs\PP_CTIOnly.txt – it logs any issues with starting and
stopping CTI overlay calls. To define the logging level, set the [RBRLogging]LogLevel in the
C:\LTR\Config\CTIServer_OpenScape.exe.config file to one of the following:
• INFO
• MESSAGE
• WARNING
• PRINT
• ERROR
www.redboxvoice.com
Integration Guide
OpenScape Voice – Specific Recorder Alarms

Alarms raised specifically by the OSV integration (Configuration > Status > Recorder Status or Insight
> Health > Recorder Alarms).
Type: Critical
Alarm: Disconnected from all CSTA nodes for a CSTA service. Call recording capability lost.
Description: This alarm is raised on a per CSTA service basis. May be due to a network or telephony
system outage.
Type: Critical
Alarm: Failed to register a SIP AoR. Call recording capability lost.
Description: This alarm is raised on a per SIP registration basis. May be due to a network or
telephony system outage. Could equally be due to misconfiguration of the Silent Monitoring
Supervisor on the recorder or in OSV CMP.
Type: Warning
Alarm: Disconnected from a CSTA node for a CSTA service. Call recording capability at risk.
Description: This alarm is raised on a per CSTA node basis. May be due to a network or telephony
system outage.
Type: Warning
Alarm: Failed to start a CSTA monitor for a device. Calls on this device will not be recorded. Check
device configuration. Remove the device if it does not exist.
Description: This alarm is raised on a per device basis. May be due to incorrect configuration of the
device on the recorder or in OSV CMP.
Type: Warning
Alarm: Failed to join a call for a device. Audio for this call will not be recorded.
Description: This alarm is raised on a per device basis. May be due to incorrect configuration of the
device on the recorder or in OSV CMP.
Type: Warning
Alarm: An integration has requested a database update. Please restart the Recorder when it is
convenient but be aware that this could take several hours.
Description: This is a global alarm. It may be raised when first setting up OpenScape Voice or adding
OpenScape Contact Center to an existing OpenScape Voice recorder. Information to be stored in the
newly requested database fields will not be recorded until the recorder is restarted.
www.redboxvoice.com

RBR-ITG-Unify OpenScape Voice Integration Guide V1.4

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RBR-ITG-Unify OpenScape Voice Integration Guide V1.4

Uploaded by

Copyright:

Available Formats

Unify OpenScape Voice

Log Files ........................................................................................................................................ 26

Unify OpenScape Voice – Call Recording Overview

SIP Call Flow

Specifications & Requirements

• OpenScape Desk Phone CP200

Call Recording Capabilities

Integration Dependent Features

OpenScape Voice Switch

Unify Common Management Platform (CMP) – Example Subscriber Configuration

OpenScape Contact Center SDK Runtime

Codec Algorithm Bitrate (Kbps) Sampling Frequency Audio Bandwidth MOS

OpenScape Voice Layer 3 Failover

OpenScape Contact Center

Configure RTP Collector

Configure SIP RAM

CTI Server Config

Enable/Disable Devices for Recording

OpenScape CTI Server Log

CTI Only PP Log

OpenScape Voice – Specific Recorder Alarms

You might also like