Skip to content

Commit 4d71725

Browse files
authored
Merge pull request #266370 from rcdun/preview_nmp_and_api
Document preview Provisioning API and Number Management Portal
2 parents 9d9db0d + 4034b21 commit 4d71725

11 files changed

+264
-171
lines changed

articles/communications-gateway/connect-operator-connect.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: integration
8-
ms.date: 11/27/2023
8+
ms.date: 02/16/2024
99
ms.custom:
1010
- template-how-to-pattern
1111
- has-azure-ad-ps-ref
@@ -27,17 +27,20 @@ You must [deploy Azure Communications Gateway](deploy.md).
2727
You must have access to a user account with the Microsoft Entra Global Administrator role.
2828

2929
You must allocate six "service verification" test numbers for each of Operator Connect and Teams Phone Mobile. These numbers are used by the Operator Connect and Teams Phone Mobile programs for continuous call testing.
30+
3031
- If you selected the service you're setting up as part of deploying Azure Communications Gateway, you've allocated numbers for the service already.
3132
- Otherwise, choose the phone numbers now (in E.164 format and including the country code) and names to identify them. We recommend names of the form OC1 and OC2 (for Operator Connect) and TPM1 and TPM2 (for Teams Phone Mobile).
3233

3334
You must also allocate at least one test number for each service for integration testing.
3435

3536
If you want to set up Teams Phone Mobile and you didn't select it when you deployed Azure Communications Gateway, choose:
37+
3638
- The number used in Teams Phone Mobile to access the Voicemail Interactive Voice Response (IVR) from native dialers.
37-
- How you plan to route Teams Phone Mobile calls to Microsoft Phone System. Choose from:
38-
- Integrated MCP (MCP in Azure Communications Gateway).
39-
- On-premises MCP.
40-
- Another method to route calls.
39+
- The method for routing Teams Phone Mobile calls to Microsoft Phone System. Choose from:
40+
41+
- Integrated MCP (MCP in Azure Communications Gateway).
42+
- On-premises MCP.
43+
- Another method to route calls.
4144

4245
## Enable Operator Connect or Teams Phone Mobile support
4346

