Integrar com a API de Provisionamento do Gateway de Comunicações do Azure (versão prévia)
Este artigo explica quando você precisa fazer a integração com a API de Provisionamento do Gateway de Comunicações do Azure (versão prévia) e fornece uma visão geral de alto nível da introdução. É para desenvolvedores de software que trabalham para operadoras de telecomunicações.
A API de Provisionamento permite que você configure o Gateway de Comunicações do Azure com os detalhes de seus clientes e os números que você atribuiu a eles. Se você usar a API de Provisionamento para sincronização de serviços de back-end, também poderá provisionar os ambientes do Conexão do Operador e Telefonia Móvel do Microsoft Teams com os detalhes de seus clientes corporativos e os números que você alocar a eles. Esse provisionamento de fluxo permite que você atenda ao requisito de uso de APIs do Conexão do Operador e da Telefonia móvel do Microsoft Teams para gerenciar seus clientes e números após o lançamento do serviço.
A API de Provisionamento é uma API REST.
A necessidade de integração com a API de provisionamento depende do serviço de comunicação escolhido.
| Serviço de comunicações | Integração da API de Provisionamento | Finalidade |
|---|---|---|
| Roteamento Direto do Microsoft Teams | Com suporte (como alternativa ao Portal de Gerenciamento de Números) | - Configurando o subdomínio associado a cada cliente de Roteamento Direto. - Geração de registros DNS específicos para cada cliente (conforme exigido pelo ambiente do Microsoft 365). - Indicando que os números estão habilitados para Roteamento Direto. - (Opcional) Configurar um cabeçalho personalizado para mensagens na sua rede. |
| Conexão do operador | Recomendado | - (Recomendado) Provisionamento do fluxo de clientes da Conexão do Operador por meio da interoperação com APIs da Conexão do Operador (usando sincronização de serviço de back-end). - (Opcional) Configurar um cabeçalho personalizado para mensagens na sua rede. |
| Telefonia do Teams Móvel | Recomendado | - (Recomendado) Provisionamento do fluxo de clientes de Telefonia móvel do Microsoft Teams por meio da interoperação com as APIs do Conexão do Operador (usando a sincronização de serviços de back-end). |
| Emparelhamento na Nuvem do Zoom Phone | Com suporte (como alternativa ao Portal de Gerenciamento de Números) | - Indicando que os números estão habilitados para o Zoom. - (Opcional) Configurar um cabeçalho personalizado para mensagens na sua rede. |
Dica
O Portal de Gerenciamento de Números do Gateway de Comunicações do Azure fornece uma função equivalente para provisionamento manual. No entanto, você não pode usar o Portal de Gerenciamento de Números para provisionamento completo de fluxo do Operator Connect e Teams Phone Mobile depois de iniciar seu serviço.
Pré-requisitos
Você precisa ter concluído Implantar o Gateway de Comunicações do Azure.
Você deve ter acesso a um computador com um endereço IP que tenha permissão para acessar a API de Provisionamento (versão prévia). Essa lista de permissões de endereços IP (ou intervalos) foi configurada como parte da implantação do Gateway de Comunicações do Azure.
Saiba mais sobre a API de Provisionamento (versão prévia) e planeje suas alterações no cliente BSS
Para integrar-se à API, é necessário criar (ou atualizar) um cliente BSS que possa entrar em contato com a API de Provisionamento. A API de Provisionamento dá suporte a um fluxo de autenticação de credenciais de cliente OAuth 2.0 de máquina para máquina. Seu cliente autentica e faz chamadas à API autorizadas como se fosse ele mesmo, sem a interação dos usuários.
Utilize as informações sobre Principais Conceitos e Exemplos na Referência da API para aprender sobre os recursos disponíveis via API e as solicitações que sua organização precisa fazer.
- Recursos de Conta são descrições de clientes operadores (tipicamente, uma empresa) e configurações específicas por cliente para provisionamento de serviços.
- Recursos de Número pertencentes a uma conta. Eles descrevem os números, os serviços que os números utilizam (por exemplo, Microsoft Teams Direct Routing) e qualquer configuração adicional por número.
- Os recursos de solicitação de informações (RFI) são descrições de clientes operadores (normalmente uma empresa) que manifestaram interesse em receber serviços da operadora por meio do Conexão do Operador e da Telefonia Móvel do Microsoft Teams.
A API de Provisionamento tem um limite de taxa de 100 solicitações por minuto, aplicado em todos os recursos. Uma solicitação em lote para atualizar vários recursos conta como uma solicitação.
Configure seu cliente BSS para se conectar ao Gateway de Comunicações do Azure
A API de Provisionamento (versão prévia) está disponível na porta 443 de provapi.<base-domain>, em que <base-domain> é o domínio base do recurso do Gateway de Comunicações do Azure.
Dica
Para encontrar o domínio base:
- Entre no portal do Azure.
- Navegue até a Visão Geral do seu recurso do Gateway de Comunicações do Azure e selecione Propriedades.
- Encontre o campo denominado Domínio.
O registro DNS tem uma vida útil (TTL) de 60 segundos. Quando uma região falha, o Azure atualiza o registro DNS para se referir a outra região, para que os clientes que fazem uma nova pesquisa DNS recebam os detalhes da nova região. Recomendamos garantir que os clientes possam fazer uma nova pesquisa de DNS e tentar novamente uma solicitação 60 segundos após um tempo limite ou uma resposta 5xx.
Use a seção Introdução da Referência da API para configurar o Azure e seu cliente BSS para permitir que o cliente BSS acesse a API de Provisionamento.
As etapas a seguir resumem a configuração do Azure que você precisa. Consulte a seção Introdução da Referência da API para obter detalhes completos, inclusive os valores de configuração necessários.
- Registre seu cliente BSS no mesmo locatário do Azure que a implantação do Gateway de Comunicações do Azure. Esse processo cria um registro de aplicativo.
- Atribua a si mesmo como proprietário do registro do aplicativo.
- Configure o registro do aplicativo com os escopos definidos na Referência de API. Essa configuração indica ao Azure que seu aplicativo tem permissão para acessar a API de Provisionamento.
- Como administrador do locatário, permita que o aplicativo use as funções de aplicativo que você atribuiu.