Schnellstart: Suchen nach Betreiberinformationen für beliebige Telefonnummern mithilfe von Azure Communication Services
Wichtig
Dieses Feature von Azure Communication Services befindet sich derzeit in der Vorschau.
Vorschau-APIs und -SDKs werden ohne Vereinbarung zum Servicelevel bereitgestellt. Es wird empfohlen, diese nicht für Produktionsworkloads zu verwenden. Einige Features werden möglicherweise nicht unterstützt oder bieten nur eingeschränkte Funktionalität.
Weitere Informationen finden Sie in den ergänzenden Nutzungsbestimmungen für Microsoft Azure-Vorschauversionen.
Erste Schritte mit der Telefonnummern-Clientbibliothek für JavaScript zum Abrufen von Betreiberinformationen für Telefonnummern, anhand derer bestimmt werden kann, ob und wie mit dieser Telefonnummer kommuniziert werden soll. Führen Sie diese Schritte aus, um das Paket zu installieren und Betreiberinformationen zu einer Telefonnummer nachzuschlagen.
Hinweis
Den Code für diese Schnellstartanleitung finden Sie auf GitHub.
Voraussetzungen
- Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
- Node.js, Active LTS- (Langzeitsupport) und Maintenance LTS-Versionen (8.11.1 und 10.14.1 empfohlen)
- Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
Prüfen der Voraussetzungen
Führen Sie in einem Terminal oder Befehlsfenster den Befehl node --version
aus, um zu überprüfen, ob Node.js installiert ist.
Einrichten
Zum Einrichten einer Umgebung zum Senden von Suchabfragen müssen Sie die Schritte in den folgenden Abschnitten ausführen.
Erstellen einer neuen Node.js-Anwendung
Erstellen Sie in einem Terminal- oder Befehlsfenster ein neues Verzeichnis für Ihre App, und wechseln Sie zu diesem Verzeichnis.
mkdir number-lookup-quickstart && cd number-lookup-quickstart
Führen Sie npm init -y
aus, um die Datei package.json mit den Standardeinstellungen zu erstellen.
npm init -y
Erstellen Sie eine Datei mit dem Namen number-lookup-quickstart.js im Stamm des von Ihnen erstellten Verzeichnisses. Führen Sie den folgenden Codeausschnitt hinzu:
async function main() {
// quickstart code will go here
}
main();
Installieren des Pakets
Verwenden Sie den Befehl npm install
, um die JavaScript-Clientbibliothek für Telefonnummern von Azure Communication Services zu installieren.
npm install @azure/communication-phone-numbers@1.3.0-beta.4 --save
Mit der Option --save
wird die Bibliothek als Abhängigkeit zu Ihrer Datei package.json hinzugefügt.
Codebeispiele
Authentifizieren des Clients
Importieren Sie den PhoneNumbersClient aus der Clientbibliothek, und instanziieren Sie ihn mit Ihrer Verbindungszeichenfolge, die aus einer Azure Communication Services-Ressource im Azure-Portal abgerufen werden kann. Es wird empfohlen, eine COMMUNICATION_SERVICES_CONNECTION_STRING
-Umgebungsvariable zu verwenden, um zu vermeiden, dass Ihre Verbindungszeichenfolge als Klartext im Code enthalten ist. Informationen zur Verwaltung der Verbindungszeichenfolge Ihrer Ressource.
Fügen Sie den folgenden Code am Anfang von number-lookup-quickstart.js hinzu:
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);
Ermitteln der Telefonnummernformatierung
Um nach den Betreiberinformationen einer Telefonnummer zu suchen, rufen Sie searchOperatorInformation
über den PhoneNumbersClient
auf.
let formattingResults = await phoneNumbersClient.searchOperatorInformation([ "<target-phone-number>" ]);
Ersetzen Sie <target-phone-number>
durch die Telefonnummer, die Sie suchen, in der Regel eine Nummer, an die Sie eine Nachricht senden möchten.
Warnung
Geben Sie Telefonnummern im internationalen Standardformat E.164 an, z. B. +14255550123.
Nachschlagen von Betreiberinformationen für eine Nummer
Um nach den Betreiberinformationen einer Telefonnummer zu suchen, rufen Sie searchOperatorInformation
über den PhoneNumbersClient
auf, und übergeben Sie true
für die includeAdditionalOperatorDetails
-Option.
let searchResults = await phoneNumbersClient.searchOperatorInformation([ "<target-phone-number>" ], { "includeAdditionalOperatorDetails": true });
Warnung
Durch die Verwendung dieser Funktion wird Ihrem Konto eine Gebühr berechnet.
Verwenden von Betreiberinformationen
Sie können jetzt die Betreiberinformationen verwenden. Im Rahmen dieser Schnellstartanleitung können wir einige der Details an der Konsole ausgeben.
Zunächst können wir Details zum Nummernformat ausgeben.
let formatInfo = formattingResults.values[0];
console.log(formatInfo.phoneNumber + " is formatted " + formatInfo.internationalFormat + " internationally, and " + formatInfo.nationalFormat + " nationally");
Als Nächstes können wir Details zur Telefonnummer und zum Betreiber ausgeben.
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"));
Sie können außerdem die Betreiberinformationen verwenden, um zu bestimmen, ob eine SMS gesendet werden soll. Weitere Informationen zum Senden einer SMS finden Sie in der SMS-Schnellstartanleitung.
Ausführen des Codes
Führen Sie die Anwendung über Ihr Terminal oder Befehlsfenster mit dem node
-Befehl aus.
node number-lookup-quickstart.js
Beispielcode
Sie können die Beispiel-App von GitHub herunterladen.
Erste Schritte mit der Telefonnummern-Clientbibliothek für C# zum Nachschlagen von Betreiberinformationen für Telefonnummern, die verwendet werden können, um zu bestimmen, ob und wie Kommunikation mit dieser Telefonnummer erfolgen soll. Führen Sie diese Schritte aus, um das Paket zu installieren und Betreiberinformationen zu einer Telefonnummer nachzuschlagen.
Hinweis
Den Code für diese Schnellstartanleitung finden Sie auf GitHub.
Voraussetzungen
- Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
- Die aktuelle Version der .NET Core-Clientbibliothek für Ihr Betriebssystem.
- Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
Prüfen der Voraussetzungen
Führen Sie in einem Terminal- oder Befehlsfenster den Befehl dotnet
aus, um sich zu vergewissern, dass das ,NET SDK installiert ist.
Einrichten
Zum Einrichten einer Umgebung zum Senden von Suchabfragen müssen Sie die Schritte in den folgenden Abschnitten ausführen.
Erstellen einer neuen C#-Anwendung
Führen Sie in einem Terminal- oder Befehlsfenster den dotnet new
-Befehl aus, um eine neue Konsolen-App mit dem Namen NumberLookupQuickstart
zu erstellen. Dieser Befehl erstellt ein einfaches C#-Projekt vom Typ „Hallo Welt“ mit einer einzelnen Quelldatei, program.cs.
dotnet new console -o NumberLookupQuickstart
Wechseln Sie zum neu erstellten App-Ordner, und verwenden Sie den Befehl dotnet build
, um Ihre Anwendung zu kompilieren.
cd NumberLookupQuickstart
dotnet build
Herstellen einer Verbindung mit dem Dev-Paketfeed
Die Public Preview-Version des SDK wird in einem Dev-Paketfeed veröffentlicht. Sie können den Dev-Feed mithilfe der NuGet CLI in die NuGet.Config-Datei einfügen.
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"
Ausführlichere Informationen und weitere Optionen zum Herstellen einer Verbindung mit dem Dev-Feed finden Sie im Leitfaden für Mitwirkende.
Installieren des Pakets
Installieren Sie im Anwendungsverzeichnis die PhoneNumbers-Clientbibliothek von Azure Communication Services für das .NET-Paket mithilfe des folgenden Befehls.
dotnet add package Azure.Communication.PhoneNumbers --version 1.3.0-beta.5
Fügen Sie am Anfang von Program.cs eine Anweisung vom Typ using
hinzu, um den Namespace Azure.Communication
einzuschließen.
using System;
using System.Threading.Tasks;
using Azure.Communication.PhoneNumbers;
Ändern Sie die Main
-Funktionssignatur in asynchron.
internal class Program
{
static async Task Main(string[] args)
{
...
}
}
Codebeispiele
Authentifizieren des Clients
Telefonnummer-Clients können mithilfe von Verbindungszeichenfolgen authentifiziert werden, die von einer Azure Communication Services-Ressource im Azure-Portal abgerufen werden. Es wird empfohlen, eine COMMUNICATION_SERVICES_CONNECTION_STRING
-Umgebungsvariable zu verwenden, um zu vermeiden, dass Ihre Verbindungszeichenfolge als Klartext im Code enthalten ist. Informationen zur Verwaltung der Verbindungszeichenfolge Ihrer Ressource.
// 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));
Telefonnummernclients können sich auch bei der Microsoft Entra-Authentifizierung authentifizieren. Mit dieser Option müssen die Umgebungsvariablen AZURE_CLIENT_SECRET
, AZURE_CLIENT_ID
und AZURE_TENANT_ID
für die Authentifizierung eingerichtet werden.
// Get an endpoint to our Azure Communication Services resource.
Uri endpoint = new Uri("<endpoint_url>");
TokenCredential tokenCredential = new DefaultAzureCredential();
client = new PhoneNumbersClient(endpoint, tokenCredential);
Ermitteln der Telefonnummernformatierung
Um die nationale und internationale Formatierung für eine Nummer nachzuschlagen, rufen Sie SearchOperatorInformationAsync
aus PhoneNumbersClient
auf.
OperatorInformationResult formattingResult = await client.SearchOperatorInformationAsync(new[] { "<target-phone-number>" });
Ersetzen Sie <target-phone-number>
durch die Telefonnummer, die Sie suchen, in der Regel eine Nummer, an die Sie eine Nachricht senden möchten.
Warnung
Geben Sie Telefonnummern im internationalen Standardformat E.164 an, z. B. +14255550123.
Nachschlagen von Betreiberinformationen für eine Nummer
Um nach den Betreiberinformationen einer Telefonnummer zu suchen, rufen Sie SearchOperatorInformationAsync
über den PhoneNumbersClient
auf, und übergeben Sie true
für die IncludeAdditionalOperatorDetails
-Option.
OperatorInformationResult searchResult = await client.SearchOperatorInformationAsync(new[] { "<target-phone-number>" }, new OperatorInformationOptions() { IncludeAdditionalOperatorDetails = true });
Warnung
Durch die Verwendung dieser Funktion wird Ihrem Konto eine Gebühr berechnet.
Verwenden von Betreiberinformationen
Sie können jetzt die Betreiberinformationen verwenden. Im Rahmen dieser Schnellstartanleitung können wir einige der Details an der Konsole ausgeben.
Zunächst können wir Details zum Nummernformat ausgeben.
OperatorInformation formattingInfo = formattingResult.Values[0];
Console.WriteLine($"{formattingInfo.PhoneNumber} is formatted {formattingInfo.InternationalFormat} internationally, and {formattingInfo.NationalFormat} nationally");
Als Nächstes können wir Details zur Telefonnummer und zum Betreiber ausgeben.
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"}");
Sie können außerdem die Betreiberinformationen verwenden, um zu bestimmen, ob eine SMS gesendet werden soll. Weitere Informationen zum Senden einer SMS finden Sie in der SMS-Schnellstartanleitung.
Ausführen des Codes
Führen Sie die Anwendung über Ihr Terminal oder Befehlsfenster mit dem dotnet run
-Befehl aus.
dotnet run --interactive
Beispielcode
Sie können die Beispiel-App von GitHub herunterladen.
Erste Schritte mit der Telefonnummern-Clientbibliothek für Java zum Abrufen von Betreiberinformationen für Telefonnummern, anhand derer bestimmt werden kann, ob und wie mit dieser Telefonnummer kommuniziert werden soll. Führen Sie diese Schritte aus, um das Paket zu installieren und Betreiberinformationen zu einer Telefonnummer nachzuschlagen.
Hinweis
Den Code für diese Schnellstartanleitung finden Sie auf GitHub.
Voraussetzungen
- Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
- Java Development Kit (JDK), Version 8 oder höher.
- Apache Maven.
- Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
Prüfen der Voraussetzungen
Führen Sie in einem Terminal oder Befehlsfenster den Befehl mvn -v
aus, um zu überprüfen, ob Maven installiert ist.
Einrichten
Zum Einrichten einer Umgebung zum Senden von Suchabfragen müssen Sie die Schritte in den folgenden Abschnitten ausführen.
Erstellen einer neuen Java-Anwendung
Wechseln Sie in einem Terminal- oder Befehlsfenster zu dem Verzeichnis, in dem Sie Ihre Java-Anwendung erstellen möchten. Führen Sie den folgenden Befehl aus, um das Java-Projekt aus der Vorlage „maven-archetype-quickstart“ zu generieren.
mvn archetype:generate -DgroupId=com.communication.lookup.quickstart -DartifactId=communication-lookup-quickstart -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false
Durch die Aufgabe „generate“ wird ein Verzeichnis mit demselben Namen wie artifactId
erstellt. In diesem Verzeichnis enthält das Verzeichnis „src/main/java“ den Quellcode des Projekts. Das Verzeichnis src/test/java directory
enthält die Testquelle, und die Datei pom.xml
ist das Projektobjektmodell (POM) des Projekts.
Herstellen einer Verbindung mit dem Dev-Paketfeed
Die Public Preview-Version des SDK wird in einem Dev-Paketfeed veröffentlicht. Zum Herstellen einer Verbindung mit dem Dev-Feed öffnen Sie die Datei pom.xml in Ihrem Text-Editor und fügen das Dev-Repository in die Abschnitte <repositories>
und <distributionManagement>
Ihrer pom.xml-Datei ein. Sie können die Abschnitte hinzufügen, wenn sie nicht bereits vorhanden sind.
<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>
Möglicherweise müssen Sie die Datei „settings.xml
“ in ${user.home}/.m2
hinzufügen oder bearbeiten.
<server>
<id>azure-sdk-for-java</id>
<username>azure-sdk</username>
<password>[PERSONAL_ACCESS_TOKEN]</password>
</server>
Sie können ein persönliches Zugriffstoken mit Lese- und Schreibbereich für die Paketerstellung generieren und in das <password>
-Tag einfügen.
Ausführlichere Informationen und weitere Optionen zum Herstellen einer Verbindung mit dem Dev-Feed finden Sie hier.
Installieren des Pakets
Fügen Sie der Gruppe der Abhängigkeiten in der Datei pom.xml das folgende Abhängigkeitselement hinzu.
<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>
Überprüfen Sie den Abschnitt „properties
“, um sicherzustellen, dass Ihr Projekt auf Maven Version 1.8 oder höher ausgerichtet ist.
<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>
Codebeispiele
Einrichten des App-Frameworks
Über das Projektverzeichnis:
- Wechseln Sie zum Verzeichnis /src/main/java/com/communication/lookup/quickstart.
- Öffnen Sie die Datei App.java im Editor.
- Ersetzen Sie die Anweisung
System.out.println("Hello world!");
. - Fügen Sie Anweisungen vom Typ
import
hinzu.
Verwenden Sie zum Einstieg den folgenden Code:
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
}
}
Authentifizieren des Clients
Der Client kann auch über eine Verbindungszeichenfolge authentifiziert werden, die aus einer Azure Communication Services-Ressource im Azure-Portal abgerufen wird. Es wird empfohlen, eine COMMUNICATION_SERVICES_CONNECTION_STRING
-Umgebungsvariable zu verwenden, um zu vermeiden, dass Ihre Verbindungszeichenfolge als Klartext im Code enthalten ist. Informationen zur Verwaltung der Verbindungszeichenfolge Ihrer Ressource.
// 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();
Alternativ können Sie sich mit der Microsoft Entra-Authentifizierung authentifizieren. Die Verwendung ist DefaultAzureCredentialBuilder
die einfachste Möglichkeit, mit Microsoft Entra ID zu beginnen. Sie können Ihren Ressourcennamen aus einer Azure Communication Services-Ressource im Azure-Portal abrufen.
// 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();
Ermitteln der Telefonnummernformatierung
Um die nationale und internationale Formatierung für eine Nummer nachzuschlagen, rufen Sie searchOperatorInformation
aus PhoneNumbersClient
auf.
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);
Ersetzen Sie <target-phone-number>
durch die Telefonnummer, die Sie suchen, in der Regel eine Nummer, an die Sie eine Nachricht senden möchten.
Warnung
Geben Sie Telefonnummern im internationalen Standardformat E.164 an, z. B. +14255550123.
Nachschlagen von Betreiberinformationen für eine Nummer
Um nach den Betreiberinformationen einer Telefonnummer zu suchen, rufen Sie searchOperatorInformationWithResponse
über den PhoneNumbersClient
auf, und übergeben Sie true
für die IncludeAdditionalOperatorDetails
-Option.
OperatorInformationOptions options = new OperatorInformationOptions();
options.setIncludeAdditionalOperatorDetails(true);
Response<OperatorInformationResult> result = phoneNumberClient.searchOperatorInformationWithResponse(phoneNumbers, options, Context.NONE);
OperatorInformation operatorInfo = result.getValue().getValues().get(0);
Warnung
Durch die Verwendung dieser Funktion wird Ihrem Konto eine Gebühr berechnet.
Verwenden von Betreiberinformationen
Sie können jetzt die Betreiberinformationen verwenden. Im Rahmen dieser Schnellstartanleitung können wir einige der Details an der Konsole ausgeben.
Zunächst können wir Details zum Nummernformat ausgeben.
System.out.println(formattingInfo.getPhoneNumber() + " is formatted "
+ formattingInfo.getInternationalFormat() + " internationally, and "
+ formattingInfo.getNationalFormat() + " nationally");
Als Nächstes können wir Details zur Telefonnummer und zum Betreiber ausgeben.
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);
Sie können außerdem die Betreiberinformationen verwenden, um zu bestimmen, ob eine SMS gesendet werden soll. Weitere Informationen zum Senden einer SMS finden Sie in der SMS-Schnellstartanleitung.
Ausführen des Codes
Führen Sie die Anwendung über Ihr Terminal oder Befehlsfenster mit den folgenden Befehlen aus: Wechseln Sie zu dem Verzeichnis, das die Datei pom.xml enthält, und kompilieren Sie das Projekt.
mvn compile
Erstellen Sie dann das Paket.
mvn package
Verwenden Sie den Befehl mvn
, um die App auszuführen.
mvn exec:java -D"exec.mainClass"="com.communication.lookup.quickstart.App" -D"exec.cleanupDaemonThreads"="false"
Beispielcode
Sie können die Beispiel-App von GitHub herunterladen.
Erste Schritte mit der Telefonnummern-Clientbibliothek für Python zum Abrufen von Betreiberinformationen für Telefonnummern, anhand derer bestimmt werden kann, ob und wie mit dieser Telefonnummer kommuniziert werden soll. Führen Sie diese Schritte aus, um das Paket zu installieren und Betreiberinformationen zu einer Telefonnummer nachzuschlagen.
Hinweis
Den Code für diese Schnellstartanleitung finden Sie auf GitHub.
Voraussetzungen
- Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
- Python 3.7+.
- Eine aktive Communication Services-Ressource und eine Verbindungszeichenfolge. Erstellen Sie eine Communication Services-Ressource.
Prüfen der Voraussetzungen
Führen Sie in einem Terminal- oder Befehlsfenster den Befehl python --version
aus, um sich zu vergewissern, dass Python installiert ist.
Einrichten
Zum Einrichten einer Umgebung zum Senden von Suchabfragen müssen Sie die Schritte in den folgenden Abschnitten ausführen.
Erstellen einer neuen Python-Anwendung
Erstellen Sie in einem Terminal- oder Befehlsfenster ein neues Verzeichnis für Ihre App, und wechseln Sie zu diesem Verzeichnis.
mkdir number-lookup-quickstart && cd number-lookup-quickstart
Erstellen Sie mithilfe eines Text-Editors im Stammverzeichnis des Projekts eine Datei mit dem Namen „number_lookup_sample.py
“, und fügen Sie den folgenden Code hinzu. Der verbleibende Schnellstartcode wird in den folgenden Abschnitten hinzugefügt.
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)
Installieren des Pakets
Installieren Sie im Anwendungsverzeichnis mithilfe des Befehls pip install
die Azure Communication Services-Clientbibliothek „PhoneNumbers“ für das Python-Paket.
pip install azure-communication-phonenumbers==1.2.0b2
Codebeispiele
Authentifizieren des Clients
Der Client kann auch über eine Verbindungszeichenfolge authentifiziert werden, die aus einer Azure Communication Services-Ressource im Azure-Portal abgerufen wird. Es wird empfohlen, eine COMMUNICATION_SERVICES_CONNECTION_STRING
-Umgebungsvariable zu verwenden, um zu vermeiden, dass Ihre Verbindungszeichenfolge als Klartext im Code enthalten ist. Informationen zur Verwaltung der Verbindungszeichenfolge Ihrer Ressource.
# 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)
Alternativ kann der Client mithilfe der Microsoft Entra-Authentifizierung authentifiziert werden. Die Verwendung des DefaultAzureCredential
-Objekts ist die einfachste Möglichkeit, um mit Azure AD zu beginnen. Sie können es mit dem Befehl pip install
installieren.
pip install azure-identity
Zum Erstellen eines DefaultAzureCredential
-Objekts müssen Sie AZURE_CLIENT_ID
, AZURE_CLIENT_SECRET
und AZURE_TENANT_ID
bereits als Umgebungsvariablen mit den entsprechenden Werten aus der registrierten Azure AD-Anwendung festlegen.
Eine Übersicht zum Abrufen dieser Umgebungsvariablen finden Sie in diesen Informationen zum Einrichten von Dienstprinzipalen über die CLI.
Sobald Sie die azure-identity
-Bibliothek installiert haben, können Sie mit der Authentifizierung des Clients fortfahren.
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)
Ermitteln der Telefonnummernformatierung
Um die nationale und internationale Formatierung für eine Nummer nachzuschlagen, rufen Sie search_operator_information
aus PhoneNumbersClient
auf.
formatting_results = phone_numbers_client.search_operator_information("<target-phone-number>")
Ersetzen Sie <target-phone-number>
durch die Telefonnummer, die Sie suchen, in der Regel eine Nummer, an die Sie eine Nachricht senden möchten.
Warnung
Geben Sie Telefonnummern im internationalen Standardformat E.164 an, z. B. +14255550123.
Nachschlagen von Betreiberinformationen für eine Nummer
Um nach den Betreiberinformationen einer Telefonnummer zu suchen, rufen Sie search_operator_information
über den PhoneNumbersClient
auf, und übergeben Sie True
für die include_additional_operator_details
-Option.
options = { "include_additional_operator_details": True }
operator_results = phone_numbers_client.search_operator_information("<target-phone-number>", options)
Warnung
Durch die Verwendung dieser Funktion wird Ihrem Konto eine Gebühr berechnet.
Verwenden von Betreiberinformationen
Sie können jetzt die Betreiberinformationen verwenden. Im Rahmen dieser Schnellstartanleitung können wir einige der Details an der Konsole ausgeben.
Zunächst können wir Details zum Nummernformat ausgeben.
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))
Als Nächstes können wir Details zur Telefonnummer und zum Betreiber ausgeben.
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))
Sie können außerdem die Betreiberinformationen verwenden, um zu bestimmen, ob eine SMS gesendet werden soll. Weitere Informationen zum Senden einer SMS finden Sie in der SMS-Schnellstartanleitung.
Ausführen des Codes
Führen Sie die Anwendung über Ihr Terminal oder Befehlsfenster mit dem python
-Befehl aus.
python number_lookup_sample.py
Beispielcode
Sie können die Beispiel-App von GitHub herunterladen.
Problembehandlung
Häufig gestellte Fragen und Probleme:
- Änderungen an Umgebungsvariablen werden möglicherweise nicht in Programmen wirksam, die bereits ausgeführt werden. Wenn Sie feststellen, dass Ihre Umgebungsvariablen nicht wie erwartet funktionieren, versuchen Sie, alle Programme zu schließen und erneut zu öffnen, die Sie zum Ausführen und Bearbeiten von Code verwenden.
- Die von diesem Endpunkt zurückgegebenen Daten unterliegen verschiedenen internationalen Gesetzen und Vorschriften, daher hängt die Genauigkeit der Ergebnisse von mehreren Faktoren ab. Zu diesen Faktoren gehören, ob die Nummer portiert wurde, die Landeskennzahl und der Genehmigungsstatus des Anrufers. Auf der Grundlage dieser Faktoren sind Betreiberinformationen für einige Telefonnummern möglicherweise nicht verfügbar oder spiegeln den ursprünglichen Betreiber der Telefonnummer wider, nicht den aktuellen Betreiber.
Nächste Schritte
In dieser Schnellstartanleitung haben Sie Folgendes gelernt:
- Ermitteln der Nummernformatierung
- Nachschlagen von Betreiberinformationen für eine Telefonnummer