Configuring SIPREC on Ribbon Core SBC for Amazon Chime Voice Connector (CVC) SIPREC Recording Services (SRS)

Interoperable Vendors

Copyright

© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved. The compilation (meaning the collection, arrangement and assembly) of all content on this site is protected by U.S. and international copyright laws and treaty provisions and may not be used, copied, reproduced, modified, published, uploaded, posted, transmitted or distributed in any way, without prior written consent of Ribbon Communications Inc.

The trademarks, logos, service marks, trade names, and trade dress (“look and feel”) on this website, including without limitation the RIBBON and RIBBON logo marks, are protected by applicable US and foreign trademark rights and other proprietary rights and are the property of Ribbon Communications Operating Company, Inc. or its affiliates. Any third-party trademarks, logos, service marks, trade names and trade dress may be the property of their respective owners. Any uses of the trademarks, logos, service marks, trade names, and trade dress without the prior written consent of Ribbon Communications Operating Company, Inc., its affiliates, or the third parties that own the proprietary rights, are expressly prohibited.

Document Overview

This document outlines the configuration best practices for the Ribbon SBC SWe Core & when deployed with Amazon Chime Voice Connector (CVC) SIPREC Recording Services (SRS).

About Ribbon SBC SWe Core :

The SBC SWe Core addresses the next-generation needs of SIP communications by delivering embedded media transcoding, robust security and advanced call routing in a high-performance, small form-factor device enabling service providers and enterprises to quickly and securely enhance their network by implementing services like SIP Trunking, secure Unified Communications and Voice over IP (VoIP).

The SBC SWe Core provides a reliable, scalable platform for IP interconnect to deliver security, session control, bandwidth management, advanced media services and integrated billing/reporting tools in an SBC appliance. This versatile series of SBCs can be deployed as peering SBCs, access SBCs or enterprise SBCs (eSBCs). The SBC product family is tested for interoperability and performance against a variety of third-party products and call flow configurations in the customer networks.

About Amazon Chime Voice Connector (CVC) :

Customers can deploy the Ribbon SBC in multiple deployment infrastructures – AWS, VMWare, KVM, and as an appliance (SBC 5400, SBC 7000, etc). Customers using the Ribbon SBC can connect to the Amazon Chime Voice Connector (CVC) SIPREC Recording Services (SRS).

This document assumes the Ribbon SBC is currently able to make and receive calls using the Amazon CVC.

This document provides example configuration steps for enabling SIPREC from the Ribbon SBC to the Amazon CVC.

Note

The Ribbon SBC will require the SIP Recording feature licenses (e.g. SBC-C-SW-RECORD1) to enable SIPREC. Please work with your Ribbon Account Manager or Partner, if you need licenses.

Scope/Non-Goals

This document provides configuration best practices for deploying Ribbon's SBC SWe Core for Amazon Chime Voice Connector (CVC) recording Interop. Note that these are configuration best practices and each customer may have unique needs and networks. Ribbon recommends that customers work with network design and deployment engineers to establish the network design which best meets their requirements.

It is not the goal of this guide to provide detailed configurations that meet the requirements of every customer. Use this guide as a starting point, and build the SBC configurations in consultation with network design and deployment engineers.

Audience

This is a technical document intended for telecommunications engineers with the purpose of configuring the Ribbon SBC SWe Core.

To perform this interop, you need to:

use the graphical user interface (GUI) or command line interface (CLI) of the Ribbon product,
understand the basic concepts of TCP/UDP/TLS and IP/Routing, and
have an understanding of SIP/RTP/SRTP to complete the configuration, and for troubleshooting.

Note

This configuration guide is offered as a convenience to Ribbon customers. The specifications and information regarding the product in this guide are subject to change without notice. All statements, information, and recommendations in this guide are believed to be accurate but are presented without warranty of any kind, express or implied, and are provided “AS IS”. Users must take full responsibility for the application of the specifications and information in this guide.

Prerequisites

The following aspects are required before proceeding with the interop:

Ribbon SBC SWe Core
Ribbon SBC SWe Core license
- A valid license from Ribbon is required to enable functionality on Ribbon SBCs. Each SBC license provides a base set of capabilities to allow enabling and adding of additional features and capacity, as required.
Amazon Chime Voice Connector (CVC) setup

