Integração com a API de provisionamento do Azure Communications Gateway (visualização)
Este artigo explica quando você precisa se integrar à API de provisionamento do Azure Communications Gateway (visualização) e fornece uma visão geral de alto nível de introdução. É para desenvolvedores de software que trabalham para operadoras de telecomunicações.
A API de Provisionamento permite configurar o Gateway de Comunicação 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 Operator Connect e Teams Phone Mobile com os detalhes de seus clientes corporativos e os números atribuídos a eles. Esse provisionamento de fluxo permite que você atenda aos requisitos do Operator Connect e do Teams Phone Mobile para usar APIs para gerenciar seus clientes e números depois de iniciar o serviço.
A API de provisionamento é uma API REST.
A integração ou não com a API de provisionamento depende do serviço de comunicações escolhido.
| Serviço de comunicações | Integração de API de provisionamento | Propósito |
|---|---|---|
| Roteamento direto do Microsoft Teams | Suportado (como alternativa ao Portal de Gestão de Números) | - Configuração do subdomínio associado a cada cliente de Roteamento Direto. - Geração de registros DNS específicos para cada cliente (conforme exigido pelo ambiente Microsoft 365). - Indicando que os números estão habilitados para Roteamento Direto. - (Opcional) Configurar um cabeçalho personalizado para mensagens para a sua rede. |
| Conexão do operador | Recomendado | - (Recomendado) Provisionamento de fluxo de clientes do Operator Connect através da interoperação com APIs do Operator Connect (usando sincronização de serviço de back-end). - (Opcional) Configurar um cabeçalho personalizado para mensagens para a sua rede. |
| Telefone do Teams Mobile | Recomendado | - (Recomendado) Provisionamento flow-through de clientes do Teams Phone Mobile através de interoperação com APIs do Operator Connect (usando sincronização de serviço de back-end). |
| Emparelhamento na nuvem do telefone com zoom | Suportado (como alternativa ao Portal de Gestão de Números) | - Indicando que os números estão ativados para o Zoom. - (Opcional) Configurar um cabeçalho personalizado para mensagens para a sua rede. |
Gorjeta
O Portal de Gerenciamento de Números do Azure Communications Gateway fornece 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 do Teams Phone Mobile depois de iniciar o serviço.
Pré-requisitos
Você deve ter concluído Implantar o Azure Communications Gateway.
Você deve ter acesso a uma máquina com um endereço IP que tenha permissão para acessar a API de provisionamento (visualização). Esta lista permitida de endereços IP (ou intervalos) foi configurada como parte da implantação do Azure Communications Gateway.
Saiba mais sobre a API de provisionamento (visualização) e planeje as alterações do seu cliente BSS
Para integrar com a API, você precisa criar (ou atualizar) um cliente BSS que possa entrar em contato com a API de provisionamento. A API de provisionamento oferece suporte a um fluxo de autenticação de credenciais de cliente OAuth 2.0 máquina a máquina. Seu cliente autentica e faz chamadas de API autorizadas como ele mesmo, sem a interação dos usuários.
Use as informações Conceitos-chave e Exemplos na Referência da API para saber mais sobre os recursos disponíveis na API e as solicitações que sua organização precisa fazer.
- Recursos de conta são descrições de clientes da operadora (normalmente, uma empresa) e configurações por cliente para provisionamento de serviços.
- Os recursos numéricos pertencem a uma conta. Eles descrevem números, os serviços que os números usam (por exemplo, o Roteamento Direto do Microsoft Teams) e qualquer configuração extra por número.
- Os recursos de solicitação de informações (RFI) são descrições de clientes da operadora (normalmente uma empresa) que manifestaram interesse em receber o serviço da operadora por meio do Operator Connect e do Teams Phone Mobile.
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.
Configurar seu cliente BSS para se conectar ao Azure Communications Gateway
A API de Provisionamento (visualização) está disponível na porta 443 do provapi.<base-domain>, onde <base-domain> é o domínio base do recurso do Azure Communications Gateway.
Gorjeta
Para encontrar o domínio base:
- Inicie sessão no portal do Azure.
- Navegue até Visão geral do recurso do Azure Communications Gateway e selecione Propriedades.
- Localize o campo chamado Domínio.
O registo DNS tem um tempo de vida (TTL) de 60 segundos. Quando uma região falha, o Azure atualiza o registro DNS para fazer referência a outra região, para que os clientes que fazem uma nova pesquisa de DNS recebam os detalhes da nova região. Recomendamos garantir que os clientes possam fazer uma nova pesquisa de DNS e repetir uma solicitação 60 segundos após um tempo limite ou uma resposta 5xx.
Use a seção Introdução da Referência de 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 de que você precisa. Consulte a seção Introdução da Referência da API para obter detalhes completos, incluindo os valores de configuração necessários.
- Registre seu cliente BSS no mesmo locatário do Azure que sua implantação do Azure Communications Gateway. Esse processo cria um registro de aplicativo.
- Atribua-se como proprietário para o registro do aplicativo.
- Configure o registro do aplicativo com os escopos definidos na Referência da 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.