Uniphore Customer Portal

Only config settings relevant to this SIPREC integration are listed here. For all other settings, leave these set to their default values.

[General]CollectorId

The unique identifier for this Collector. A UUID will be automatically generated and written to IntegrationAdapter.ini on first start.

[General]TenantId

Set to the unique identifier of the U‑Capture tenant associated with this Collector.

[General]RecordByDefault

Set to 1 to enable or 0 to disable recording by default, for newly discovered devices. If not specified, the default value is 1 (enabled).

[JetStream]ServerURL

The URL of the NATS server. In the most simple of cases, this will be the NATS server used by U-Capture’s Core Services.

[JetStream]Username

If the NATS server is configured for user based authentication, specify the username here. If not specified, no value is used.

[JetStream]Password

If the NATS server is configured for user based authentication, specify the password here. If a password is used, the NATS server should also be configured to use TLS to prevent the password from being sent over the network in the clear. If not specified, no value is used.

[JetStream]Token

If the NATS server is configured for token based authentication, specify the token here. If a token is used, the NATS server should also be configured to use TLS to prevent the token from being sent over the network in the clear. If not specified, no value is used.

[JetStream]TrustedCACertificatesFileName

If the NATS server is configured to use TLS, specify the trusted CA certificate chain here. This will be the CA certificate chain that was used to sign the server certificate. If not specified, no value is used.

[JetStream]ClientCertificateChainFilename

If the NATS server is configured to use TLS with mutual-authentication, specify the client certificate chain here. This will be the client certificate plus the CA certificate chain used to sign the client certificate. If not specified, no value is used.

[JetStream]ClientCertificateKeyFilename

If the NATS server is configured to use TLS with mutual-authentication, specify the client private key here. If not specified, no value is used.

[JetStream]SkipServerVerification

If the NATS server is configured to use TLS, disables verification of the server certificate. Not recommended. If not specified, the default value is 0.

[VoiceActivityDetection]

This section of the ini file is used to define the VAD settings. If the default configuration values don’t work for the customer, it’s recommended that you disable VAD, then record and export some example calls to WAV. These files can then be passed through a test tool that will allow the trial of different configuration values to ensure the correct parts of the call are identified as voice. The best fit configuration can then be applied to the Collector. Please contact the Uniphore Development Support Team for details.

To disable Voice Activity Detection, simply disable the use of both Short-Term Energy and Zero Crossing Rate.

[VoiceActivityDetection]WindowSizeMS

The size of the window, in milliseconds, on which to perform VAD. The default is 10 milliseconds – we don’t recommend any other value at present.

[VoiceActivityDetection]UseShortTermEnergy

Enables/disables use of the Short-Term Energy algorithm. By default, this is enabled (1).

[VoiceActivityDetection]MinEnergy

The minimum energy required for the window to be considered as voice activity. Expressed as a decimal value between zero and one. Zero being absolute silence and one being maximum loudness. The default is 0.000060. This may seem like a low value, but generally background noise will be lower than this.

[VoiceActivityDetection]UseZeroCrossingRate

Enables/disables use of the Zero Crossing Rate (ZCR) algorithm. Use of ZCR is only recommended if it’s required that tones on channel do not trigger voice recording. If this is the case, ZCR should be used in conjunction with STE. By default, ZCR is disabled (0).

[VoiceActivityDetection]MinZeroCrossingRate

The minimum Zero Crossing Rate for the window to be considered as voice activity. The default is 0.000001. Human speech has a low ZCR, increasing this value may prevent voice from being detected. A lower limit is required because a ZCR of zero indicates that the sine wave is not crossing zero i.e. the waveform is flatline (silence).

[VoiceActivityDetection]MaxZeroCrossingRate

The maximum Zero Crossing Rate for the window to be considered as voice activity. The default is 0.187400.

[VoiceActivityDetection]UseActivityTriggering

Enables/disables use of activity triggering. By default this is disabled (0). If enabled (1), a voice recording will not be created until voice activity is detected on the channel. Likewise, the voice recording will be ended on cessation of voice activity on the channel. If disabled (0), voice recordings will be created and ended based on signalling as normal.

[VoiceActivityDetection]MinActivityMS