Product and Device Details

The configuration uses the following equipment and software:

Product	Equipment/Service	Software Version
Ribbon Communications	SBC SWe Core	V10.01.00-R000
Third-Party Equipment	Amazon Chime Voice Connector (CVC)

Network Topology

Deployment Topology

Figure 1:

Installing Ribbon SBC SWe Core

Ribbon SBC Standalone

To deploy the Ribbon SBC SWe Core StandAlone instance, refer to SBC Core 10.1.x Documentation

Ribbon SBC High Availability

To deploy the Ribbon SBC SWe Core in HA mode on different platforms, refer to SBC Core Software Installation and Upgrade Guide.

Configurations for Ribbon SBC SWe Core

Profiles Creation

1. Create a Number Globalization Profile for Chime SIPREC

The Number Globalization Profile object is used to define numbers that are to be globalized for egress SIP message headers. Specify a profile entry for each number type that needs to be globalized. The profile includes a digit type, a source for the country code, and a flag to enable the globalization. Assign Globalize Profiles to egress trunk groups by selecting them on the IP Signaling Profile for each trunk group.

set profiles signaling numberGlobalizationProfile NO_GLOBAL entry callingNumber digitType nationalType,internationalType
set profiles signaling numberGlobalizationProfile NO_GLOBAL entry callingNumber countryCodeSource destination
set profiles signaling numberGlobalizationProfile NO_GLOBAL entry callingNumber globalize disable
set profiles signaling numberGlobalizationProfile NO_GLOBAL entry calledNumber digitType nationalType,internationalType
set profiles signaling numberGlobalizationProfile NO_GLOBAL entry calledNumber countryCodeSource destination
set profiles signaling numberGlobalizationProfile NO_GLOBAL entry calledNumber globalize disable
commit

2. Create a Chime SIPREC IP Signaling Profile

This object specifies parameters associated with H.323, SIP, and SIP-I communication that are sent as part of the outgoing signaling message after standard protocol rules have been applied.

You can associate IP signaling profiles with IP trunk groups and virtual trunk groups.

set profiles signaling ipSignalingProfile SIPREC_IPSP ipProtocolType sipOnly
set profiles signaling ipSignalingProfile SIPREC_IPSP commonIpAttributes flags disableMediaLockDown enable
set profiles signaling ipSignalingProfile SIPREC_IPSP commonIpAttributes flags includeTransportTypeInContactHeader enable
set profiles signaling ipSignalingProfile SIPREC_IPSP commonIpAttributes flags minimizeRelayingOfMediaChangesFromOtherCallLegAll enable
set profiles signaling ipSignalingProfile SIPREC_IPSP egressIpAttributes numberGlobalizationProfile NO_GLOBAL
set profiles signaling ipSignalingProfile SIPREC_IPSP egressIpAttributes flags disable2806Compliance enable
set profiles signaling ipSignalingProfile SIPREC_IPSP egressIpAttributes privacy privacyInformation pPreferredId
set profiles signaling ipSignalingProfile SIPREC_IPSP egressIpAttributes privacy flags includePrivacy enable
set profiles signaling ipSignalingProfile SIPREC_IPSP egressIpAttributes sipHeadersAndParameters flags transparencyForDestinationTrunkGroupParameter enable
commit

3. Create CHIME Interconnection SIP Message Manipulation Profiles

SIP Message Manipulation (SMM) allows you to modify SIP messages as they are processed by the SBC Core in both inbound and outbound directions. Using SMM criteria and actions, you define SMM rules within a SIP adaptor profile which the SBC applies to SIP messages to modify their headers and/or parameters. When a message comes into or out of the SBC and a SIP adaptor profile applies, the message is evaluated based on the set of criteria in the profile. If the message meets the criteria, it is modified according to actions defined in the profile.

