DO NOT SHARE THESE DOCS WITH CUSTOMERS!

This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.


In this section:

Related articles:

Use the commands provided to start recording and stop recording of a specific call using the SIPREC protocol. The SIPREC protocol defines the interaction between a session recording client (SRC) and a session recording server (SRS), and controls the recording of media transmitted in the context of a communications session (CS) between multiple user agents.

A basic call, or CS, is established between SIP phone 1 and SIP phone 2 through the SBC. The SBC establishes a recording session for the CS, based on configuration, towards the SRS.

The SRC and SRS act as SIP user agents whereby the SRC provides additional information (called metadata) to the SRS recording session to describe the communication sessions, participants, and media streams to facilitate archival and retrieval of the recorded information.

For more information on SIPREC functionality and feature interaction, refer to SIPREC Support or Session Recording Support.

SIPREC Start and Stop Commands

On the SBC main screen, navigate to All > Global > SIPrec

Click on the arrow to open a drop-down list of SIPREC commands you can use to start or stop recording of a specific call.

SIPREC Commands

To start recording

Select the Start Record command and click Select. A startRecord pop-up window opens.

startRecord window

Note
  • For SIPREC SIP-based session recording, by default the SBC, as the SRC, sends the INVITE to the SRS over UDP transport. The SBC also supports sending SIPREC INVITEs to the SRS over TCP or TLS.
  • To support SIPREC INVITE over TCP, the Sip Sig Port, which is configured in the zone for SIPREC, must have Transport Protocols Allowed set to sip-tcp.

Set the start recording parameters using the following table.

Start Recording Parameters

Parameter

Description

GCID

Specifies the GCID of the call to start recording.

Call Leg

Call leg associated with this recording session. The options are:

  • Egress
  • Ingress (default)
Num Of StreamsSpecifies the number (1 or 2) of simultaneous streaming to different SRS IP addresses. By default, the value is 1.
Srs IP AddressSpecifies the IP address of the SRS.
Srs PortSpecifies the UDP port of the SRS.
Srs IP Address2

Specifies the IP address of the secondary recording server to which the media stream is forked.

NOTE: This parameter is mandatory if the parameter Num Of Streams is set to 2.

Srs Port2

Specifies the IP port of the secondary recording server to which the media stream is forked.

NOTE: This parameter is mandatory if the parameter Num Of Streams is set to 2.

Trunk GroupSpecifies the name of the SIPREC trunk group associated with this recording session.
Transport

Select the transport protocol over which you want to send the SIPREC INVITE. The options are:

  • UDP (default)
  • TLS
  • TCP
Trunk Group2

Specifies the name (maximum 24 characters) of the SIPREC trunk group towards second SRS IP with which the calls have to be recorded.

NOTE: This parameter is mandatory if the parameter Num Of Streams is set to 2.

Transport2

Specifies the type of transport to be used for recording session on the secondary SRS IP. The options are:

  • UDP (default)
  • TLS
  • TCP

NOTE: This parameter is mandatory if the parameter Num Of Streams is set to 2.

SrsFqdn1Specifies the FQDN of the SRS. If you specify both an FQDN and individual IP address, the IP address takes precedence.
SrsFqdn2Specifies the FQDN of the secondary recording server to which the media stream is forked.

Make the required changes and click startRecord on the pop-up window to initiate the SIP-based session recording.

Note

If the parameter Num of Streams is set to "1", and secondary SRS details are provided for the parameters Srs IP Address2, Srs Port2, and Trunk Group2, then the information about the secondary SRS information is used for redundancy if the primary SRS goes down.

Note:

The SBC supports executing the startRecord command twice: once for the ingress call-leg and once for the egress call-leg, to establish up to two streams in both directions simultaneously to achieve quad-recording.

To stop recording

Select the Stop Record command and click Select. A stopRecord pop-up window opens.

stopRecord Window

 Set the stop recording parameters using the following table.

Stop Recording Parameters

Parameter

Description

GCID

Specifies the GCID of the call to stop recording.

Recorder AddressSpecifies the IP address of the recorder on which to stop the recording.
Recorder PortSpecifies the port number of the recorder on which to stop the recording.
Recorder FQDNSpecifies the FQDN of the recorder on which to stop a recording.
Recorder IDSpecifies the unique identifier of the recording session to stop.  

Make the required changes and click stopRecord on the pop-up window to stop the SIP-based session recording. 

Note

For the stopRecord command, if only the GCID value is provided, all recordings for that GCID are stopped at once.