Skip to content

Commit 5bacfbc

Browse files
Merge pull request #246599 from rcdun/remove_api_bridge
Remove API Bridge and API mediation; clarify NMP instructions
2 parents cbf7b45 + 20957f6 commit 5bacfbc

File tree

9 files changed

+27
-34
lines changed

9 files changed

+27
-34
lines changed

articles/communications-gateway/emergency-calling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Microsoft Teams always sends location information on SIP INVITEs for emergency c
2626
- When Microsoft Teams clients make an emergency call, they obtain their physical location based on their network location.
2727
- Static locations that you assign to numbers.
2828
- The Operator Connect API allows you to associate numbers with locations that enterprise administrators have already configured in the Microsoft Teams Admin Center as part of uploading numbers.
29-
- Azure Communications Gateway's API Bridge Number Management Portal also allows you to associate numbers with locations during upload. You can also manage the locations associated with numbers after the numbers have been uploaded.
29+
- Azure Communications Gateway's Number Management Portal also allows you to associate numbers with locations during upload. You can also manage the locations associated with numbers after the numbers have been uploaded.
3030
- Static locations that your enterprise customers assign. When you upload numbers, you can choose whether enterprise administrators can modify the location information associated with each number.
3131

3232
> [!NOTE]

articles/communications-gateway/manage-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Manage an enterprise in Azure Communications Gateway's Number Management Portal
3-
description: Learn how to manage enterprises and numbers for Operator Connect and Teams Phone Mobile with Azure Communication Gateway's API Bridge Number Management Portal.
3+
description: Learn how to manage enterprises and numbers for Operator Connect and Teams Phone Mobile with Azure Communication Gateway's Number Management Portal.
44
author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
-187 Bytes
Loading

articles/communications-gateway/overview.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -59,30 +59,21 @@ Azure Communications Gateway's voice features include:
5959

6060
## API features
6161

62-
Azure Communications Gateway includes optional API integration features. These features can help you to:
62+
Azure Communications Gateway includes optional API integration features. These features can help you to speed up your rollout and monetization of Teams Calling support.
6363

64-
- Adapt your existing systems to meet the requirements of the Operator Connect and Teams Phone Mobile programs with minimal disruption.
65-
- Provide a consistent look and feel across your Operator Connect and Teams Phone Mobile offerings and the rest of your portfolio.
66-
- Speed up your rollout and monetization of Teams Calling support.
67-
68-
### CallDuration upload
69-
70-
Azure Communications Gateway can use the Operator Connect APIs to upload information about the duration of individual calls into the Microsoft Teams environment. This allows Microsoft Teams clients to display the call duration recorded by your network, instead of the call duration recorded by Microsoft Teams. Providing this information to Microsoft Teams is a requirement of the Operator Connect program that Azure Communications Gateway performs on your behalf.
71-
72-
### API Bridge Number Management Portal
64+
### Number Management Portal
7365

7466
Operator Connect and Teams Phone Mobile require API integration between your IT systems and Microsoft Teams for flow-through provisioning and automation. After your deployment has been certified and launched, you must not use the Operator Connect portal for provisioning. You can use Azure Communications Gateway's Number Management Portal instead. This Azure portal feature enables you to pass the certification process and sell Operator Connect or Teams Phone Mobile services while you carry out a custom API integration project.
7567

7668
The Number Management Portal is available as part of the optional API Bridge feature.
7769

7870
> [!TIP]
79-
> The API Bridge Number Management Portal does not allow your enterprise customers to manage Teams Calling. For example, it does not provide self-service portals.
71+
> The Number Management Portal does not allow your enterprise customers to manage Teams Calling. For example, it does not provide self-service portals.
8072
81-
### API mediation
73+
### CallDuration upload
8274

83-
Azure Communications Gateway's API Bridge feature includes a flexible custom interface to the Operator Connect APIs. Microsoft Professional Services can create REST or SOAP APIs that adapt the Teams Operator Connect API to your networks' requirements for APIs. These custom APIs can reduce the size of an IT integration project by reducing the changes required in your existing infrastructure.
75+
Azure Communications Gateway can use the Operator Connect APIs to upload information about the duration of individual calls into the Microsoft Teams environment. This allows Microsoft Teams clients to display the call duration recorded by your network, instead of the call duration recorded by Microsoft Teams. Providing this information to Microsoft Teams is a requirement of the Operator Connect program that Azure Communications Gateway performs on your behalf.
8476

85-
The API mediation function is designed to map between CRM and BSS systems in your network and the Teams Operator Connect API. Your CRM and BSS systems must be able to handle the information required by Teams Operator Connect. You must work with Microsoft to determine whether you can use the API mediation feature and to scope the project.
8677

8778
## Next steps
8879

