© 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.
This document depicts the configuration details for Ribbon's SBC SWe Lite interworking & compliance with Anywhere365 and Microsoft Teams.
The Ribbon Session Border Controller Software Edition Lite (SBC SWe Lite) provides best-in class communications security. The SBC SWe Lite dramatically simplifies the deployment of robust communications security services for SIP Trunking, Direct Routing, and Cloud UC services. SBC SWe Lite operates natively in the Azure and AWS Cloud as well as on virtual machine platforms including Microsoft Hyper-V, VMware and Linux KVM.
Anywhere365 Contact Center and Enterprise Dialogue Management is able to leverage the capabilities of Microsoft Teams to route calls to Teams powered agents with all the rich features of Anywhere365, such as: Call recording, Real-time Translation, IVR, Supervisor, Reporting, Wallboards and many more.
This document provides configuration best practices for deploying Ribbon SBC SWe Lite when connecting with Anywhere365 and Microsoft Teams. 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 will 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.
This is a technical document intended for telecommunications engineers with the purpose of configuring both the Ribbon SBC and the third-party product. Navigating the third-party product as well as the Ribbon Ribbon SBC Edge GUI is required. Understanding the basic concepts of TLS/TCP/UDP, IP/Routing, SIP/RTP and SIP/SRTP is also necessary to complete the configuration and any required troubleshooting.
The following aspects are required before proceeding with the interop:
During this interop, the SIP trunk between Anywhere365 and Ribbon SBC SWe Lite has been configured with TLS and SRTP
The configuration uses the following equipment and software:
The sections in this document follow the sequence below. The reader is advised to complete each section for the successful configuration.
The SBC SWe Lite is available for deployment on VMware. To deploy an SBC SWe Lite instance, refer to https://doc.rbbn.com/display/UXDOC90/Installing+SBC+SWe+Lite+on+VMware+ESXi. Once SWe Lite instance is successfully created on VMware, retrieve the allocated NAT Public IPs, Ethernet IPs and Management IP. For more details, visit the link given in the References section.
Open any browser and enter the SBC IP address.
Click Enter and log in with a valid User ID and Password.
The Ribbon SBC SWe Lite supports five system created logical interfaces (known as Administrative IP, Ethernet 1 IP, Ethernet 2 IP, Ethernet 3 IP, and Ethernet 4 IP). In addition to the system created logical interfaces, the Ribbon SBC SWe Lite supports user-created VLAN logical sub-interfaces.
Ethernet 1 IP, Ethernet 2 IP are used for this interop.
From the Settings tab, navigate to Networking Interfaces > Logical Interfaces.
Ethernet 1 IP
Ethernet 1 IP is assigned an IP address used for transporting all the VOIP media packets (for example, RTP, SRTP) and all protocol packets (for example, SIP, RTCP, TLS). In the default software, Ethernet 1 IP is enabled, and an IPv4 address is acquired through a connected DHCP server or you can assign a static IP as well.
Ethernet 2 IP
Configure this Ethernet 2 interface as follows as per the requirement. This interface will face the Anywhere365 and Microsoft teams interface.
Static routes are used to create communication to remote networks. In a production environment, static routes are mainly configured for routing from a specific network to another network that you can only access through one point or one interface (single path access or default route).
Destination IP
Specifies the destination IP address.
Mask
Specifies the network mask of the destination host or subnet. If the 'Destination IP Address' field and 'Mask' field are both 0.0.0.0, the static route is called the 'default static route'.
Gateway
Specifies the IP address of the next-hop router to use for this static route.
Metric
Specifies the cost of this route, and therefore indirectly specifies the preference of the route. Lower values indicate more preferred routes. The typical value is 1 for most static routes, indicating that static routes are preferred to dynamic routes.
This section describes how to view the status of each license along with a copy of the license keys installed on your SBC. The Feature Licenses panel enables you to verify whether a feature is licensed, along with the number of remaining licenses available for a given feature at run-time.
From the Settings tab, navigate to System > Licensing > Current Licenses.
For more details on Licenses, refer to Ribbon SBC SWe Lite Licenses.
A Trusted CA Certificate is a certificate issued by a trusted certificate authority. Trusted CA Certificates are imported to the SBC SWe Lite to establish its authenticity on the network.
From the Settings tab, navigate to Security > SBC Certificates > Trusted CA Certificates.
This section describes the process of importing Trusted Root CA Certificates, using either the File Upload or Copy and Paste methods.
Follow the steps above to import certificates for this interop.
Anywhere365 certificates: https://sectigo.com/resource-library/sectigo-root-intermediate-certificate-files
For this interop certificates has been downloaded using the link above.
For the root chain, see the following information:
For more details on Certificates, refer to Working with Certificates.
When the Verify Status field in the Certificate panel indicates Expired or Expiring Soon, replace the Trusted CA Certificate. You must delete the old certificate before importing a new certificate successfully.
Most Certificate Vendors sign the SBC Edge certificate with an intermediate certificate authority. There is at least one, but could be several intermediate CAs in the certificate chain. When importing the Trusted Root CA Certificates, import the root CA certificate and all Intermediate CA certificates. Failure to import all certificates in the chain causes the import of the SBC Edge certificate to fail. Refer to Unable To Get Local Issuer Certificate for more information.
This configuration uses web-based Easy Configuration Wizard for quick start provisioning towards the PSTN/carrier network as well as towards Microsoft Teams cloud.
The SBC SWe Lite WebUI provides a built-in Easy Configuration wizard that lets you quickly and easily deploy the SBC for operation with provider endpoints (SIP trunk, ISDN PSTN trunk, or IP PBX trunk) and user endpoints (Microsoft Teams, Microsoft On Premises - Skype for Business/Lync, IP Phones, or ISDN PBX or IP PBX).
As the wizard runs, it directs you through three configuration steps:
Step 1: Set the following parameters to describe the topology for the telephony service provider and user ends of the scenario.
Step 2: Configure the items required for the endpoints selected, fields display based on the endpoint selection in Step 1.
Step 3: The Easy Config validates the final parameters and displays a read-only summary of the configuration that the wizard will apply when you click Finish at Step 3. Before you click Finish, you can return to previous steps to make adjustments to the data summarized.
The wizard displays the following buttons for navigation:
During this interop:
Step 1: Configure SIP trunk along with Microsoft Teams using Multi-legged approach by following the steps below:
Step 2: After selecting the scenario in Step 1, the following template displays. Complete this step by performing the below actions:
Step 3: This step displays a read-only summary of the configuration.
Modify the media list that was created using easy wizard configuration.
Select Settings > Media > Media List > TEAMS: Teams Direct Routing List and remove SILK media profile and apply.
Select Settings > Media > Media List > TEAMS: SIP Trunk List and remove Fax media profile and apply.
This section describes the steps to configure the SBC SWe Lite with TLS/SRTP towards Anywhere365.
Select Settings > Media > Media Profiles.
It is recommended to use a maximum packet time (max pTime) of 20ms for all Voice Codecs.
SDES-SRTP Profiles define a cryptographic context that is used in SRTP negotiation. SDES-SRTP Profiles required for enabling encryption and SRTP are applied to Media Lists. SDES-SRTP Profiles was previously named Media Crypto Profiles.
From the Settings tab, navigate to Media > SDES-SRTP Profiles.
Follow the steps below to complete the configuration:
Media Profiles specify the individual voice and fax compression codecs and their associated settings for inclusion into a Media List. Different codecs provide varying levels of compression, allowing the reduction of bandwidth requirements.
SIP Profiles control how the SBC SWe Lite communicates with SIP devices. The SIP Profile controls important characteristics, such as the following: session timers, SIP header customization, SIP timers, MIME payloads, and option tags
Select Settings > SIP > SIP Profiles.
The TLS profile defines the crypto parameters for the SIP protocol.
Select Settings > Security > TLS Profile. Click the to create a new TLS profile.
Select Settings > SIP > SIP Server Tables
SIP Server Tables contain information about the SIP devices connected to the SBC SWe Lite. The entries in the tables provide information about the IP Addresses, ports, and protocols used to communicate with each server. The table entries also contain links to counters that are useful for troubleshooting.
An OPTIONS message is sent to the server. When this option is selected, additional configuration items are displayed:
Keep Alive Frequency
Specifies how often, in seconds, the SBC Edge queries the server with an OPTIONS message to determine the server's availability. Visible only when SIP Options is selected from the Monitor field. If the server does not respond, the SBC Edge marks the Signaling Group as down. When the server begins to respond to the OPTIONS messages again, it is marked as up. In this case, Keep Alive Frequency is set to 30 seconds.
Recover Frequency
Specifies frequency in seconds to check server to determine whether it has become available. Recovery Frequency is set to 5 seconds for this interop.
Local Username
Local user name of the SBC Edge system. Default entry: Anonymous. Visible only when SIP Options is selected from the Monitor field.
Peer Username
User name of the SIP Server. Visible only when SIP Options is selected from the Monitor field. The user can change Local and Peer Usernames according to their wishes.
Enable OPTIONS if required for the other SIP Server Tables.
The Message Manipulation feature work in concert to modify and add SIP messages. The Message Manipulation examples below are used to save/store the headers and add to the request.
The SMM performs the following actions:
Saves the following headers of the inbound SIP messages.
Select Settings > SIP > Message Manipulation > Message Rule Table
Click the Create Message Rule Table () icon.
Message Manipulation - Create three header rules for the newly created rule table "ANYWHERE HEADERS SAVE"
The SMM performs the following actions:
Adds the following headers to the outbound SIP messages.
Select Settings > SIP > Message Manipulation > Message Rule Table
Click the Create Message Rule Table() icon.
Message Manipulation - Create three header rules for the newly created rule table say "ANYWHERE HEADERS ADD"
Signaling Groups allow grouping telephony channels together for the purposes of routing and shared configuration. They are the entity where calls are routed, as well as the location that the Call Routes are selected.
Select Settings > Signaling Groups
Initially choose Default call Route. Create the Route, as shown in the call Routing section, and then update the call Route to "Anywhere365: From Dialogue Cloud".
- Enable Message Manipulation.
- Click Add/Edit on Inbound Message Manipulation.
- This displays a drop-down list of available message tables. Select an entry and click Apply.
Select Telephony Mapping Tables > Cause Code Reroutes.
Cause code reroute must be used in the call routing table "TEAMS: From SIP Trunk" and "TEAMS: From Microsoft Teams Direct Routing" to reroute call when receiving "408 Request Timeout" response from dialogue cloud.
Select Telephony Mapping Tables > Q.850 to SIP Override Tables.
In order to avoid multiple REFER from TEAMS, choose the "Q.850 to SIP Override Tables" record for transfer reject scenario when we get '486 response' for reject from PSTN. Update the Q.850 to SIP Override Table in "TEAMS: Teams Direct Routing" signaling group.
When using the Easy Config Wizard, we get "TEAMS: United States" record.
In the Sip profile (Anywhere365: Dialogue Cloud Profile), we have "FQDN in From Header" and "FQDN in Contact Header" configured as "SBC Edge FQDN" and "SBC FQDN". As a result, Node level settings need to be configured.
From the System > Node-Level Settings
Signaling Groups allow grouping telephony channels together for the purposes of routing and shared configuration. They are the entity to which calls are routed, as well as the location from which Call Routes are selected.
Update the signaling group which was created using easy wizard configuration.
Settings > Signaling Groups. Click the expand ( ) icon next to the entry.
Settings > Signaling Groups. Click the expand ( ) icon next to the entry.
Transformation Tables facilitate the conversion of names, numbers and other fields when routing a call. They can, for example, convert a public PSTN number into a private extension number, or into a SIP address (URI). Every entry in a Call Routing Table requires a Transformation Table, and they are selected from there. In addition, Transformation tables are configurable as a reusable pool that Action sets can reference.
From the Settings > Call Routing > Transformation.
Each Transformation Table contains a list of entries considered as routing rules to execute on. Each rule is executed in order until the end of the table is reached or when a Mandatory entry fails to execute.
Follow the procedure described below to configure Transformation Tables and the Entries.
Click the Create ( ) icon.
For this interop, the entries are created based on the numbers associated with each endpoint. Users are free to select their own variables or Regular expressions. UCC prime number can be configured.
Admin State:
Enabled - The default state is Enabled.
Match Type:
Optional: Optional entries must match at least one of that Input Field type.
When a call arrives at a Transformation Table, the incoming message contains a number of Informational Elements (IEs). These IEs include important call information such as: Called Address/Number, Called Extension, Calling Name, Redirecting Number and others.
Each Informational Element is processed row by row in the Transformation Table.
Value (Input/Output):
Specifies the value to match against for the selected type. Depending on the type selected, values are free-form or selected from a menu.
For details on Transformation Table Entry configuration, refer to Creating and Modifying Entries to Transformation Tables. For call digit matching and manipulation through the use of regular expressions, refer to Creating Call Routing Logic with Regular Expressions.
The Transformation Tables created for MS Teams and SIP Trunk through Easy Config Wizard are to be modified.
While modifying the transformation table, description and the entries as been modified as required
Call Routing allows carrying of calls between Signaling Groups. Routes are defined by Call Routing Tables, which allow for a flexible configuration that calls carry, and how to translate them.
Select Settings > Call Routing > Call Routing Table.
Call Routing Tables are one of the central connection points of the system, linking Transformation Tables, Message Translations, Cause Code Reroute Tables, Media Lists and the three types of Signaling Groups (ISDN, SIP and CAS).
In the SBC SWe Lite, call routing occurs between Signaling Groups.
In order to route any call to or from a call system connected to the SBC, you must first configure a Signaling Group to represent that device or system. The following list illustrates the hierarchical relationships of the various Telephony routing components of a SBC call system:
Each call routing entry describes how to route the call and also points to a Transformation Table that defines the conversion of names, numbers and other fields when routing a call.
To create an entry:
Set the following fields:
Admin State:
Enabled - Enables the call route entry for routing the call, displays in configuration header as
Route Priority:
Priority of the route from 1 (highest) to 10 (lowest). Higher priority routes are matched against before lower priority routes, regardless of the order of the routes in the table.
Number/Name Transformation Table:
Specifies the Transformation Table to use for this routing entry. This drop-down list is populated from the entries in the Transformation Table.
Destination Signaling Groups:
Specifies the Signaling Groups used as the destination of calls. The first operational Signaling Group from the list is chosen to place the call. Click the Add/Edit button to select the destination signaling group.
Audio Stream Mode:
DSP (default entry): The SBC uses DSP resources for media handling (transcoding), but does not facilitate the capabilities/features between endpoints that are not supported within the SBC (codec/capability mismatch). When the DSP is configured, the Signaling Groups enabled to support DSP are attempted in order.
Media Transcoding:
Enabled: Enable Transcoding on SIP-to-SIP calls.
Route1 details: Number/Name Transformation Table with "To Teams Direct Routing" and Destination Signaling Groups with "TEAMS: Teams Direct Routing".
Route2 details: Number/Name Transformation Table with "To PSTN" and Destination Signaling Groups with "TEAMS: Border Element".
The Call routing Tables created for MS Teams and SIP Trunk through Easy Config Wizard are to be modified.
Route1 details: Number/Name Transformation Table with "To Teams Direct Routing" and Destination Signaling Groups with "Anywhere365: Dialogue Cloud", cause code reroute configured.
Route2 details: Reroute the call based on 408 response to (TEAMS: Teams Direct Routing) signaling group.
Route3 details: Number/Name Transformation Table with "To Dialogue Cloud" and Destination Signaling Groups with "Anywhere365: Dialogue Cloud".
Route1 details: Number/Name Transformation Table "To Teams Direct Routing" and Destination Signaling Groups "TEAMS: Teams Direct Routing".
Route2 details: Number/Name Transformation Table with "To PSTN" and Destination Signaling Groups with "Anywhere365: Dialogue Cloud", cause code reroute configured.
Route3 details: Based on 408 response reroute to (TEAMS: Border Element) signaling group.
For anywhere365 related configurations and queries, please contact the Anywhere365 technical support team.
The following checklist depicts the set of services/features covered through the configuration defined in this Interop Guide.
Sr. No. | Supplementary Services/ Features | Coverage |
---|---|---|
1 | Call Setup and Termination over TLS |
|
2 | Call Transfer (Blind/Unattended/Cold) | |
3 | Call Transfer (consultative/Attended/Warm) | |
4 | Supervisor actions | |
5 | Quality Management using DTMF | |
6 | Call hold and Resume (with MOH enable) | |
7 | Call hold and Resume (without MOH enable) | |
8 | Anonymous Call | |
9 | Long Duration | |
10 | OPTIONS validation | |
11 | DTMF handling | |
12 | Session Audits |
Legend
Supported | |
Not Supported |
Two way audio issue (both sides not audible) has been observed when blind transfer initiated by Teams is rejected from PSTN side. This is a known issue for Ribbon and will be addressed in the upcoming SBC releases.
For any support related queries about this guide, please contact your local Ribbon representative, or use the details below:
For detailed information about Ribbon products and solutions, please visit:
https://ribboncommunications.com/products
For detailed information about Anywhere365 products and solutions, please visit:
https://anywhere365.io/
This Interoperability Guide describe the configuration steps required for Ribbon SBC SWe Lite to successfully interoperate with Anywhere365. All feature and serviceability test cases were completed and passed with the exceptions/observations noted in Test Results.
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 is/is not covered.
Configuration guidance is provided to enable the reader to replicate the same base setup — additional configuration changes are possibly required to suit the exact deployment environment.
© 2021 Ribbon Communications Operating Company, Inc. © 2021 ECI Telecom Ltd. All rights reserved.