BYOC-P or BYOP-P configuration guide
Before integrating Zoom Phone or Zoom Contact Center with your Session Border Controllers (SBC), it’s essential to plan your BYOC-P/BYOP-P deployment to ensure a smooth and successful implementation. Explore the resources below to learn more.
Requirement for configuring BYOC-P or BYOP-P
- Account owner or admin with privileges
- Zoom Phone license
- Zoom Contact Center license
How to manage new Session Border Controllers
Session Border Controllers enable BYOC-P or BYOP-P (Zoom Phone only) functionality, allowing you to integrate Zoom Phone or Zoom Contact Center with your own carrier or PBX systems. Outbound Zoom calls follow the route group assigned to each controller, while inbound calls are directed to users based on the Direct Inward Dial (DID) or extension numbers mapped to the SIP Group. Follow the steps below to manage Session Border Controllers.
Add a Session Border Controller (SBC)
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then BYOC Configuration.
- To the right of Session Border Controllers, click Manage.
- In the top left, click Add, then enter the following:
- Display Name: Enter a name to identify the controller.
- Description (Optional): Enter a description that explains the controller’s purpose or provides any details that help quickly identify its use.
- Under Protocol, enter the following:
Note: Only TLS is supported and cannot be modified.
- IP Address: Enter the Public IP Address of the SBC and its Port Number.
Note: Zoom will direct traffic to this destination, so ensure the necessary firewall ports are open to allow communication between Zoom and your SBC. - Survivability IP Address (Optional): Enter the Public/Private IP Address and its Port Number.
Note: This option is only applicable to customers who have Zoom Phone Local Survivability enabled.
- To the right of In-Service, click the toggle to enable the feature, to ensure Zoom is allowed to route traffic to the SBC being configured.
- To the right of Settings, select the following:
- Integrate an on-premises PBX (Bring Your Own PBX- Premises) with Zoom: This Zoom Phone option enables integration with an on-premises PBX through the configured SBC. When activated, it allows extension dialing between Zoom and the on-premises PBX over this SBC connection.
Note: This feature is only applicable to Zoom Phone. - Send OPTIONS ping messages to the SBC to monitor connectivity status: Selecting this option enables Zoom to send OPTIONS ping SIP messages to the SBC, allowing health checks to be performed. If a health check fails, traffic is automatically rerouted to another SBC within the route group.
- Include diversion headers in the sip signaling messages for forwarded calls: Selecting this option ensures that a diversion header is included when calls are forwarded from Zoom.
- Include original calling number within the P-Asserted-Identity (PAI) header for forwarded calls: Selecting this option ensures that the original caller’s number is included in the P-Asserted-Identity (PAI) header when calls are forwarded from Zoom.
- Use T.38 protocol for faxing: This Zoom Phone setting enables negotiation of the T.38 codec for fax calls. If disabled, fax calls will use G.711 passthrough only.
Note: This feature is only applicable to Zoom Phone. - Allow REFER support to transfer calls (Zoom Phone only): This Zoom Phone setting ensures that the Zoom infrastructure accepts SIP REFER messages from this SBC. If disabled, any SIP REFER messages will be rejected.
Note: This feature is only applicable to Zoom Phone, but not to Zoom Phone BYOP-P calls.
- Address (Optional): Select the country where this SBC is located.
Note: This information is used to display its position on the dashboard’s global map. - Email (Optional) and Phone Number (Optional): Enter these fields to provide contact information for the SBC to Zoom admins.
- Click Save.
Edit or delete a Session Border Controller (SBC)
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click BYOC Configuration.
- To the right of Session Border Controllers, click Manage.
- On the Session Border Controllers page, under Name, click the name of the SBC.
- Review and edit the various fields mentioned in the Add a Session Border Controller (SBC) section as necessary.
Note: To edit the IP address of an SBC, the SBC must be deleted and then re-added entirely. - Click Save.
- (Optional) To the far right of the name of the SBC, click the more icon
, then Delete to delete the SBC.
How to manage Route Groups
Route groups are used to direct traffic between Zoom data centers and your SBC. Once the SBCs are created, the next step is to create the route groups. This provisions the SBCs within the Zoom infrastructure and enables call routing. Follow these steps to manage route groups.
Note: Route Groups creation may take up to 48 hours to complete.
Add a Route Group
Note: Zoom Phone and Zoom Contact Center customers are requested to use the Common tab for creating Route Groups.
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then BYOC Configuration.
- To the right of Route Groups, click Manage.
- On the Route Groups page, click the Common tab.
- Click Add, then enter the following:
- Display Name: Enter a name to identify the route group.
- Type: Select one of the following types:
- BYOC-P: This option controls how BYOC calls are routed from Zoom to your SBC. When set to BYOC-P, both the calling and called numbers must be formatted in E.164.
- BYOP-P: This option enables extension-based dialing between Zoom Phone and an on-premises PBX through an SBC. When BYOP-P is enabled, a private numbering plan can be used. Only SBCs with BYOP-P selected in the SBC section of the Zoom web portal can be chosen when this option is active.
- Region: Select the region. This option specifies the Zoom data centers where your SBCs’ SIP trunks will terminate. For best performance, choose the region nearest to your SBC.
- Distribution: Select one of the following:
Note: When multiple SBCs are added to a route group, outgoing Zoom calls can be routed either sequentially or using load balancing. In each of the options below, an alternate SBC is selected if the primary SBC meets any of the following conditions: Does not respond to Zoom’s OPTIONS ping; Returns any of these SIP response codes: 404, 408, 480, 488, 500, 502, 503, 504; Fails to respond to an INVITE message within 10 seconds.
- Sequential: When selected, calls are initially routed to the first SBC in the list. If the first SBC does not respond to Zoom’s OPTIONS ping (when enabled) or returns certain SIP codes, Zoom will reroute the call to an alternate SBC if available.
- Load Balancing: When selected, calls are load-balanced according to the proportion assigned to each SBC. The system distributes calls based on each SBC’s proportion relative to the total number of active calls.
- Session Border Controllers: Select the appropriate Session Border Controllers from the list.
- Backup Route Group: Select the appropriate backup route group. Calls from Zoom will be routed through this backup route group if any of the following conditions occur:
- The OPTIONS ping from Zoom to all the SBCs in the route group is not responding.
- All SBCs in the route groups respond with any of the following SIP codes: 404, 408, 480, 488, 500, 502, 503, 504.
- All SBCs in the route group do not respond to an INVITE message for 10 seconds.
- (Optional) On the Route Groups page, click the Zoom Phone tab.
Note: The Zoom Phone tab will only be used in special cases as follows:
- Building trunks to Zoom Phone India data centers.
- Building trunks to Zoom Phone China (Tianjin) data centers.
- PCIPal for Zoom Phone and Zoom Contact Center
- Zoom Contact Center customers using PCIPal with BYOC won't be able to use the same common gateway to connect. Contact your Zoom Sales representative or Zoom Support for more information.
- Click Save.
Edit or delete a Route Group
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click BYOC Configuration.
- To the right of Route Groups, click Manage.
- In the Route Groups page, click the Common tab.
- To the far right of a Display Name, click Edit to edit the various fields mentioned in the Add a Route Group section as necessary.
- Click Save.
- (Optional) To the far right of a Display Name, click the more icon
, then Delete to delete the route group.
How to manage SIP Groups
SIP Groups serve as the connection point linking these entities to the route groups. Any calls originating from or directed to these entities will use the route groups assigned to their SIP Group. SIP Groups also support phased migration of the following:
You can create SIP Groups and migrate to them to take advantage of the Zoom Common Platform. Alternatively, you may update your existing SIP groups to reference the new route groups on the Common Platform, streamlining the transition of outbound calling from Zoom to their SBC. Follow the sections below.
Add a SIP Group
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click BYOC Configuration.
- To the right of SIP Groups, click Manage.
- On the SIP Groups page, click Add, then enter the following:
- Display Name: Enter a name to identify the SIP Group.
- Enable Send SIP Group Name in the SIP header, if calls require a header of X-SIP-GROUP.
- Route Group Source: Select one of the following:
- Route Group: Select the appropriate BYOC or BYOP route groups that were created in the previous steps.
Notes:
- BYOC or BYOP route groups are designated in the dropdown.
- BYOC (also known as BYOC-P) Route Groups are applicable for Zoom Phone and Zoom Contact Center. Calls routed through the BYOC-P route group must be formatted in E.164 format.
- BYOP (also known as BYOP-P) route groups are only applicable to Zoom Phone. Enabling this route group allows customers to route extensions between Zoom Phone and on-premises PBX.
- Description (Optional): Enter a description that explains the SIP group’s purpose or provides any details that help quickly identify its use.
- Repeat the steps above to create as many SIP Groups as necessary.
- Click Save.
Edit or delete a SIP Group
The following steps allow you to update existing SIP Groups to reference the new route groups, removing the need to create new SIP Groups or modify the previously listed entities.
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click BYOC Configuration.
- To the right of SIP Groups, click Manage.
- On the SIP Groups page, to the far right of a Name, click Edit to edit the various fields mentioned in the Add a SIP Group section as necessary.
Note: This page lists all SIP Groups previously created in Zoom Phone. For Zoom Contact Center customers, any SIP Groups preconfigured by Zoom will also appear. The Route Group Source column shows the current routing destination for each SIP Group. - Click Save.
Note: Clicking Save may update the routing for multiple entities simultaneously. It is recommended to perform this action during a maintenance window. - (Optional) To the far right of a Display Name, click the more icon
, then Delete to delete the SIP group.
Assign SIP Groups to phone numbers
SIP groups can be assigned to phone numbers and other entities in Zoom. Assigning a SIP Group to a phone number updates that number’s routing configuration. When a user or device places an outbound call using the number, the call is sent to the SBC defined in the route group selected for that SIP Group.
Note: Phone numbers must be assigned to a Common SIP Group to enable both inbound and outbound calling. Without this assignment, phone numbers cannot place or receive calls to or from the PSTN.
Add new phone numbers to a SIP Group
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click Phone Numbers.
- On the Phone Numbers page, in the top-left corner, click Add Number.
Note: Learn more about Using Number Management for managing phone numbers. - In the drop-down menu, select BYOC Number.
A pop-up window will appear. - In the window, enter the following:
- Product: Select the product where the phone number will be assigned.
Note: Phone numbers can be assigned to either Zoom Phone or Zoom Contact Center, but not both. - Site: Select a site.
Note: If adding Zoom Phone numbers, a site selection is required. For Zoom Contact Center numbers, this selection is not applicable. - Country/Region: Select the country of the phone number being added.
- Numbers: Enter the phone numbers, ideally using E.164 format.
Note: Multiple entries may be separated by commas. - SIP Group (Optional): Select the SIP Group created on the Common Platform to define the routing path for calls to and from these phone numbers.
Note: Zoom Phone may display multiple SIP Groups. Be sure to select only the Common SIP Groups. - Click the checkbox for acknowledgment.
- Click Submit.
Update SIP Groups for existing phone numbers
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click Phone Numbers.
Note: Learn more about Using Number Management for managing phone numbers. - On the Phone Numbers page, in the top-left corner, click Add Number.
- To the right of the Source column, click the filter icon
and select BYOC-Premises to filter BYOC phone numbers. - Click a BYOC phone number that requires a SIP Group update.
- In the Source section, click Edit, and select the SIP Group.
- Click Save.
Bulk-update SIP Groups for existing phone numbers
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Number Management, then click Phone Numbers.
Note: Learn more about Using Number Management for managing phone numbers. - On the Phone Numbers page, in the top-left corner, click Import.
- In the drop-down menu, select BYOC Number.
A pop-up window will appear. - In the window, click the Update BYOC Numbers tab.
- Click CSV Sample, then click Download to download a CSV template to help you upload the phone numbers.
- After filling the CSV file, click Upload CSV and select the modified file to initiate the bulk update process.
Notes:
- Keep the window open to monitor the upload progress.
- You can also export your existing phone numbers to help create the CSV import.
Add a Routing Rule
Routing rules are admin-defined regular expressions used to route digits or digit strings to specific destinations and modify called numbers when needed. By default, Zoom normalizes numbers for a specific country based on the user profile.
Note: Routing rules are needed only when a dial plan requires custom routing. This applies solely to Zoom Phone.
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Phone System Management, then Company Info.
- Click Account Settings.
- Click the Settings tab.
- Under Routing, to the right of the Routing Rules setting, click Manage.
- On the Routing Rules page, in the top-left corner, click Add Routing Rule and select the following:
- Level: Select if the routing rule will apply to all users on the account or only to a subset of users on a site.
Note: Site-level rules take precedence over account-level rules. - Order: Identifies the sequence in which routing rules are evaluated for matching.
Note: Rules are processed in ascending order based on their priority values. - Rule Name: Enter a descriptive name to identify the purpose of the routing rule.
- Number Pattern: Enter the regular expression number pattern that will be matched when the user dials a number. Admins can also click Test to test if a potential call will match the routing rule.
Note: You can click the Number Matching and Translation question mark icon for examples of regular expressions. - Translation (Optional): When necessary, admins may translate called numbers before the call is sent to the routing path. Admins can also click Test to test if a potential call will match the routing rule.
- Routing Path: Select one of the following:
- PSTN: When this option is selected, the call routes through the SIP Group assigned to the user’s phone number.
- SIP Group: Admins can specify whether calls are routed through a SIP Group that has a BYOC-P or BYOP-P Route group assigned. For calls that require routing in E.164 format, a SIP Group with a BYOC-P route group must be selected.
Note: Selecting the BYOC-P route group enables you to route calls through an SBC that differs from the one assigned to the phone numbers in your SIP Group. - Other Sites: You can select this option when calls must be routed to other extensions within your Zoom account.
- Call Forwarding: Click the toggle to allow routing rules to be applied to calls forwarded from the Zoom app or using Call Handling settings.
- Click Save.
Edit or delete a Routing Rule
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the navigation menu, click Phone System Management, then Company Info.
- Click Account Settings.
- Click the Settings tab.
- Under Routing, to the right of the Routing Rules setting, click Manage.
- On the Routing Rules page, to the far right of the rule name, click Edit to edit the various fields mentioned in the Add a Routing Rule section as necessary.
- Click Save.
- (Optional) To the far right of the rule name, click the more icon
, then Delete to delete the routing rule.