Share via

Azure Communication SMS Package-Clientbibliothek für Python– Version 1.0.1

  • Artikel

Dieses Paket enthält ein Python SDK für Azure Communication Services für SMS. Weitere Informationen zu Azure Communication Services finden Sie hier.

Quellcode | Paket (Pypi) | API-Referenzdokumentation | Produktdokumentation

Erste Schritte

Voraussetzungen

  • Für die Verwendung dieses Pakets ist Python 2.7 bzw. 3.6 oder höher erforderlich.
  • Eine bereitgestellte Communication Services-Ressource. Sie können das Azure-Portal oder die Azure PowerShell zum Einrichten verwenden.
  • Sie müssen eine Telefonnummer konfiguriert haben, die einem Azure-Abonnement zugeordnet ist.

Installieren des Pakets

Installieren Sie die Azure Communication SMS-Clientbibliothek für Python mit pip:

pip install azure-communication-sms

Wichtige Begriffe

Das Azure Communication SMS-Paket wird für folgende Aktionen verwendet:

  • Senden einer SMS: 1:1
  • Senden einer SMS: 1:N

Beispiele

Der folgende Abschnitt enthält mehrere Codeausschnitte, die einige der gängigsten Azure Communication Services-Aufgaben behandeln, einschließlich:

Clientinitialisierung

Zum Initialisieren des SMS-Clients kann die Verbindungszeichenfolge zum Instanziieren verwendet werden. Alternativ können Sie auch die Active Directory-Authentifizierung mit DefaultAzureCredential verwenden.

from azure.communication.sms import SmsClient
from azure.identity import DefaultAzureCredential

connection_str = "endpoint=ENDPOINT;accessKey=KEY"
sms_client = SmsClient.from_connection_string(connection_string)

# To use Azure Active Directory Authentication (DefaultAzureCredential) make sure to have
# AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_CLIENT_SECRET as env variables.
endpoint = "https://<RESOURCE_NAME>.communication.azure.com"
sms_client = SmsClient(endpoint, DefaultAzureCredential())

Senden einer SMS: 1:1

Nachdem der Client initialisiert wurde, kann die send -Methode aufgerufen werden:

from azure.communication.sms import SendSmsOptions

sms_responses = sms_client.send(
    from_="<from-phone-number>",
    to="<to-phone-number-1>",
    message="Hello World via SMS",
    enable_delivery_report=True, # optional property
    tag="custom-tag") # optional property
  • from_: Eine SMS-aktivierte Telefonnummer, die Ihrem Kommunikationsdienst zugeordnet ist.
  • to: Die Telefonnummer oder Liste der Telefonnummern, an die Sie eine Nachricht senden möchten.
  • message: Die Nachricht, die Sie senden möchten.
  • enable_delivery_report: Ein optionaler Parameter, den Sie zum Konfigurieren der Übermittlungsberichterstattung verwenden können. Dies ist in Szenarien hilfreich, in denen Ereignisse ausgegeben werden sollen, wenn SMS-Nachrichten zugestellt wurden.
  • tag: Ein optionaler Parameter, den Sie zum Konfigurieren des benutzerdefinierten Taggings verwenden können.

Senden einer SMS: 1:N

Nachdem der Client initialisiert wurde, kann die send -Methode aufgerufen werden:

from azure.communication.sms import SendSmsOptions

sms_responses = sms_client.send(
    from_="<from-phone-number>",
    to=["<to-phone-number-1>", "<to-phone-number-2>", "<to-phone-number-3>"],
    message="Hello World via SMS",
    enable_delivery_report=True, # optional property
    tag="custom-tag") # optional property
  • from_: Eine SMS-aktivierte Telefonnummer, die Ihrem Kommunikationsdienst zugeordnet ist.
  • to: Die Telefonnummer oder Liste der Telefonnummern, an die Sie eine Nachricht senden möchten.
  • message: Die Nachricht, die Sie senden möchten.
  • enable_delivery_report: Ein optionaler Parameter, den Sie zum Konfigurieren der Übermittlungsberichterstattung verwenden können. Dies ist in Szenarien hilfreich, in denen Ereignisse ausgegeben werden sollen, wenn SMS-Nachrichten zugestellt wurden.
  • tag: Ein optionaler Parameter, den Sie zum Konfigurieren des benutzerdefinierten Taggings verwenden können.

Problembehandlung

SMS-Vorgänge lösen eine Ausnahme aus, wenn die Anforderung an den Server fehlschlägt. Der SMS-Client löst ausnahmen aus, die in Azure Core definiert sind. Ausnahmen werden nicht ausgelöst, wenn der Fehler durch eine einzelne Nachricht verursacht wird, nur wenn bei der Gesamtanforderung ein Fehler auftritt. Verwenden Sie das Flag erfolgreich, um jedes einzelne Ergebnis zu überprüfen, um zu überprüfen, ob die Nachricht gesendet wurde.

try:
    sms_responses = sms_client.send(
        from_="<leased-phone-number>",
        to=["<to-phone-number-1>", "<to-phone-number-2>", "<to-phone-number-3>"],
        message="Hello World via SMS")
        
    for sms_response in sms_responses:
        if (sms_response.successful):
            print("Message with message id {} was successful sent to {}"
            .format(sms_response.message_id, sms_response.to))
        else:
            print("Message failed to send to {} with the status code {} and error: {}"
            .format(sms_response.to, sms_response.http_status_code, sms_response.error_message))
except Exception as ex:
    print('Exception:')
    print(ex)

Nächste Schritte

Weiterer Beispielcode

Ausführliche Beispiele für die Verwendung dieser Bibliothek zum Senden einer SMS finden Sie im Beispielverzeichnis .

Feedback geben

Wenn Fehler auftreten oder Vorschläge vorliegen, melden Sie ein Problem im Abschnitt Probleme des Projekts.

Mitwirken

Beiträge und Vorschläge für dieses Projekt sind willkommen. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. Ausführliche Informationen finden Sie unter https://cla.microsoft.com.

Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Sie müssen dies nur einmal für alle Repositorys ausführen, die unsere CLA verwenden.

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.