The minimum duration of voice activity, in milliseconds, that is required to invoke voice recording. The default is 20 milliseconds. This value must be a multiple of the window size and must be between 10 and 300 milliseconds.

[VoiceActivityDetection]ActivityEndHangTimeMS

The duration, in milliseconds, to continue the voice recording after voice activity has ceased. The default is 5000 milliseconds (5 seconds). This value must be a multiple of the window size. This prevents pauses in speech from causing excessive stopping and restarting of recording.

[Licence]RecordInternalCalls

Enable (1) or disable (0) the recording of internal calls (extension to extension calls). If not specified, the default value is 1.

[Licence]RecordPoolChannels

Defines how many concurrent channels can be captured by the Collector. Calls over this value will be discarded. If not specified, the default value is 1000.

[Licence]PP<0…N>

PP licence code for the Collector. This will have been provided as part of the customer’s deployment information from Uniphore.

[Phones]DetectNewItems

Enable (1) or disable (0) the automatic detection (discovery) of new devices. The default is enabled (1). In general, leave this set to 1 (enabled) for initial system setup and device discovery – if the customer then wants to “lock down” their recordable devices, this can be changed to 0 (disabled).

[STAN]ServerURL

Set to the URL of the NATS Streaming Server for the U‑Capture Core Services associated with this Collector.

[STAN]ClusterID

Defines the NATS Streaming cluster ID – must be set to stan-cluster.

[STAN]ClientID

A string that identifies this NATS Streaming client. The Collector ID is appended to this to ensure it is unique. If not specified, the default value is RedBox-IntegrationAdapter.

[STAN]Username

If the NATS Streaming Server is configured for user based authentication, specify the username here. If not specified, no value is used.

[STAN]Password

If the NATS Streaming Server is configured for user based authentication, specify the password here. If a password is used, the NATS Streaming Server should also be configured to use TLS to prevent the password from being sent over the network in the clear. If not specified, no value is used.

[STAN]CertificateChainFilename

If the NATS Streaming Server is configured to use TLS, specify the trusted CA certificate chain here. This will be the CA certificate chain that was used to sign the server certificate. If not specified, no value is used.

[STAN]ClientCertificateChainFilename

If the NATS Streaming Server is configured to use TLS, specify the client certificate chain here. This will be the client certificate plus the CA certificate chain used to sign the client certificate. If not specified, no value is used.

[STAN]ClientCertificateKeyFilename

If the NATS Streaming Server is configured to use TLS, specify the client private key here. If not specified, no value is used.

[STAN]Ciphers

If the NATS Streaming Server is configured to use TLS, this value can be used to restrict the allowed ciphers. If not specified, no value is used.

An example of the IntegrationAdapter.ini file using the depreciated NATS Streaming settings:

[General]
CollectorId=0f89817f-e324-48ca-bcb6-3d61f292755b
TenantId=dcedc429-11a9-4408-84a7-c781363c62e1

[STAN]
ServerURL=nats://abcd.dev.mycompany.com:4222
ClusterID=stan-cluster
ClientID=RedBox-IntegrationAdapter-1
ConnectionTimeoutMS=15000
RetryWaitMS=15000
Username=
Password=
SkipServerVerification=0
CertificateChainFilename=
ClientCertificateChainFilename=
ClientCertificateKeyFilename=
Ciphers=

[STANChannels]
Alerts=RedBox.Collector.Alert
EventLogs=RedBox.Collector.EventLogs
ConfigRequests=RedBox.Collector.ConfigRequests
ConfigEvents=RedBox.Collector.ConfigEvents
Media=media
Metadata=metadata

[VoiceActivityDetection]
WindowSizeMS=10
UseShortTermEnergy=1
MinEnergy=0.000060
UseZeroCrossingRate=0
MinZeroCrossingRate=0.000001
MaxZeroCrossingRate=0.187400
UseActivityTriggering=0
MinActivityMS=20
ActivityEndHangTimeMS=5000

[Licence]
RecordInternalCalls=1
RecordPoolChannels=1000
PP0=P9XCS8KLATSJNHGN

[INSTALLED PPS]
PP0=/usr/lib/libPP_Matcher.so

[Phones]
DetectNewItems=1

