Azure Communication Rooms-Clientbibliothek für Python – Version 1.0.0

Artikel
06/14/2023

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

Haftungsausschluss

Die Unterstützung von Python-Paketen für Das Azure SDK für Python 2.7 wurde am 01. Januar 2022 eingestellt. Weitere Informationen und Antworten finden Sie unter https://github.com/Azure/azure-sdk-for-python/issues/20691.

Wichtige Begriffe

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

Erstellen geplanter Besprechungen
Erstellen von Besprechungen mit verwalteten Berechtigungen für die Teilnehmer

Erste Schritte

Installieren des Pakets

python -m pip install azure-communication-rooms

Voraussetzungen

Für die Verwendung dieses Pakets ist Python 3.7 oder höher erforderlich.
Sie benötigen ein Azure-Abonnement , um dieses Paket verwenden zu können.
Eine bereitgestellte Communication Services-Ressource. Sie können das Azure-Portal oder das Azure PowerShell verwenden, um es einzurichten.

Clientinitialisierung

Um den Rooms-Client zu initialisieren, kann die Verbindungszeichenfolge zum Instanziieren verwendet werden.

from azure.communication.rooms import RoomsClient

client = RoomsClient.from_connection_string(conn_str='<connection_str>' )

Beispiele

Schlüsselparameter

valid_from: Ein datetime-Objekt, von dem aus der vorhandene Raum gestartet wird
valid_until: Ein datetime-Objekt, nach dem die Raumbesprechung endet
participants: Eine Liste von RoomParticipants, die MRT der eingeladenen Personen zum Raum sowie optional ParticipantRoleenthält. Wenn ParticipantRole nicht angegeben ist, ist Attendee dies standardmäßig. Alle oben genannten Attribute sind optional. Der Dienst stellt Standardwerte valid_until und valid_from bereit, wenn sie fehlen. Der Standardwert fürvalid_from ist die aktuelle Datumszeit, und der Standardwert für valid_until ist valid_from + 180 days.

Erstellen eines Raums

Um einen Raum zu erstellen, rufen Sie die create_room Funktion von auf RoomsClient. Die valid_fromArgumente , valid_untilund participants sind alle optional.

from azure.core.exceptions import HttpResponseError
from datetime import datetime, timedelta
from azure.communication.rooms import (
    RoomsClient,
    RoomParticipant,
    ParticipantRole
)
from azure.communication.identity import CommunicationUserIdentifier

client = RoomsClient.from_connection_string(conn_str='<connection_str>')
valid_from = datetime.now()
valid_until = valid_from + relativedelta(months=+1)
participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.CONSUMER))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.PRESENTER))

try:
    create_room_response = client.create_room(
        valid_from=valid_from,
        valid_until=valid_until,
        participants=participants
    )
except HttpResponseError as ex:
    print(ex)

Aktualisieren eines Raums

Die valid_from Eigenschaften und valid_until eines erstellten Raums können aktualisiert werden, indem die update_room Funktion von RoomsClientaufgerufen wird.

try:
    update_room_response = client.update_room(
        room_id="id of the room to be updated",
        valid_from=datetime.now(),
        valid_until=valid_from + timedelta(weeks=4)
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Abrufen eines Raums

Ein erstellter Raum kann abgerufen werden, indem die get_room Funktion von RoomsClient aufgerufen und der zugeordnete room_idübergeben wird.

try:
    get_room_response = client.get_room(room_id="id of the room to get")
except HttpResponseError as ex:
    print(ex)

Listenräume

Rufen Sie alle gültigen Räume ab, die mit einer ACS-Ressource erstellt wurden, indem Sie die list_rooms Funktion von RoomsClientaufrufen.

try:
    list_room_response = client.list_rooms()
except HttpResponseError as ex:
    print(ex)

Löschen eines Raums

Um einen Raum zu löschen, rufen Sie die delete_room Funktion über RoomsClient auf.

try:
    client.delete_room(
        room_id="id of the room to be deleted")
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Hinzufügen oder Aktualisieren von Teilnehmern in einem Raum

Um neue Teilnehmer einzufügen oder vorhandene Teilnehmer zu aktualisieren, rufen Sie die add_or_update_participants Funktion über RoomsClient auf.

participants = []
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 1>")))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 2>"), ParticipantRole.ATTENDEE))
participants.append(RoomParticipant(CommunicationUserIdentifier("<ACS User MRI identity 3>"), ParticipantRole.CONSUMER))
try:
    response = client.add_or_update_participants(
        room_id="id of the room to be updated",
        participants=participants
    )
except HttpResponseError as e:
    print('service responds error: {}'.format(e))

Entfernen von Teilnehmer*innen

Entfernen Sie Teilnehmer aus einem Raum, indem Sie die remove_participants Funktion aus RoomsClient aufrufen.

communication_identifiers = [CommunicationUserIdentifier("<ACS User MRI identity 2>")]

try:
    remove_participants_response = client.remove_participants(
        room_id=room_id,
        participants=communication_identifiers
    )
except HttpResponseError as ex:
    print(ex)

Auflisten von Teilnehmern

Rufen Sie die Teilnehmerliste für einen vorhandenen Raum ab, indem Sie auf verweisen room_id:

try:
    participants = self.rooms_client.list_participants(room_id)
except HttpResponseError as ex:
    print(ex)

Problembehandlung

Räumevorgänge lösen eine Ausnahme aus, wenn die Anforderung an den Server fehlschlägt. Der Rooms-Client löst die in Azure Core definierten Ausnahmen aus.

Nächste Schritte

Weiterer Beispielcode

Sehen Sie sich das Beispielverzeichnis an, um detaillierte Beispiele für die Verwendung dieser Bibliothek zum Erstellen und Verwalten von Räumen zu finden.

Feedback geben

Wenn Sie Fehler oder Vorschläge haben, 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 FAQ zum Verhaltenskodex, oder wenden Sie sich mit weiteren Fragen oder Kommentaren an opencode@microsoft.com.

Freigeben über