set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM state enabled
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM advancedSMM disabled
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM profileType messageManipulation
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 applyMatchHeader all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 1 message messageTypes request
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 1 message methodTypes invite
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 type header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header name request-line
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header hdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header numberOfInstances number 0
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 2 header numberOfInstances qualifier undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token condition regex-match
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token tokenType urihostname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token regexp
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token regexp string "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}"
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 criterion 3 token regexp numMatch match
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 operation modify
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 from value cafz9ozibmhu0i0fc1cqz5.g.voiceconnector.chime.aws
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 to type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 1 action 1 to tokenValue urihostname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 applyMatchHeader all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 1 message messageTypes request
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 1 message methodTypes invite
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 type header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header name to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header hdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header numberOfInstances number 0
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 2 header numberOfInstances qualifier undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token condition regex-match
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token tokenType urihostname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token regexp
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token regexp string "[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}"
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 3 token regexp numMatch match
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 4 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 4 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 4 token condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 4 token tokenType urihostname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 criterion 4 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 operation modify
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 from value cafz9ozibmhu0i0fc1cqz5.g.voiceconnector.chime.aws
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 to type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 2 action 1 to tokenValue urihostname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 applyMatchHeader all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 1 message messageTypes all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 1 message methodTypes undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 type header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header name from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header hdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header numberOfInstances number 0
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 2 header numberOfInstances qualifier undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 3 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 3 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 3 token condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 3 token tokenType uriusername
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 criterion 3 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 operation modify
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 from value +13012341234
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 to type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 3 action 1 to tokenValue uriusername
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 applyMatchHeader all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 1 message messageTypes all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 1 message methodTypes undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 type header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header name from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header hdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header numberOfInstances number 0
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 2 header numberOfInstances qualifier undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 3 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 3 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 3 token condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 3 token tokenType uridisplayname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 criterion 3 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 operation modify
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 from value +13012341234
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 to type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 4 action 1 to tokenValue uridisplayname
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 applyMatchHeader one
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 1 message messageTypes requestAll
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 1 message methodTypes undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 type header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header name request-line
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header hdrInstance all
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header hdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header numberOfInstances number 0
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 2 header numberOfInstances qualifier undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 3 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 3 token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 3 token condition exist
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 3 token tokenType uriusername
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 criterion 3 token value ""
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 operation modify
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 from
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 from value +13012341234
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 to
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 to type token
set profiles signaling sipAdaptorProfile CHIME_EGRESS_SMM rule 5 action 1 to tokenValue uriusername
commit

set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM state enabled
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM advancedSMM disabled
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM profileType messageManipulation
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 applyMatchHeader all
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 applyMatchHdrRange undefined
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 type message
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 message
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 message messageTypes response
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 message methodTypes invite
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 message statusCode 200
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 1 message condition undefined
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 type messageBody
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody condition regex-match
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody messageBodyType all
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody regexp
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody regexp string "a=maxptime:60a=rtpmap:0 PCMU/8000"
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 criterion 2 messageBody regexp numMatch match
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 type messageBody
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 operation regsub
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 headerInfo undefined
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 headerPosition undefined
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 paramType undefined
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 from
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 from type value
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 from value "a=maxptime:60\\r\\na=rtpmap:0 PCMU/8000"
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 to
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 to type messageBody
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 to messageBodyValue all
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 regexp
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 regexp string "a=maxptime:60a=rtpmap:0 PCMU/8000"
set profiles signaling sipAdaptorProfile CHIME_INGRESS_SMM rule 1 action 1 regexp matchInstance all
commit

SIPREC Routing objects

1. Create a SIPREC dedicated Zone

A Zone is used to group a set of objects unique to a particular customer environment.

set addressContext default zone SIPREC_ZONE id 300
commit

2. Create a SIPREC Signaling Port

A SIP Signaling Port is a logical address permanently bound to a specific zone, and is used to send and receive SIP call signaling packets. A SIP Signaling Port is capable of multiple transports such as UDP, TCP, and TLS/TCP.

Note

To support SIPREC INVITE over TCP, the sipSigPort, which is configured in the zone for SIPREC must have transportProtocolsAllowed as sip-tcp.