Only config settings relevant to this SIPREC integration are listed here. For all other settings, leave these set to their default values.

[MediaPorts]

Defines the RTP media port range to capture data from.

[MediaPorts]Min

The beginning of the media port range. Default is 25000.

[MediaPorts]Max

The end of the media port range. Default is 65535.

[SRTCP]UseSRTCPWhenSRTP

Enables/disables the expectation that RTCP will also be encrypted when SRTP is being used for a given session. If not specified, defaults to 1 (enabled).

[<adapter-name>]

The RTP Collector discovers all available network adapters on start-up – they’re listed by their device name (GUID). The adapter’s IPv4 address is displayed for ease of identification. By default, all adapters are enabled for media traffic. Enable (Use=1, default) or disable (Use=0) adapters as needed.

It’s important that only adapters reachable by the telephony system are used. Adapters are load balanced, so sessions will be evenly distributed across all enabled adapters.

[<adapter name>]AdvertisedIPv4Address

Overrides the IPv4 address advertised for the given network adapter. This is useful when you need an ingress address that is not an address belonging to the RTP Collector itself. If not specified, then defaults to the adapter’s IPv4 address.

Only config settings relevant to this SIPREC integration are listed here. For all other settings, leave these set to their default values.

[SIPRAMSettings]IP

The hostname or IP address of the Integration Adapter. If not specified, defaults to localhost.

[SIPRAMSettings]Protocol

The SIP transport protocol to use (udp, tcp, tls, or any). Default is udp.

[SIPRAMSettings]SIPPort

The port to listen for SIP communications on. Default is 5060. If [SIPRAMSettings]Protocol is an explicit protocol, then [SIPRAMSettings]SIPPort describes an explicit port for that protocol. If [SIPRAMSettings]Protocol is any, then [SIPRAMSettings]SIPPort describes the base port used for non-secure SIP and secure SIP uses the base port plus one.

[SIPRAMSettings]MaxConcurrentCalls

The number of active SIP sessions allowed before new sessions will be rejected with a SIP 503 response. Default is 1000. This setting should match the channel count - see [Licence]RecordPoolChannels.

[SIPRAMSettings]ExtensionField

Allows the SIP RAM to be configured to take the user from the to header as the recorded extension. If not specified, defaults to from.

[SIP]MessageLogging

Enables (1) or disables (0) logging of SIP messages. If not specified, defaults to 1.

[SecureConnections]Ciphers

Allows the TLS and DTLS ciphers to be overridden.

[SecureConnections]ServerCertificatePath

The path to the server certificate that identifies the Uniphore SIP User Agent. This is only required where TLS or DTLS transports are in use. The certificate file must be PEM encoded.

[SecureConnections]ServerKeyPath

Specifies the PEM format private key file that corresponds to the SIP RAM server certificate. If not specified, no certificate is used.

[SRTP]Disabled

Disables use of SRTP (set to 1). If not specified, defaults to 0.

[SRTP]Mode

Specifies the negotiation mode for setting up SRTP. If not specified, defaults to 2 (best effort). Acceptable values are:

1 (mandatory – if the peer does not support SRTP, the session will fail)

2 (best effort – if the peer supports SRTP, SRTP will be used)

3 (fallback)

4 (multiple media descriptor)

[ RTPCollector<1…N>]Host

The hostname or IP address of the RTP Collector. If not specified, defaults to localhost.

[RTPCollector<1…N>]Port

The port on which to communicate with the given RTP Collector. If not specified, defaults to 6500.

[RTPCollector<1…N>]TimeoutMS

The duration, in milliseconds, to wait for a response from the given RTP Collector before considering the request timed out. If not specified, defaults to 1000.

[ Control]ListenPort

The port on which to listen for client connections from services wishing to control the SIP RAM. If not specified, defaults to 6501.

[Codecs]

This section contains the enabled codecs in priority order. Values must be entered as shown below (case and whitespace sensitive) – possible values are as follows:

[SIPRegistration<N>]AoR

The Address of Record to register. Should be of the form:

<schema>:<user>@<domain>[:<port>][;transport=<protocol>]

Where:

[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 hostname or IP address of the outbound proxy (optional).