articles/communications-gateway/plan-and-manage-costs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For example, if you have 28,000 users assigned to the deployment each month you'
4040
> [!TIP]
4141
> If you receive a quote through Microsoft Volume Licensing, pricing may be presented as aggregated so that the values are easily readable (for example showing the per-user meters in groups of 10 or 100 rather than the pricing for individual users). This does not impact the way you will be billed.
4242
43-
If you choose to deploy the API Bridge (for API mediation or the API Bridge Number Management Portal), you'll also be charged for your API Bridge usage. Fees for API Bridge work in the same way as the SBC User meters: a service availability meter and a per-user meter. The number of users charged for the API Bridge is always the same as the number of users charged on the SBC User meters.
43+
If you choose to deploy the Number Management Portal by selecting the API Bridge option, you'll also be charged for the Number Management Portal. Fees work in the same way as the SBC User meters: a service availability meter and a per-user meter. The number of users charged for the Number Management Portal is always the same as the number of users charged on the SBC User meters.
4444

4545
> [!NOTE]
4646
> A user is any telephone number that meets all the following criteria.

articles/communications-gateway/prepare-for-live-traffic.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In this article, you learn about the steps you and your onboarding team must tak
3333

3434
## Methods
3535

36-
In some parts of this article, the steps you must take depend on whether your deployment includes the API Bridge. This article provides instructions for both types of deployment. Choose the appropriate instructions.
36+
In some parts of this article, the steps you must take depend on whether your deployment includes the Number Management Portal. This article provides instructions for both types of deployment. Choose the appropriate instructions.
3737

3838
## 1. Connect Azure Communications Gateway to your networks
3939