@@ -46,9 +49,9 @@ If you want to set up Teams Phone Mobile and you didn't select it when you deplo
4649
4750
1. Sign in to the [Azure portal](https://azure.microsoft.com/).
4851
1. In the search bar at the top of the page, search for your Communications Gateway resource and select it.
49-
1. In the side menu bar, find **Communications services** and select **Operator Connect** or **Teams Phone Mobile** (as appropriate) to open a page for the service.
50-
1. On the service's page, select **Operator Connect settings** or **Teams Phone Mobile settings**.
51-
1. Fill in the fields, selecting **Review + create** and **Create**.
52+
1. In the side menu bar, under **Communications services**, select **Operator Connect** or **Teams Phone Mobile** (as appropriate) to open a page for the service.
53+
1. Select **Operator Connect settings** or **Teams Phone Mobile settings**.
54+
1. Fill in the fields, then select **Review + create** and **Create**.
5255
1. Select the **Overview** page for your resource.
5356
1. Select **Add test lines** and add the service verification lines you chose in [Prerequisites](#prerequisites). Set the **Testing purpose** to **Automated**.
5457
> [!IMPORTANT]
@@ -72,7 +75,7 @@ To add the Project Synergy application:
7275
```azurepowershell
7376
Get-Module -ListAvailable
7477
```
75-
1. If `AzureAD` doesn't appear in the output, install the module:
78+
1. If `AzureAD` doesn't appear in the output, install the module.
7679
1. Close your current PowerShell window.
7780
1. Open PowerShell as an admin.
7881
1. Run the following command.
@@ -136,7 +139,7 @@ Do the following steps in the tenant that contains your Project Synergy applicat
136139
```azurepowershell
137140
Get-Module -ListAvailable
138141
```
139-
1. If `AzureAD` doesn't appear in the output, install the module:
142+
1. If `AzureAD` doesn't appear in the output, install the module.
140143
1. Close your current PowerShell window.
141144
1. Open PowerShell as an admin.
142145
1. Run the following command.

articles/communications-gateway/get-started.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Getting started with Azure Communications Gateway
3-
description: Learn how to plan for and deploy Azure Communications Gateway
3+
description: Learn how to plan for and deploy Azure Communications Gateway.
44
author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: how-to
8-
ms.date: 11/06/2023
8+
ms.date: 02/16/2024
99

1010
#CustomerIntent: As someone setting up Azure Communications Gateway, I want to understand the steps I need to carry out to have live traffic through my deployment.
1111
---
@@ -29,13 +29,13 @@ Read the following articles to learn about Azure Communications Gateway.
2929
- [Onboarding with Included Benefits for Azure Communications Gateway](onboarding.md), to learn about onboarding to Operator Connect or Teams Phone Mobile and the support we can provide.
3030
- [Connectivity for Azure Communications Gateway](connectivity.md) and [Reliability in Azure Communications Gateway](reliability-communications-gateway.md), to create a network design that includes Azure Communications Gateway.
3131
- [Overview of security for Azure Communications Gateway](security.md), to learn about how Azure Communications Gateway keeps customer data and your network secure.
32-
- [Provisioning API for Azure Communications Gateway](provisioning-platform.md), to learn about when you might need or want to integrate with the Provisioning API.
32+
- [Provisioning API (preview) for Azure Communications Gateway](provisioning-platform.md), to learn about when you might need or want to integrate with the Provisioning API.
3333
- [Plan and manage costs for Azure Communications Gateway](plan-and-manage-costs.md), to learn about costs for Azure Communications Gateway.
34-
- [Azure Communications Gateway limits, quotas and restrictions](limits.md), to learn about the limits and quotas associated with the Azure Communications Gateway
34+
- [Azure Communications Gateway limits, quotas and restrictions](limits.md), to learn about the limits and quotas associated with the Azure Communications Gateway.
3535

3636
For Operator Connect and Teams Phone Mobile, also read:
3737

38-
- [Overview of interoperability of Azure Communications Gateway with Operator Connect and Teams Phone Mobile](interoperability-operator-connect.md)
38+
- [Overview of interoperability of Azure Communications Gateway with Operator Connect and Teams Phone Mobile](interoperability-operator-connect.md).
3939
- [Mobile Control Point in Azure Communications Gateway for Teams Phone Mobile](mobile-control-point.md).
4040
- [Emergency calling for Operator Connect and Teams Phone Mobile with Azure Communications Gateway](emergency-calls-operator-connect.md).
4141

@@ -59,10 +59,9 @@ Use the following procedures to deploy Azure Communications Gateway and connect
5959

6060
1. [Prepare to deploy Azure Communications Gateway](prepare-to-deploy.md) describes the steps you need to take before you can start creating your Azure Communications Gateway resource. You might need to refer to some of the articles listed in [Learn about and plan for Azure Communications Gateway](#learn-about-and-plan-for-azure-communications-gateway).
6161
1. [Deploy Azure Communications Gateway](deploy.md) describes how to create your Azure Communications Gateway resource in the Azure portal and connect it to your networks.
62-
1. [Integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md) describes how to integrate with the Provisioning API. Integrating with the API is:
62+
1. [Integrate with Azure Communications Gateway's Provisioning API (preview)](integrate-with-provisioning-api.md) describes how to integrate with the Provisioning API. Integrating with the API is:
6363
- Required for Microsoft Teams Direct Routing and Zoom Phone Cloud Peering.
64-
- Optional for Operator Connect: only required to add custom headers to messages entering your core network.
65-
- Not supported for Teams Phone Mobile.
64+
- Recommended for Operator Connect and Teams Phone Mobile because it enables flow-through API-based provisioning of your customers both on Azure Communications Gateway and in the Operator Connect environment. This enables additional functionality to be provided by Azure Communications Gateway, such as injecting custom SIP headers, while also fulfilling the requirement from the the Operator Connect and Teams Phone Mobile programs for you to use APIs for provisioning customers in the Operator Connect environment. For more information, see [Provisioning and Operator Connect APIs](interoperability-operator-connect.md#provisioning-and-operator-connect-apis).
6665

6766
## Integrate with your chosen communications services
6867

@@ -86,5 +85,5 @@ Use the following procedures to integrate with Zoom Phone Cloud Peering.
8685

8786
## Next steps
8887

89-
- Learn about [your network and Azure Communications Gateway](role-in-network.md)
88+
- Learn about [your network and Azure Communications Gateway](role-in-network.md).
9089
- Find out about [the newest enhancements to Azure Communications Gateway](whats-new.md).

articles/communications-gateway/integrate-with-provisioning-api.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,28 @@ author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: how-to
8-
ms.date: 10/09/2023
8+
ms.date: 02/16/2024
99
---
1010

11-
# Integrate with Azure Communications Gateway's Provisioning API
11+
# Integrate with Azure Communications Gateway's Provisioning API (preview)
1212

13-
This article explains when you need to integrate with Azure Communications Gateway's Provisioning API and provides a high-level overview of getting started. It's aimed at software developers working for telecommunications operators.
13+
This article explains when you need to integrate with Azure Communications Gateway's Provisioning API (preview) and provides a high-level overview of getting started. It's aimed at software developers working for telecommunications operators.
1414

15-
The Provisioning API allows you to configure Azure Communications Gateway with the details of your customers and the numbers that you have assigned to them. It's a REST API.
15+
The Provisioning API allows you to configure Azure Communications Gateway with the details of your customers and the numbers that you have assigned to them. If you use the Provisioning API for *backend service sync*, you can also provision the Operator Connect and Teams Phone Mobile environments with the details of your enterprise customers and the numbers that you allocate to them. This flow-through provisioning allows you to meet the Operator Connect and Teams Phone Mobile requirement to use APIs to manage your customers and numbers after you launch your service.
16+
17+
The Provisioning API is a REST API.
1618

1719
Whether you need to integrate with the REST API depends on your chosen communications service.
1820

1921
|Communications service |Provisioning API integration |Purpose |
2022
|---------|---------|---------|
21-
|Microsoft Teams Direct Routing |Required |- Configure the subdomain associated with each Direct Routing customer<br>- Generate DNS records specific to each customer (as required by the Microsoft 365 environment)<br>- Indicate that numbers are enabled for Direct Routing.<br>- (Optional) Configure a custom header for messages to your network|
22-
|Operator Connect|Optional|(Optional) Configure a custom header for messages to your network|
23-
|Teams Phone Mobile|Not supported|N/A|
24-
|Zoom Phone Cloud Peering |Required |- Indicate that numbers are enabled for Zoom<br>- (Optional) Configure a custom header for messages to your network|
23+
|Microsoft Teams Direct Routing |Required |- Configuring the subdomain associated with each Direct Routing customer.<br>- Generating DNS records specific to each customer (as required by the Microsoft 365 environment).<br>- Indicating that numbers are enabled for Direct Routing.<br>- (Optional) Configuring a custom header for messages to your network.|
24+
|Operator Connect|Recommended|- (Recommended) Flow-through provisioning of Operator Connect customers through interoperation with Operator Connect APIs (using backend service sync). <br>- (Optional) Configuring a custom header for messages to your network. |
25+
|Teams Phone Mobile|Recommended|- (Recommended) Flow-through provisioning of Teams Phone Mobile customers through interoperation with Operator Connect APIs (using backend service sync). <br>- (Optional) Configuring a custom header for messages to your network. |
26+
|Zoom Phone Cloud Peering |Required |- Indicating that numbers are enabled for Zoom. <br>- (Optional) Configuring a custom header for messages to your network.|
27+
28+
> [!TIP]
29+
> You can also use the Number Management Portal (preview) for Operator Connect and Teams Phone Mobile.
2530
2631
## Prerequisites
2732

@@ -37,6 +42,7 @@ Use the *Key concepts* and *Examples* information in the [API Reference](/rest/a
3742

3843
- *Account* resources are descriptions of operator customers (typically, an enterprise), and per-customer settings for service provisioning.
3944
- *Number* resources belong to an account. They describe numbers, the services that the numbers make use of (for example, Microsoft Teams Direct Routing), and any extra per-number configuration.
45+
- *Request for Information (RFI)* resources are descriptions of operator customers (typically an enterprise) who have expressed interest in receiving service from the operator through Operator Connect and Teams Phone Mobile.
4046

4147
[!INCLUDE [limits on the Provisioning API](includes/communications-gateway-provisioning-api-restrictions.md)]
4248

articles/communications-gateway/interoperability-operator-connect.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Overview of Operator Connect and Teams Phone Mobile with Azure Communications Gateway
3-
description: Understand how Azure Communications Gateway fits into your fixed and mobile networks and into the Operator Connect and Teams Phone Mobile environments
3+
description: Understand how Azure Communications Gateway fits into your fixed and mobile networks and into the Operator Connect and Teams Phone Mobile environments.
44
author: rcdun
55
ms.author: rdunstan
66
ms.service: communications-gateway
77
ms.topic: conceptual
8-
ms.date: 01/31/2024
8+
ms.date: 02/16/2024
99
ms.custom: template-concept
1010
---
1111

@@ -91,14 +91,17 @@ Azure Communications Gateway offers multiple media interworking options. For exa
9191

9292
For full details of the media interworking features available in Azure Communications Gateway, raise a support request.
9393

94-
## Number Management Portal for provisioning with Operator Connect APIs
94+
## Provisioning and Operator Connect APIs
9595

96-
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.
96+
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 is certified and launched, you must not use a portal for provisioning. Azure Communications Gateway offers an alternative method for provisioning subscribers with its Provisioning API (preview) that allows flow-through provisioning from your BSS clients to Azure Communications Gateway and the Operator Connect environments. Azure Communications Gateway also provides a Number Management Portal (preview), integrated into the Azure portal, for browser-based provisioning which can be used to get you started while you complete API integration.
9797

98-
For more information, see [Manage an enterprise with Azure Communications Gateway's Number Management Portal for Operator Connect and Teams Phone Mobile](manage-enterprise-operator-connect.md).
98+
For more information, see:
99+
100+
- [Provisioning API (preview) for Azure Communications Gateway](provisioning-platform.md) and [Integrate with Azure Communications Gateway's Provisioning API](integrate-with-provisioning-api.md).
101+
- [Manage an enterprise with Azure Communications Gateway's Number Management Portal (preview) for Operator Connect and Teams Phone Mobile](manage-enterprise-operator-connect.md).
99102

100103
> [!TIP]
101-
> The Number Management Portal does not allow your enterprise customers to manage Teams Calling. For example, it does not provide self-service portals.
104+
> These methods do not allow your enterprise customers to manage Teams Calling. For example, they do not provide self-service portals.
102105
103106
## Providing call duration data to Microsoft Teams
104107

0 commit comments

Comments
 (0)