Guia de início rápido: procurar informações do operador para um número de telefone usando os Serviços de Comunicação do Azure

Comece a usar a biblioteca de cliente de Números de Telefone para JavaScript para procurar informações do operador para números de telefone, que podem ser usadas para determinar se e como se comunicar com esse número de telefone. Siga estas etapas para instalar o pacote e procurar informações do operador sobre um número de telefone.

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
• Node.js versões LTS ativo (suporte a longo prazo) e LTS de manutenção (8.11.1 e 10.14.1 recomendado).
• Um recurso ativo dos Serviços de Comunicação e uma cadeia de conexão. Crie um recurso de Serviços de Comunicação.

Verificação de pré-requisitos

Em um terminal ou janela de comando, execute o node --version comando para verificar se Node.js está instalado.

Configuração

Para configurar um ambiente para enviar consultas de pesquisa, siga as etapas nas seções a seguir.

Criar um novo aplicativo Node.js

Em um terminal ou janela de comando, crie um novo diretório para seu aplicativo e navegue até ele.

mkdir number-lookup-quickstart && cd number-lookup-quickstart

Execute npm init -y para criar um arquivo package.json com as configurações padrão.

npm init -y

Crie um arquivo chamado number-lookup-quickstart.js na raiz do diretório que você criou. Adicione o seguinte trecho a ele:

async function main() {
    // quickstart code will go here
}

main();

Instalar o pacote

Use o npm install comando para instalar a biblioteca de cliente Números de Telefone dos Serviços de Comunicação do Azure para JavaScript.

npm install @azure/communication-phone-numbers@1.3.0-beta.4 --save

A --save opção adiciona a biblioteca como uma dependência em seu arquivo package.json .

Exemplos de código

Autenticar o cliente

Importe o PhoneNumbersClient da biblioteca do cliente e instancie-o com sua cadeia de conexão, que pode ser adquirida de um recurso dos Serviços de Comunicação do Azure no portal do Azure. Recomenda-se o uso de uma COMMUNICATION_SERVICES_CONNECTION_STRING variável de ambiente para evitar colocar a cadeia de conexão em texto sem formatação dentro do código. Saiba como gerir a cadeia de ligação do seu recurso.

Adicione o seguinte código à parte superior do number-lookup-quickstart.js:

const { PhoneNumbersClient } = require('@azure/communication-phone-numbers');

// This code retrieves your connection string from an environment variable
const connectionString = process.env['COMMUNICATION_SERVICES_CONNECTION_STRING'];

// Instantiate the phone numbers client
const phoneNumbersClient = new PhoneNumbersClient(connectionString);

Procurar formatação de número de telefone

Para procurar as informações do operador de um número de telefone, ligue searchOperatorInformation para o PhoneNumbersClient.

let formattingResults = await phoneNumbersClient.searchOperatorInformation([ "<target-phone-number>" ]);

Substitua <target-phone-number> pelo número de telefone que você está procurando, geralmente um número para o qual você gostaria de enviar uma mensagem.

Procurar informações do operador para obter um número

Para procurar as informações do operador de um número de telefone, ligue searchOperatorInformation a PhoneNumbersClientpartir do , passando true pela includeAdditionalOperatorDetails opção.

let searchResults = await phoneNumbersClient.searchOperatorInformation([ "<target-phone-number>" ], { "includeAdditionalOperatorDetails": true });

Usar informações do operador

Agora você pode usar as informações do operador. Para este guia de início rápido, podemos imprimir alguns dos detalhes no console.

Primeiro, podemos imprimir detalhes sobre o formato do número.

let formatInfo = formattingResults.values[0];
console.log(formatInfo.phoneNumber + " is formatted " + formatInfo.internationalFormat + " internationally, and " + formatInfo.nationalFormat + " nationally");

Em seguida, podemos imprimir detalhes sobre o número de telefone e operadora.