@@ -96,19 +96,21 @@ Your onboarding team must register the test enterprise tenant that you chose in
9696
1. Select your company in the list of operators, fill in the form and select **Add as my operator**.
9797
1. In your test tenant, create some test users (if you don't already have suitable users). These users must be licensed for Teams Phone System and in Teams Only mode.
9898
1. Configure emergency locations in your test tenant.
99-
1. Upload numbers in the API Bridge Number Management Portal (if you deployed the API Bridge) or the Operator Connect Operator Portal. Use the Calling Profile that you obtained from your onboarding team.
99+
1. Upload numbers in the Number Management Portal (if you chose to deploy it as part of Azure Communications Gateway) or the Operator Connect Operator Portal. Use the Calling Profile that you obtained from your onboarding team.
100100

101-
# [API Bridge Number Management Portal](#tab/api-bridge)
101+
# [Number Management Portal](#tab/number-management-portal)
102102

103-
1. Open the API Bridge Number Management Portal from your list of Azure resources.
104-
1. Select **Go to Consents**.
103+
1. Sign in to the [Azure portal](https://azure.microsoft.com/).
104+
1. In the search bar at the top of the page, search for your Communications Gateway resource.
105+
1. Select your Communications Gateway resource.
106+
1. On the overview page, select **Consents** in the sidebar.
105107
1. Select your test tenant.
106108
1. From the menu, select **Update Relationship Status**. Set the status to **Agreement signed**.
107109
1. From the menu, select **Manage Numbers**.
108110
1. Select **Upload numbers**.
109111
1. Fill in the fields as required, and then select **Review + upload** and **Upload**.
110112

111-
# [Operator Portal](#tab/no-api-bridge)
113+
# [Operator Portal](#tab/no-number-management-portal)
112114

113115
1. Open the Operator Portal.
114116
1. Select **Customer Consents**.
@@ -183,13 +185,13 @@ Your staff can use a selection of key metrics to monitor Azure Communications Ga
183185

184186
Your onboarding team must provide Microsoft with proof that you have integrated with the Microsoft Teams Operator Connect API for provisioning.
185187

186-
# [API Bridge](#tab/api-bridge)
188+
# [Number Management Portal](#tab/number-management-portal)
187189

188-
If you have the API Bridge, your onboarding team can obtain proof automatically. You don't need to do anything.
190+
If you have the Number Management Portal, your onboarding team can obtain proof automatically. You don't need to do anything.
189191

190-
# [Without the API Bridge](#tab/no-api-bridge)
192+
# [Without the Number Management Portal](#tab/no-number-management-portal)
191193

192-
If you don't have the API Bridge, you must provide your onboarding team with proof that you have made successful API calls for:
194+
If you don't have the Number Management Portal, you must provide your onboarding team with proof that you have made successful API calls for:
193195

194196
- Partner consent
195197
- TN Upload to Account

articles/communications-gateway/provision-user-roles.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This article will guide you through how to configure the permissions required fo
1515
- Deploy Azure Communications Gateway through the portal
1616
- Raise customer support requests (support tickets)
1717
- Monitor Azure Communications Gateway
18-
- Use the API Bridge Number Management Portal for provisioning
18+
- Use the Number Management Portal for provisioning
1919

2020
## Prerequisites
2121

@@ -32,7 +32,7 @@ Your staff might need different user roles, depending on the tasks they need to
3232
| Deploying Azure Communications Gateway |**Contributor** access to your subscription|
3333
| Raising support requests |**Owner**, **Contributor** or **Support Request Contributor** access to your subscription or a custom role with `Microsoft.Support/*` access at the subscription level|
3434
|Monitoring logs and metrics | **Reader** access to your subscription|
35-
|Using the API Bridge Number Management Portal| [!INCLUDE [project-synergy-nmp-permissions](includes/communications-gateway-nmp-project-synergy-permissions.md)] permissions for the Project Synergy enterprise application and **Reader** permissions to the Azure portal for your subscription|
35+
|Using the Number Management Portal| [!INCLUDE [project-synergy-nmp-permissions](includes/communications-gateway-nmp-project-synergy-permissions.md)] permissions for the Project Synergy enterprise application and **Reader** permissions to the Azure portal for your subscription|
3636

3737
## 2. Configure user roles
3838

@@ -44,12 +44,12 @@ You need to use the Azure portal to configure user roles.
4444
- Know who needs access.
4545
- Know the appropriate user role or roles to assign them.
4646
- Are signed in with a user that is assigned a role that has role assignments write permission, such as **Owner** or **User Access Administrator** for the subscription.
47-
1. If you're managing access to the API Bridge Number Management Portal, ensure that you're signed in with a user that can change permissions for enterprise applications. For example, you could be a Global Administrator, Cloud Application Administrator or Application Administrator. For more information, see [Assign users and groups to an application](../active-directory/manage-apps/assign-user-or-group-access-portal.md).
47+
1. If you're managing access to the Number Management Portal, ensure that you're signed in with a user that can change permissions for enterprise applications. For example, you could be a Global Administrator, Cloud Application Administrator or Application Administrator. For more information, see [Assign users and groups to an application](../active-directory/manage-apps/assign-user-or-group-access-portal.md).
4848

4949
### 2.2 Assign a user role
5050

5151
1. Follow the steps in [Assign a user role using the Azure portal](../role-based-access-control/role-assignments-portal.md) to assign the permissions you determined in [1. Understand the user roles required for Azure Communications Gateway](#1-understand-the-user-roles-required-for-azure-communications-gateway).
52-
1. If you're managing access to the API Bridge Number Management Portal, follow [Assign users and groups to an application](../active-directory/manage-apps/assign-user-or-group-access-portal.md) to assign [!INCLUDE [project-synergy-nmp-permissions](includes/communications-gateway-nmp-project-synergy-permissions.md)] permissions for each user in the Project Synergy application.
52+
1. If you're managing access to the Number Management Portal, follow [Assign users and groups to an application](../active-directory/manage-apps/assign-user-or-group-access-portal.md) to assign [!INCLUDE [project-synergy-nmp-permissions](includes/communications-gateway-nmp-project-synergy-permissions.md)] permissions for each user in the Project Synergy application.
5353

5454
## Next steps
5555

articles/communications-gateway/reliability-communications-gateway.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The SIP peers in Azure Communications Gateway provide OPTIONS polling to allow y
9898

9999
### Disaster recovery: cross-region failover for management regions
100100

101-
Voice traffic and the API Bridge are unaffected by failures in the management region, because the corresponding Azure resources are hosted in service regions. Users of the API Bridge Number Management Portal might need to sign in again.
101+
Voice traffic and provisioning through the Number Management Portal are unaffected by failures in the management region, because the corresponding Azure resources are hosted in service regions. Users of the Number Management Portal might need to sign in again.
102102

103103
Monitoring services might be temporarily unavailable until service has been restored. If the management region experiences extended downtime, we'll migrate the impacted resources to another available region.
104104

articles/communications-gateway/request-changes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Perform initial troubleshooting to help determine if you should raise an issue w
2020

2121
Raise an issue with Azure Communications Gateway if you experience an issue with:
2222
- SIP and RTP exchanged by Azure Communications Gateway and your network.
23+
- The Number Management Portal.
2324
- Your Azure bill relating to Azure Communications Gateway.
24-
- The API Bridge, including the API Bridge Number Management Portal.
2525

2626
You must have an **Owner**, **Contributor**, or **Support Request Contributor** role in your Azure Communications Gateway subscription, or a custom role with [Microsoft.Support/*](../role-based-access-control/resource-provider-operations.md#microsoftsupport) at the subscription level.
2727

@@ -40,7 +40,7 @@ You must have an **Owner**, **Contributor**, or **Support Request Contributor**
4040
1. A new **Service** option will appear giving you the option to select either **My services** or **All services**. Select **My services**.
4141
1. In **Service type** select **Azure Communications Gateway** from the drop-down menu.
4242
1. A new **Problem type** option will appear. Select the problem type that most accurately describes your issue from the drop-down menu.
43-
* Select **API Bridge Issue** if your API Bridge Number Management Portal is returning errors when you try to gain access or carry out actions.
43+
* Select **API Bridge Issue** if your Number Management Portal is returning errors when you try to gain access or carry out actions.
4444
* Select **Configuration and Setup** if you experience issues during initial provisioning and onboarding, or if you want to change configuration for an existing deployment.
4545
* Select **Monitoring** for issues with metrics and logs.
4646
* Select **Voice Call Issue** if calls aren't connecting, have poor quality, or show unexpected behavior.

0 commit comments

Comments
 (0)