In this section:
Overview
The SBC Edge is certified to offer Microsoft Teams Direct Routing services; the SBC Edge can be used to connect any Teams client to:
- A PSTN trunk, whether based on TDM (e.g. PRI, BRI, etc.), CAS, or SIP
- 3rd-party, non-Teams-certified SIP/TDM based PBXs, analog devices, and SIP clients
These instructions detail how to configure the SBC Edge (SBC 1000/2000 and SBC SWe Lite) deployed with a Microsoft partner (sells telephony services delivered to Microsoft Teams) to connect Microsoft Teams Direct Routing services for multiple independent enterprise customers (Tenants). A Tenant is used within the Microsoft environment as a single independent enterprise that has subscribed to Office 365 services; through this Tenant, administrators manage projects, users, and roles. Refer to Configure a Session Border Controller for multiple Tenants for Microsoft partner requirements in support of multiple Tenants.
Network Topology - SBC Edge Deployed in a Microsoft Partner Network to Connect Microsoft Teams Direct Routing for Multiple Tenants
The network diagram below shows an SBC Edge device deployed at the Microsoft partner data center, including communication between:
- Tenants and the enterprise's legacy PBX based clients, and
- Tenants and the PSTN supported by the Microsoft partner.
Ribbon SBC Edge at Microsoft Partner Data Center Supporting Multiple Tenants
Microsoft offer an advanced solution called "Carrier/Derived Trunk" that allows the Partner to control specific parameters on the end-user Tenants (list of codecs, port to use, Media Bypass activation, and such). This advance solution requires the following:
- Requires all the Derived Trunks (used by end customer) being a subdomain of the Carrier Trunk.
- Requires all Derived Trunks (used by end customer) to use Carrier Wild card certificate.
- Requires all the Derived Trunk (used by end customer) being configured with the same PSTN Gateway parameter (Codec, Max Call allowed, Media Bypass, and such).
For more information, refer to: https://docs.microsoft.com/en-us/microsoftteams/direct-routing-sbc-multiple-tenants.
How Call Traffic Routes between the SBC Edge and Microsoft Teams Tenants
The network topology supported are detailed below.
Topology 1 - ITSP Aggregation for all Teams Tenants
This network topology is referred to as "Microsoft Teams Direct Routing Carrier." This topology enables the partner to offer Microsoft Teams external calling capability to the end customer. Usually the partner owns the ITSP contract. For lower cost routing, the partner can choose to have more than one ITSP; routing is then decided based on destination, time of the day, and such.
Routing Summary for ITSP Aggregation
Topology 2 - ITSP Segregation per Teams Tenant
This network topology is referred to as "Teams Direct Routing Bring your Own Trunk." This topology enables the partner to offer the SBC management to the end customer. Usually the end customer owns the ITSP contract; only a specific Tenant can use the associated ITSP.
ITSP Segregation per Teams Tenant
Topology 3 - Teams Tenant Segregation
This network topology splits the inbound Teams traffic. For example, it can be useful to limit the number of sessions allowed per Teams Tenant from the SBC side or use a different certificate per Tenant. This topology requires an SBC configuration that limits the number of Tenants that can be supported on the SBC. Since this implementation requires one signaling port per Tenant, it does not support the Carrier/Derived Trunk capability.
This topology is not detailed in this Best Practice.
Teams Tenant Segregation
Step 1: Install SBC Edge (if required)
These instructions assume the SBC Edge product (SBC SWe Lite, SBC 1000/2000) is installed and running. If the product is not installed, refer to the links below. Installation Requirements On KVM: Installing SBC SWe Lite on KVM Hypervisor
Product Installation SBC SWe Lite SBC 1000 Installing the SBC 1000 Hardware SBC 2000
Step 2: Prerequisites
Microsoft Teams Direct Routing Configuration
Consult the Microsoft documentation for detailed information on Direct Routing interface configuration guidelines, including the RFC standards and the syntax of SIP messages.
SBC Edge Software
Ensure you are running the latest version of SBC software:
- To locate the SBC Edge software current running, refer to: Viewing the Software Version and Hardware ID.
- To download and upgrade a new version of SBC Edge software, refer to: Installing and Commissioning the SBC Edge and SBC SWe Lite.
Obtain IP Address and FQDN
Requirements for configuring the SBC Edge in support of Teams Direct Routing include:
SBC Edge Requirements
| Requirement | How it is Used |
|---|---|
Public IP address of NAT device (must be Static)* Private IP address of the SBC | Required for SBC Behind the NAT deployment. |
| Public IP address of SBC | Required for SBC with Public IP deployment. |
| Public FQDN | The Public FQDN must point to the Public IP Address. |
*NAT translates a public IP address to a Private IP address.
Domain Name
For the SBC Edge to pair with Microsoft Teams, the SBC FQDN domain name must match a name registered in both the Domains and DomainUrlMap fields of the Tenant. Verify the correct domain name is configured for the Tenant as follows:
- On the Microsoft Teams Tenant side, execute Get-CsTenant.
- Review the output.
- Verify that the Domain Name configured is listed in the Domains and DomainUrlMap attributes for the Tenant. If the Domain Name is incorrect or missing, the SBC will not pair with Microsoft Teams.
Users may be from any SIP domain registered for the tenant. For example, you can configure user user@SonusMS01.com with the SBC FQDN name sbc1.hybridvoice.org, as long as both names are registered for the tenant.
Domain Name Examples
| Domain Name* | Use for SBC FQDN? | FQDN Names - Examples |
|---|---|---|
| SonusMS01.com |  | Valid names:
|
hybridvoice.org | | Valid names:
Non-Valid name: sbc1.europe.hybridvoice.org (requires registering domain name europe. hybridvoice.org in “Domains” first) |
*Do not use the *.onmicrosoft.com tenant for the domain name.
Configure Domain Names - Example
Obtain Certificate
Public Certificate
The Certificate must be issued by one of the supported certification authorities (CAs). Wildcard certificates are supported.
Refer to Microsoft documentation for the supported CAs.
- Refer to Domain Name for certificate formats.
Configure and Generate Certificates on the SBC
Warning: Common Encryption Certificate Issues Arise from Missing Root Certificates
- Did you only install the CA-signed SBC certificate, along with the intermediate certificate(s) sent by your issuing CA?
- Did you get the following error message from the SBC?
If so, the likely reason is a missing CA Root Certificate. The SBC does not have any pre-installed CA root X.509 certificates, unlike typical browsers found on your PC. Ensure the entire certificate chain of trust is installed on the SBC, including the root certificate. Acquire the CA root certificate as follows:
- Contact your system administrator or certificate vendor to acquire the root, and any further missing intermediate certificate(s) to provision the entire certificate chain of trust within the SBC;
- Load the root certificate, along with the intermediate and SBC certificates, according to Importing Trusted Root CA Certificates.
NOTE: Root certificates are easily acquired from the certificate authorities. For example, the root certificate for the GoDaddy Class 2 Certification Authority may be found at https://ssl-ccp.godaddy.com/repository?origin=CALLISTO . For more information about root certificates, intermediate certificates, and the SBC server (“leaf”) certificates, refer to this tutorial.
For other certificate-related errors, refer to Common Troubleshooting Issues with Certificates in SBC Edge.
Microsoft Teams Direct Routing allows only TLS connections from the SBC for SIP traffic with a certificate signed by one of the trusted certification authorities.
Request a certificate for the SBC External interface and configure it based on the example using GlobalSign as follows:
- Generate a Certificate Signing Request (CSR) and obtain the certificate from a supported Certification Authority.
- Import the Public CA Root/Intermediate Certificate on the SBC.
- Import the Microsoft CA Certificate on the SBC.
- Import the SBC Certificate.
The certificate is obtained through the Certificate Signing Request (instructions below). The Trusted Root and Intermediary Signing Certificates are obtained from your certification authority.
Step 1: Generate a Certificate Signing Request and obtain the certificate from a supported Certification Authority (CA)
Many CA's do not support a private key with a length of 1024 bits. Validate with your CA requirements and select the appropriate length of the key.
- Access the WebUI.
- Access Settings > Security > SBC Certificates.
Click Generate SBC Edge CSR.
Enter data in the required fields.
Click OK. After the Certificate Signing request finishes generating, copy the result to the clipboard.
Generate Certificate Signing Request
- Use the generated CSR text from the clipboard to obtain the certificate.
Step 2: Deploy the SBC and Root/Intermediate Certificates on the SBC
After receiving the certificates from the certification authority, install the SBC Certificate and Root/Intermediate Certificates as follows:
- Obtain Trusted Root and Intermediary signing certificates from your certification authority.
- Access the WebUI.
- To install Trusted Root Certificates, click Settings > Security > SBC Certificates > Trusted Root Certificates.
- Click Import and select the trusted root certificates.
- To install the SBC certificate, open Settings > Security > SBC Certificates > SBC Primary Certificate.
Validate the certificate is installed correctly.
Validate Certificate
- Click Import and select X.509 Signed Certificate.
Validate the certificate is installed correctly.
Validate Certificate
Firewall Rules
Ribbon recommends the deployment of the SBC Edge product behind a firewall, within the DMZ, regardless of the assignment of a public IP to the SBC in question. Refer to SBC Edge Security Hardening Checklist for more information about the SBC and firewalls.
This section lists the ports, protocols and services for firewalls that are in the path of the SBC connecting to Teams Direct Routing.
Basic Firewall Rules for All Call Flows
Firewall Rules for the SBC with Media Bypass
Wildcard Certificate
Microsoft Teams Direct Routing in support of multiple Tenants requires wildcard certificate support to protect the Microsoft partner's SBC FQDN and Tenant's SBC FQDN (that is, SAN=myMicrosoftPartner.com, SAN=*.myMicrosoftPartner.com). The SBC Edge products fully support wildcard certificates.
SBC Edge Configuration for Microsoft Teams Direct Routing
These instructions assume the SBC Edge has been configured for Microsoft Teams Direct Routing through the Easy Configuration wizard. For details on Easy Configuration, refer to: Working with SBC Easy Configuration.
- For SBC Edge Not configured for Microsoft Teams Routing: If the SBC Edge has not been configured for Microsoft Teams Direct Routing through the Easy Configuration Wizard, configure the SBC Edge per Connect SBC Edge to Microsoft Teams Direct Routing. Once complete, move to Step 3 below.
OR
- For SBC Edge Previously Configured for Microsoft Teams Direct Routing: Move to Step 3.
Step 3: Configure each Tenant
The SBC Easy Configuration wizard configures the SBC Edge for one Tenant; additional Tenants subscribed to Microsoft Office 365 services (Microsoft Teams Direct Routing) must be configured manually with the configuration items below. For documentation purposes, the following terms are used in the configuration examples.
Configuration Used in This Document
| Configuration | Example used in this document |
|---|---|
| SBC FQDN for Microsoft partner | myMicrosoftPartner.com |
| SBC FQDN for Tenant | tenant2.myMicrosoftPartner.com |
| Microsoft description | Microsoft Phone System |
| Tenant Name | Microsoft Phone System Tenant 2 |
Access the WebUI
You must access the SBC Edge's WebUI to configure the items below. To access the WebUI, refer to: Logging into the SBC Edge.
Topology 1 - Configure the SBC for ITSP Aggregation for all Teams Tenants
To implement ITSP Aggregation, the SBC configuration must contain the following:
- Call traffic from the ITSP to Microsoft Teams uses a single SIP Signaling Group to Teams Direct Routing. The destination Tenant is included in the Transformation table; each Microsoft Teams Tenant requires a dedicated Transformation Entry that matches the Microsoft Online PSTN Gateway created on the Microsoft Teams Tenant.
- Call traffic from Microsoft Teams to ITSP uses the default call route to the ITSP.
Multi Tenant Routing on SBC Edge with ITSP Aggregation
Create a Transformation entry for the call from ITSP to the new Tenant
In the SBC, configure a Transformation table entry for Teams Direct Routing (Entry #2 on previous diagram). This entry will match the input of the new end customer number and configure the proper Teams Tenant output.
- In the WebUI, click the Settings tab.
In the left navigation page, access Call Routing > Transformation.
- Select the Transformation Table called From Microsoft Teams: Passthrough (the entry created in the Easy Configuration Wizard).
- Click the (
) icon. Configure the parameters as shown below. Leave all other parameters as default.
Click OK.
Transformation Entry Tenant 2 Configuration - Example
Parameter Example Value Description
To Microsoft Phone System Tenant 2 (example name)
Match Type Optional Input Type
Called Address/Number
Input Value
<Enter Tenant 2 Phone Number > (\+151048512\d{2})
Output Type
SIP: Contact Domain Output Value
tenant2.myMicrosoftPartner.com Transformaton Entry Tenant 2 - Example
Topology 2 - Configure the SBC for ITSP Segregation per Teams Tenant
To implement ITSP Segregation, the SBC configuration must contain the following:
- Call traffic from the ITSP to Microsoft Teams uses the single SIP Signaling Group to Teams Direct Routing. The destination Tenant is used in the Transformation table. Each Microsoft Teams Tenant requires a dedicated Transformation Entry that matches the Microsoft Online PSTN Gateway created on the Microsoft Teams Tenant.
- Call traffic from Microsoft Teams to the SBC Edge is aggregated onto the single SIP Signaling Group for all Tenants. The Call Routing Table associated with this SIP Signaling Group is configured to distribute the traffic to a specific ITSP, based on the original tenant (SIP: R-URI Domain).
Multi Tenant Routing on SBC Edge with ITSP Segregation
The instructions below require that you have created the SIP Signaling Group, SIP Server Table, Call Routing Table, and Transformation Table for the new ITSP. For details, refer to the following:
Create a Transformation entry for the call from ITSP to the new Tenant
- In the WebUI, click the Settings tab.
In the left navigation page, access Call Routing > Transformation.
- Click on the Transformation Table > From SIP Trunk 2: Passthrough (the entry created when you added your ITSP 2 configuration).
- Click the () icon.
Configure the parameters as shown below. Leave all other parameters as default.
Click OK.
Transformation Entry Tenant 2 Configuration - Example
Parameter Example Value Description
From ITSP 2 To Microsoft Phone System Tenant 2 (example name)
Match Type Optional Input Type
Called Address/Number
Input Value
(.*)
Output Type
SIP: Contact Domain Output Value
tenant2.myMicrosoftPartner.com Transformation Entry Tenant 2 - Example
Create a New Transformation Table for the call from the new Tenant to ITSP 2
- In the WebUI, click the Settings tab.
- In the left navigation page, access Call Routing > Transformation.
Click the (
) icon at the top left corner to add a new Transformation Table. Configure the parameters as shown below and click OK. For details on parameter definitions, refer to Creating and Modifying Transformation Tables.
Transformation Table - Example Values
Parameter Example Value Row ID
Assigned by the system
Description
From Microsoft Phone System Tenant 2 To ITSP 2
Create Transformation Table
- From the left navigation pane, click on the Transformation > From Microsoft Phone System Tenant 2 To ITSP 2 (the entry created in the last step).
- Click the () icon.
Configure the parameters as shown below. Leave all other parameters as default.
Click OK.
Transformation Entry Tenant 1 Configuration - Example
Parameter Example Value Description
To ITSP 2 (example name)
Match Type Mandatory Input Type
SIP: R-URI Domain
Input Value
(tenant2.myMicrosoftPartner.com):5061 Output Type
SIP: R-URI Domain Output Value
\1 Transformation Entry Tenant 2 - Example
Add New Routing Table Entry for the Call from the new Tenant to ITSP 2
The Easy Configuration process (used for initial configuration) creates the first connection to Teams Direct Routing. This configuration also creates two Call Routing Tables for transporting calls between the SBC's SIP Trunk and Microsoft Teams:
From SIP Trunk. Calls from SIP Trunk to Teams.
From Microsoft Team. Calls from Teams to SIP Trunk.
For calls to be routed from an individual Tenant to the proper ITSP, an entry must be added to the From Microsoft Teams Routing table (this Routing Table was created as part of Easy Configuration) for each Tenant. Add an entry in the From Microsoft Teams Call Routing table for each Tenant as follows:
- In the WebUI, click the Settings tab.
From the left navigation pane, click on the Call Routing table. Click on the From Microsoft Teams Call Routing Table.
- Click the () icon to add an entry.
Configure the parameters as shown below. Leave all other parameters as default. For details on parameter definitions, refer to Creating and Modifying Entries to Call Routing Tables.
Click OK.
Call Routing Entry - Example Values
Parameter
Example Value
Description
To ITSP 2
Number/Name Transformation Table
From Microsoft Phone System Tenant 2 To ITSP 2
Destination Signaling Groups
ITSP 2 (from the previous steps)
Create Call Routing Entry - Example
Step 4: Confirm SBC Edge Links to Microsoft Teams
For troubleshooting steps, refer to Best Practice - Troubleshoot Issues with Microsoft Teams Direct Routing.
Step 5: Place a Test Call
Place a test call as follows: Access the WebUI. Refer to Logging into the SBC Edge. In the WebUI, click the Diagnostics tab. In the left navigation pane, click Test a Call. Configure the parameters as shown below. Click OK. Place a Test Call - Parameters Parameter Value Destination Number Number assigned to a Teams user. Origination/Calling Number Number assigned to a Local user. Call Routing Table The routing table that handles the call from Microsoft Teams. Test a Call - Configuration Place a Test Call - Example The test call is now complete. For troubleshooting steps, refer to Best Practice - Troubleshoot Issues with Microsoft Teams Direct Routing.
Overview
Content Tools