let operatorInfo = searchResults.values[0];
console.log(operatorInfo.phoneNumber + " is a " + (operatorInfo.numberType ? operatorInfo.numberType : "unknown") + " number, operated in "
    + operatorInfo.isoCountryCode + " by " + (operatorInfo.operatorDetails.name ? operatorInfo.operatorDetails.name : "an unknown operator"));

Você também pode usar as informações do operador para determinar se deseja enviar um SMS. Para obter mais informações sobre como enviar um SMS, consulte o Guia de início rápido do SMS.

Executar o código

Execute o aplicativo a partir do seu terminal ou janela de comando com o node comando.

node number-lookup-quickstart.js

Código de exemplo

Você pode baixar o aplicativo de exemplo do GitHub).

Comece a usar a biblioteca de cliente de Números de Telefone para C# para procurar informações do operador para números de telefone, que podem ser usadas para determinar se e como se comunicar com esse número de telefone. Siga estas etapas para instalar o pacote e procurar informações do operador sobre um número de telefone.

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
• A versão mais recente da biblioteca de cliente .NET Core para seu sistema operacional.
• Um recurso ativo dos Serviços de Comunicação e uma cadeia de conexão. Crie um recurso de Serviços de Comunicação.

Verificação de pré-requisitos

Em um terminal ou janela de comando, execute o dotnet comando para verificar se o SDK do .NET está instalado.

Configuração

Para configurar um ambiente para enviar consultas de pesquisa, siga as etapas nas seções a seguir.

Criar um novo aplicativo C#

Em um terminal ou janela de comando, execute o dotnet new comando para criar um novo aplicativo de console com o nome NumberLookupQuickstart. Este comando cria um projeto C# "Hello World" simples com um único arquivo de origem, Program.cs.

dotnet new console -o NumberLookupQuickstart

Altere seu diretório para a pasta do aplicativo recém-criada e use o dotnet build comando para compilar seu aplicativo.

cd NumberLookupQuickstart
dotnet build

Conectar-se ao feed de pacotes de desenvolvimento

A versão de visualização pública do SDK é publicada em um feed de pacote de desenvolvimento. Você pode adicionar o feed de desenvolvimento usando a CLI do NuGet, que o adiciona ao arquivo NuGet.Config.

nuget sources add -Name "Azure SDK for .NET Dev Feed" -Source "https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json"

Informações mais detalhadas e outras opções para se conectar ao feed de desenvolvimento podem ser encontradas no guia de contribuição.

Instalar o pacote

Enquanto ainda estiver no diretório do aplicativo, instale a biblioteca de cliente PhoneNumbers dos Serviços de Comunicação do Azure para o pacote .NET usando o comando a seguir.

dotnet add package Azure.Communication.PhoneNumbers --version 1.3.0-beta.5

Adicione uma using diretiva à parte superior do Program.cs para incluir o Azure.Communication namespace.

using System;
using System.Threading.Tasks;
using Azure.Communication.PhoneNumbers;

Atualize Main a assinatura da função para ser assíncrona.

internal class Program
{
    static async Task Main(string[] args)
    {
        ...
    }
}

Exemplos de código

Autenticar o cliente

Os clientes de Número de Telefone podem ser autenticados usando a cadeia de conexão adquirida de um recurso dos Serviços de Comunicação do Azure no portal do Azure. Recomenda-se o uso de uma COMMUNICATION_SERVICES_CONNECTION_STRING variável de ambiente para evitar colocar a cadeia de conexão em texto sem formatação dentro do código. Saiba como gerir a cadeia de ligação do seu recurso.

// This code retrieves your connection string from an environment variable.
string? connectionString = Environment.GetEnvironmentVariable("COMMUNICATION_SERVICES_CONNECTION_STRING");

PhoneNumbersClient client = new PhoneNumbersClient(connectionString, new PhoneNumbersClientOptions(PhoneNumbersClientOptions.ServiceVersion.V2024_03_01_Preview));

Os clientes de número de telefone também podem se autenticar com a autenticação do Microsoft Entra. Com essa opção, AZURE_CLIENT_SECRET, AZURE_CLIENT_IDe AZURE_TENANT_ID as variáveis de ambiente precisam ser configuradas para autenticação.