set addressContext default zone SIPREC_ZONE sipSigPort 300 ipInterfaceGroupName PKT1_IPIG
set addressContext default zone SIPREC_ZONE sipSigPort 300 portNumber 5060
set addressContext default zone SIPREC_ZONE sipSigPort 300 mode inService
set addressContext default zone SIPREC_ZONE sipSigPort 300 state enabled
set addressContext default zone SIPREC_ZONE sipSigPort 300 siprec enabled
set addressContext default zone SIPREC_ZONE sipSigPort 300 ipVarV4 ALT_Pkt1_01.IP
set addressContext default zone SIPREC_ZONE sipSigPort 300 ipPublicVarV4 ALT_Pkt1_01.FIPV4
set addressContext default zone SIPREC_ZONE sipSigPort 300 sipTcpConnectionAgingState enabled
commit

3. Create a SIPREC Trunk Group

SIP Trunk Groups are used to apply a wide-ranging set of call management functions to a group of peer devices (endpoints) within the network. SIP Trunk Groups are created within a specific address context and zone.

All SBC signaling and routing (both Trunking and Access) are based upon Trunk Group configurations that are defined within zones. A zone can contain multiple Trunk Groups.

set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 state enabled mode inService media mediaIpInterfaceGroupName PKT1_IPIG
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy carrier 0000
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy country 1
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy digitParameterHandling numberingPlan NANP_ACCESS
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy callRouting elementRoutingPriority DEFAULT_IP
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy media packetServiceProfile DEFAULT
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy services classOfService DEFAULT_IP
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy signaling ipSignalingProfile SIPREC_IPSP
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 policy featureControlProfile DEFAULT_IP
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling accessClass none
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling callingParty paiForCallingParty enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling callingParty ppiForCallingParty enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling callingParty rpiForCallingParty enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling callingParty fromHdrForCallingParty enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling sdpTransparency sdpTransparencyState disabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling messageManipulation inputAdapterProfile CHIME_INGRESS_SMM
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling messageManipulation outputAdapterProfile CHIME_EGRESS_SMM
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 signaling rel100Support enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 services dnsSupportType a-only
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 services natTraversal signalingNat enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 services natTraversal mediaNat enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 services natTraversal learnNatForRtpOnly enabled
set addressContext default zone SIPREC_ZONE sipTrunkGroup SIPREC_1 media sourceAddressFiltering enabled
commit

Enabling SIP Recording

1. Create SIPREC Trigger Criteria

set global servers callRecordingCriteria SIPREC_CRITERIA_1 srsGroupClusterId SIPREC_CLUSTER_1
set global servers callRecordingCriteria SIPREC_CRITERIA_1 ingressTgId PKT0_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_1 egressTgId PKT1_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_1 nextHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_1 previousHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_1 recordingType allLegs
set global servers callRecordingCriteria SIPREC_CRITERIA_1 recorderType SIPRec
set global servers callRecordingCriteria SIPREC_CRITERIA_1 criteriaState enable
set global servers callRecordingCriteria SIPREC_CRITERIA_2 srsGroupClusterId SIPREC_CLUSTER_1
set global servers callRecordingCriteria SIPREC_CRITERIA_2 ingressTgId PKT1_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_2 egressTgId PKT0_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_2 nextHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_2 previousHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_2 recordingType allLegs
set global servers callRecordingCriteria SIPREC_CRITERIA_2 recorderType SIPRec
set global servers callRecordingCriteria SIPREC_CRITERIA_2 criteriaState enable
set global servers callRecordingCriteria SIPREC_CRITERIA_3 srsGroupClusterId SIPREC_CLUSTER_1
set global servers callRecordingCriteria SIPREC_CRITERIA_3 ingressTgId PKT1_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_3 egressTgId PKT1_TG
set global servers callRecordingCriteria SIPREC_CRITERIA_3 nextHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_3 previousHopIP 0.0.0.0
set global servers callRecordingCriteria SIPREC_CRITERIA_3 recordingType allLegs
set global servers callRecordingCriteria SIPREC_CRITERIA_3 recorderType SIPRec
set global servers callRecordingCriteria SIPREC_CRITERIA_3 criteriaState enable
commit

2. CLI