// Get an endpoint to our Azure Communication Services resource.
Uri endpoint = new Uri("<endpoint_url>");
TokenCredential tokenCredential = new DefaultAzureCredential();
client = new PhoneNumbersClient(endpoint, tokenCredential);

Procurar formatação de número de telefone

Para procurar um número na formatação nacional e internacional, ligue SearchOperatorInformationAsync para o PhoneNumbersClient.

OperatorInformationResult formattingResult = await client.SearchOperatorInformationAsync(new[] { "<target-phone-number>" });

Substitua <target-phone-number> pelo número de telefone que você está procurando, geralmente um número para o qual você gostaria de enviar uma mensagem.

Procurar informações do operador para obter um número

Para procurar as informações do operador de um número de telefone, ligue SearchOperatorInformationAsync a PhoneNumbersClientpartir do , passando true pela IncludeAdditionalOperatorDetails opção.

OperatorInformationResult searchResult = await client.SearchOperatorInformationAsync(new[] { "<target-phone-number>" }, new OperatorInformationOptions() { IncludeAdditionalOperatorDetails = true });

Usar informações do operador

Agora você pode usar as informações do operador. Para este guia de início rápido, podemos imprimir alguns dos detalhes no console.

Primeiro, podemos imprimir detalhes sobre o formato do número.

OperatorInformation formattingInfo = formattingResult.Values[0];
Console.WriteLine($"{formattingInfo.PhoneNumber} is formatted {formattingInfo.InternationalFormat} internationally, and {formattingInfo.NationalFormat} nationally");

Em seguida, podemos imprimir detalhes sobre o número de telefone e operadora.

OperatorInformation operatorInformation = searchResult.Values[0];
Console.WriteLine($"{operatorInformation.PhoneNumber} is a {operatorInformation.NumberType ?? "unknown"} number, operated in {operatorInformation.IsoCountryCode} by {operatorInformation.OperatorDetails.Name ?? "an unknown operator"}");

Você também pode usar as informações do operador para determinar se deseja enviar um SMS. Para obter mais informações sobre como enviar um SMS, consulte o Guia de início rápido do SMS.

Executar o código

Execute o aplicativo a partir do seu terminal ou janela de comando com o dotnet run comando.

dotnet run --interactive

Código de exemplo

Pode transferir a aplicação de exemplo do GitHub.

Comece a usar a biblioteca de cliente de Números de Telefone para Java para procurar informações do operador para números de telefone, que podem ser usados para determinar se e como se comunicar com esse número de telefone. Siga estas etapas para instalar o pacote e procurar informações do operador sobre um número de telefone.

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
• Java Development Kit (JDK) versão 8 ou superior.
• Apache Maven.
• Um recurso ativo dos Serviços de Comunicação e uma cadeia de conexão. Crie um recurso de Serviços de Comunicação.

Verificação de pré-requisitos

Em um terminal ou janela de comando, execute o comando para verificar se o mvn -v Maven está instalado.

Configuração

Para configurar um ambiente para enviar consultas de pesquisa, siga as etapas nas seções a seguir.

Criar uma nova aplicação Java

Em um terminal ou janela de comando, navegue até o diretório onde você gostaria de criar seu aplicativo Java. Execute o seguinte comando para gerar o projeto Java a partir do modelo maven-archetype-quickstart.

mvn archetype:generate -DgroupId=com.communication.lookup.quickstart -DartifactId=communication-lookup-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

A tarefa 'gerar' cria um diretório com o mesmo nome do artifactId. Neste diretório, o diretório src/main/java contém o código-fonte do projeto, o src/test/java directory contém a fonte de teste e o pom.xml arquivo é o Project Object Model ou POM do projeto.

Conectar-se ao feed de pacotes de desenvolvimento

A versão de visualização pública do SDK é publicada em um feed de pacote de desenvolvimento. Para se conectar ao feed de desenvolvimento, abra o arquivo de pom.xml no editor de texto e adicione o repositório de <repositories> desenvolvimento aos pom.xml e <distributionManagement> às seções que você pode adicionar se ainda não existirem.

<repository>
  <id>azure-sdk-for-java</id>
  <url>https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-java/maven/v1</url>
  <releases>
    <enabled>true</enabled>
  </releases>
  <snapshots>
    <enabled>true</enabled>
  </snapshots>
</repository>

Talvez seja necessário adicionar ou editar o settings.xml arquivo em ${user.home}/.m2

<server>
  <id>azure-sdk-for-java</id>
  <username>azure-sdk</username>
  <password>[PERSONAL_ACCESS_TOKEN]</password>
</server>

Você pode gerar um Token de Acesso Pessoal com Empacotamento , ler e escrever escopos e colá-lo na <password> tag.

Informações mais detalhadas e outras opções para se conectar ao feed de desenvolvimento podem ser encontradas aqui.

Instalar o pacote

Adicione os seguintes elementos de dependência ao grupo de dependências no arquivo pom.xml .

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-common</artifactId>
    <version>1.0.0</version>
  </dependency>

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-phonenumbers</artifactId>
    <version>1.2.0-beta.3</version>
  </dependency>

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-identity</artifactId>
    <version>1.2.3</version>
  </dependency>

  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-core</artifactId>
    <version>1.41.0</version>
  </dependency>
</dependencies>

Verifique a properties seção para garantir que seu projeto esteja direcionado ao Maven versão 1.8 ou superior.

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>1.8</maven.compiler.source>
  <maven.compiler.target>1.8</maven.compiler.target>
</properties>

Exemplos de código

Configurar a estrutura do aplicativo

No diretório do projeto:

1. Navegue até o diretório /src/main/java/com/communication/lookup/quickstart
2. Abra o arquivo App.java no editor
3. Substitua a System.out.println("Hello world!"); instrução
4. Adicionar import diretivas

Use o seguinte código para começar:

package com.communication.lookup.quickstart;

import com.azure.communication.phonenumbers.*;
import com.azure.communication.phonenumbers.models.*;
import com.azure.core.http.rest.*;
import com.azure.core.util.Context;
import com.azure.identity.*;
import java.io.*;
import java.util.ArrayList;

public class App
{
    public static void main( String[] args ) throws IOException
    {
        System.out.println("Azure Communication Services - Number Lookup Quickstart");
        // Quickstart code goes here
    }
}

Autenticar o cliente

O cliente pode ser autenticado usando uma cadeia de conexão adquirida de um recurso dos Serviços de Comunicação do Azure no portal do Azure. Recomenda-se o uso de uma COMMUNICATION_SERVICES_CONNECTION_STRING variável de ambiente para evitar colocar a cadeia de conexão em texto sem formatação dentro do código. Saiba como gerir a cadeia de ligação do seu recurso.

// This code retrieves your connection string from an environment variable
String connectionString = System.getenv("COMMUNICATION_SERVICES_CONNECTION_STRING");

PhoneNumbersClient phoneNumberClient = new PhoneNumbersClientBuilder()
    .connectionString(connectionString)
    .buildClient();

Como alternativa, você pode autenticar usando a autenticação do Microsoft Entra. Usar o é a maneira mais fácil de começar a usar o DefaultAzureCredentialBuilder Microsoft Entra ID. Você pode adquirir seu nome de recurso de um recurso dos Serviços de Comunicação do Azure no portal do Azure.

// You can find your resource name from your resource in the Azure portal
String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";

PhoneNumbersClient phoneNumberClient = new PhoneNumbersClientBuilder()
    .endpoint(endpoint)
    .credential(new DefaultAzureCredentialBuilder().build())
    .buildClient();

Procurar formatação de número de telefone

Para procurar um número na formatação nacional e internacional, ligue searchOperatorInformation para o PhoneNumbersClient.

ArrayList<String> phoneNumbers = new ArrayList<String>();
phoneNumbers.add("<target-phone-number>");