% set global servers callRecordingCriteria <criteria name>
calledPartyId <0-9>
callingPartyId <0-9>
criteriaState <disable | enable>
egressTgId <EgSipTrunk | ingSipTrunk>
ingressTgId <EgSipTrunk | ingSipTrunk>
nextHopIP <IP address>
numberOfCalls <0-99999>
previousHopIP <IP address>
recorderType <SIPRec | mct>
recordingDuration <0-3600 seconds>
recordingStopCriteria <manual | numOfCalls>
recordingType <allLegs | bothLegs | egressLeg | ingressLeg>
srsGroupCluster <SRS Group identifier>
srsGroupProfile <SRS Group Profile name>

3. EMA: Create New Call Recording Criteria

Figure 2:

4. Call Recording Criteria Parameters

Table 1:

<Call Recording Criteria name>	0-23 characters	Unique Call Recording Criteria name;
calledPartyId	0-9 digits	<called party number> – The called party number for which the call is recorded. (default = NULL)
callingPartyId	0-9 digits	<calling party number> – The calling party number for which the call is recorded. (default = NULL)
criteriaState	N/A	The administrative state of this Call Recording Criteria is: disable (default) enable
egressTgId	N/A	Egress trunk group Id. The call terminating to this trunk group is recorded. EgSipTrunk – Egress SIP trunk group Id. ingSipTrunk – Ingress SIP trunk group Id.
ingressTgId	N/A	Ingress trunk group Id. The call originating from this trunk group is recorded. EgSipTrunk – Egress SIP trunk group Id. ingSipTrunk – Ingress SIP trunk group Id.
nextHopIP	IPv4/IPv6 format	<IP address> – IP address of the next hop. (default - 0.0.0.0)
numberOfCalls	0-99999	The number of calls to occur to stop the recording criteria. (default = 5) NOTE: This attribute displays when recordingStopCriteria = numOfCalls. NOTE: This parameter is not supported for SIPrec.
previousHopIP	IPv4/IPv6 format	<IP address> – IP address of the previous hop. (default = 0.0.0.0)
recorderType	N/A	Call recorder type. SIPRec mct (default)
recordingDuration	0-3600	Duration of the recording, in seconds. (default = 0) NOTE: This parameter is only available if recorderType = mct.
recordingStopCriteria	N/A	Recording stop criteria. manual (default) numOfCalls (not applicable to SIPrec)
recordingType	N/A	Call legs to record. allLegs (default) bothLegs egressLeg ingressLeg NOTE: recordingType is not taken into account when more than one SRS group is associated with the srs cluster, because the SBC is coded to send the first two streams to ingress and the next two to egress.
srsGroupCluster	N/A	<srs group cluster ID> – SRS Group Cluster name.
srsGroupProfile	N/A	<SRS Group Profile name> – SRS Group Profile name to associate with this Call Recording Criteria.

5. Create a SIPREC Group

set global servers srsGroupProfile SIPREC_GROUP_1 description SIPREC_GROUP_1
set global servers srsGroupProfile SIPREC_GROUP_1 loadDistribution sequence
set global servers srsGroupProfile SIPREC_GROUP_1 numSimultaneousStream 1
set global servers srsGroupProfile SIPREC_GROUP_1 srsGroupData 0 transport tcp
set global servers srsGroupProfile SIPREC_GROUP_1 srsGroupData 0 ipAddress 3.80.14.106
set global servers srsGroupProfile SIPREC_GROUP_1 srsGroupData 0 ipPort 5060
set global servers srsGroupProfile SIPREC_GROUP_1 srsGroupData 0 ipTGId SIPREC_1
set global servers srsGroupProfile SIPREC_GROUP_1 srsGroupData 0 srtp disable
commit

Note

The option cryptoSuiteProfile is visible only when the flag srtp is enabled.

5. CLI

set global servers srsGroupProfile <profile name>
description <0-199 characters>
loadDistribution <roundRobin | sequence>
numSimultaneousStream <1-2>
srsGroupData <0-7>
cryptoSuiteProfile <cryptoSuiteProfile>
ipAddress <IP address>
ipPort <IP port>
ipTGId <IP TG Id>
srtp <disable | enable>
transport <tcp | tls | udp>

6. EMA : Enabling SRTP

Figure 3:

6. SRS Group Profile Parameters

Table 2:

<profile name>	0-23 characters	SRS Group Profile name.
description	0-199 characters	<custom text> – Descriptive text about this SRS Group Profile.
loadDistribution	N/A	The load distribution scheme for this SRS Group Profile. roundRobin sequence (default)
numSimultaneousStream	1-2	The number of simultaneous media streams for this SRS Group Profile. (default = 1)
srsGroupData	0-7	<Index> – The index number for this SRS group data configuration. The SBC supports up to eight SRS group data configurations. cryptoSuiteProfile –The unique identifier for the crypto suite profile. If cryptoSuiteProfile is configured, the encryption technique towards SRS utilizes the crypto suite of the SBC (crypto suite of CS is discarded). If cryptoSuiteProfile is not configured in the SBC, the encryption technique towards SRS utilizes the negotiated crypto suite details of the respective CS tap leg (ingress tap leg/egress tap leg). Note: The cryptoSuiteProfile is configured only under profile security and can be attached to the srsGroupData. ipAddress – Signaling IP address of this SRS (The values "0.0.0.0" or "0::0" are not allowed). ipPort – TCP/UDP port for this SRS. ipTGId – IP TG Id used to initiate the session towards the SRS. srtp – Specifies whether the SRTP is enabled for the SRS or not. transport – The transport type for this SRS. tcp tls udp (default)

7. Create a SIPREC Cluster

set global servers srsGroupCluster SIPREC_CLUSTER_1 description SIPREC_CLUSTER_1
set global servers srsGroupCluster SIPREC_CLUSTER_1 srsGroupClusterData 0 srsGroupId SIPREC_GROUP_1
commit

8. CLI

set global servers srsGroupCluster <unique srsGroupCluster name>
description <0-199 characters>
srsGroupClusterData <0-3>
srsGroupId <SRS Group Profile name>

7. EMA

Figure 4:

7. Command Parameters for srsGroupCluster

Table 3:

srsGroupCluster	1-256	<srsGroupCluster name> – Enter the SRS Group Cluster name.
description	0-199 characters	<custom text> – Enter descriptive text about this SRS Group Cluster.
srsGroupClusterData	0-3	Data rows for the SRS Group Cluster.
srsGroupId	N/A	SRS Group Profile to associate with this cluster.

Check status of the calls recorded

To view the details of the calls being recorded from CLI or EMA.

1. CLI Method

Note

If only the GCID value is mentioned in the stopRecord, all the multiple recordings for that GCID are stopped at once.

show table global SipRecStatus
                                                                   RECORDING
GCID    RECORDER ADDRESS   RX RTP ADDRESS      TX RTP ADDRESS      LEG
------------------------------------------------------------------------------
1       10.54.80.200:5070  10.54.80.200:13471  10.54.80.200:13467  ingress
131072  10.54.80.200:5070  10.54.80.200:13471  10.54.80.200:13467  ingress
[ok]

1. EMA Method

On the SBC main screen, navigate to All > Global > SIP rec Status

Figure 5:

Support

For any support related queries about this guide, please contact your local Ribbon representative, or use the details below:

Sales and Support: 1-833-742-2661
Other Queries: 1-877-412-8867
Website: https://ribboncommunications.com/services/ribbon-support-portal

References

For detailed information about Ribbon products & solutions, please visit: https://ribboncommunications.com/products

Conclusion

All features and capabilities tested are detailed within this document - any limitations, notes or observations are also recorded in order to provide the reader with an accurate understanding of what has been covered, and what has not.

Configuration guidance is provided to enable the reader to replicate the same base setup - there may be additional configuration changes required to suit the exact deployment environment.

Page tree

Table of Contents

Interoperable Vendors

Copyright

Document Overview

Scope/Non-Goals

Audience

Prerequisites

Product and Device Details

Network Topology

Deployment Topology

Installing Ribbon SBC SWe Core

Ribbon SBC Standalone

Ribbon SBC High Availability

Configurations for Ribbon SBC SWe Core

Profiles Creation

SIPREC Routing objects

Enabling SIP Recording

Check status of the calls recorded

Support

References

Conclusion