// Use the free number lookup functionality to get number formatting information
OperatorInformationResult formattingResult = phoneNumberClient.searchOperatorInformation(phoneNumbers);
OperatorInformation formattingInfo = formattingResult.getValues().get(0);

Substitua <target-phone-number> pelo número de telefone que você está procurando, geralmente um número para o qual você gostaria de enviar uma mensagem.

Procurar informações do operador para obter um número

Para procurar as informações do operador de um número de telefone, ligue searchOperatorInformationWithResponse a PhoneNumbersClientpartir do , passando true pela IncludeAdditionalOperatorDetails opção.

OperatorInformationOptions options = new OperatorInformationOptions();
options.setIncludeAdditionalOperatorDetails(true);
Response<OperatorInformationResult> result = phoneNumberClient.searchOperatorInformationWithResponse(phoneNumbers, options, Context.NONE);
OperatorInformation operatorInfo = result.getValue().getValues().get(0);

Usar informações do operador

Agora você pode usar as informações do operador. Para este guia de início rápido, podemos imprimir alguns dos detalhes no console.

Primeiro, podemos imprimir detalhes sobre o formato do número.

System.out.println(formattingInfo.getPhoneNumber() + " is formatted "
    + formattingInfo.getInternationalFormat() + " internationally, and "
    + formattingInfo.getNationalFormat() + " nationally");

Em seguida, podemos imprimir detalhes sobre o número de telefone e operadora.

String numberType = operatorInfo.getNumberType() == null ? "unknown" : operatorInfo.getNumberType().toString();
String operatorName = "an unknown operator";
if (operatorInfo.getOperatorDetails()!= null && operatorInfo.getOperatorDetails().getName() != null)
{
    operatorName = operatorInfo.getOperatorDetails().getName();
}
System.out.println(operatorInfo.getPhoneNumber() + " is a " + numberType + " number, operated in "
    + operatorInfo.getIsoCountryCode() + " by " + operatorName);

Você também pode usar as informações do operador para determinar se deseja enviar um SMS. Para obter mais informações sobre como enviar um SMS, consulte o Guia de início rápido do SMS.

Executar o código

Execute o aplicativo a partir do seu terminal ou janela de comando com os seguintes comandos: Navegue até o diretório que contém o arquivo pom.xml e compile o projeto.

mvn compile

Em seguida, compile o pacote.

mvn package

Para executar o aplicativo, use o mvn comando.

mvn exec:java -D"exec.mainClass"="com.communication.lookup.quickstart.App" -D"exec.cleanupDaemonThreads"="false"

Código de exemplo

Pode transferir a aplicação de exemplo do GitHub.

Comece com a biblioteca de cliente de números de telefone para Python para procurar informações do operador para números de telefone, que podem ser usados para determinar se e como se comunicar com esse número de telefone. Siga estas etapas para instalar o pacote e procurar informações do operador sobre um número de telefone.

Pré-requisitos

• Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
• Python 3.7+.
• Um recurso ativo dos Serviços de Comunicação e uma cadeia de conexão. Crie um recurso de Serviços de Comunicação.

Verificação de pré-requisitos

Em um terminal ou janela de comando, execute o comando para verificar se o python --version Python está instalado.

Configuração

Para configurar um ambiente para enviar consultas de pesquisa, siga as etapas nas seções a seguir.

Criar uma aplicação Python nova

Em um terminal ou janela de comando, crie um novo diretório para seu aplicativo e navegue até ele.

mkdir number-lookup-quickstart && cd number-lookup-quickstart

Use um editor de texto para criar um arquivo chamado number_lookup_sample.py no diretório raiz do projeto e adicione o código a seguir. O código de início rápido restante é adicionado nas seções a seguir.

import os
from azure.communication.phonenumbers import PhoneNumbersClient

try:
   print('Azure Communication Services - Number Lookup Quickstart')
   # Quickstart code goes here
except Exception as ex:
   print('Exception:')
   print(ex)

Instalar o pacote

Enquanto ainda estiver no diretório do aplicativo, instale a biblioteca de cliente PhoneNumbers dos Serviços de Comunicação do Azure para o pacote Python usando o pip install comando.

pip install azure-communication-phonenumbers==1.2.0b2

Exemplos de código

Autenticar o cliente

O cliente pode ser autenticado usando uma cadeia de conexão adquirida de um recurso dos Serviços de Comunicação do Azure no portal do Azure. Recomenda-se o uso de uma COMMUNICATION_SERVICES_CONNECTION_STRING variável de ambiente para evitar colocar a cadeia de conexão em texto sem formatação dentro do código. Saiba como gerir a cadeia de ligação do seu recurso.

# This code retrieves your connection string from an environment variable
connection_string = os.getenv('COMMUNICATION_SERVICES_CONNECTION_STRING')
try:
    phone_numbers_client = PhoneNumbersClient.from_connection_string(connection_string)
except Exception as ex:
    print('Exception:')
    print(ex)

Como alternativa, o cliente pode ser autenticado usando a autenticação do Microsoft Entra. Usar o objeto é a maneira mais fácil de começar a usar o DefaultAzureCredential Microsoft Entra ID e você pode instalá-lo usando o pip install comando.

pip install azure-identity

Criar um DefaultAzureCredential objeto requer que você tenha AZURE_CLIENT_ID, AZURE_CLIENT_SECRETe AZURE_TENANT_ID já definido como variáveis de ambiente com seus valores correspondentes do seu aplicativo Microsoft Entra registrado.

Para obter um aumento sobre como obter essas variáveis de ambiente, você pode aprender a configurar entidades de serviço da CLI.

Depois que a azure-identity biblioteca estiver instalada, você poderá continuar autenticando o cliente.

from azure.identity import DefaultAzureCredential

# You can find your endpoint from your resource in the Azure portal
endpoint = 'https://<RESOURCE_NAME>.communication.azure.com'
try:
    credential = DefaultAzureCredential()
    phone_numbers_client = PhoneNumbersClient(endpoint, credential)
except Exception as ex:
    print('Exception:')
    print(ex)

Procurar formatação de número de telefone

Para procurar um número na formatação nacional e internacional, ligue search_operator_information para o PhoneNumbersClient.

formatting_results = phone_numbers_client.search_operator_information("<target-phone-number>")

Substitua <target-phone-number> pelo número de telefone que você está procurando, geralmente um número para o qual você gostaria de enviar uma mensagem.

Procurar informações do operador para obter um número

Para procurar as informações do operador de um número de telefone, ligue search_operator_information a PhoneNumbersClientpartir do , passando True pela include_additional_operator_details opção.

options = { "include_additional_operator_details": True }
operator_results = phone_numbers_client.search_operator_information("<target-phone-number>", options)

Usar informações do operador

Agora você pode usar as informações do operador. Para este guia de início rápido, podemos imprimir alguns dos detalhes no console.

Primeiro, podemos imprimir detalhes sobre o formato do número.

formatting_info = formatting_results.values[0]
print(str.format("{0} is formatted {1} internationally, and {2} nationally", formatting_info.phone_number, formatting_info.international_format, formatting_info.national_format))

Em seguida, podemos imprimir detalhes sobre o número de telefone e operadora.

operator_information = operator_results.values[0]

number_type = operator_information.number_type if operator_information.number_type else "unknown"
if operator_information.operator_details is None or operator_information.operator_details.name is None:
    operator_name = "an unknown operator"
else:
    operator_name = operator_information.operator_details.name

print(str.format("{0} is a {1} number, operated in {2} by {3}", operator_information.phone_number, number_type, operator_information.iso_country_code, operator_name))

Você também pode usar as informações do operador para determinar se deseja enviar um SMS. Para obter mais informações sobre como enviar um SMS, consulte o Guia de início rápido do SMS.

Executar o código

Execute o aplicativo a partir do seu terminal ou janela de comando com o python comando.

python number_lookup_sample.py

Código de exemplo

Pode transferir a aplicação de exemplo do GitHub.