Bibliothèque cliente Azure Communication Rooms pour Python - version 1.0.0

Article
06/14/2023

Ce package contient un Kit de développement logiciel (SDK) Python pour Azure Communication Services pour les salles. En savoir plus sur Azure Communication Services ici

Clause d’exclusion de responsabilité

La prise en charge des packages Python du SDK Azure pour Python 2.7 a pris fin le 1er janvier 2022. Pour obtenir plus d’informations et poser des questions, reportez-vous à https://github.com/Azure/azure-sdk-for-python/issues/20691

Concepts clés

Le package Azure Communication Rooms est utilisé pour effectuer les opérations suivantes :

Créer des réunions planifiées
Créer des réunions avec des autorisations managées pour ses participants

Prise en main

Installation du package

python -m pip install azure-communication-rooms

Configuration requise

Python 3.7 ou version ultérieure est requis pour utiliser ce package.
Vous avez besoin d’un abonnement Azure pour utiliser ce package.
Une ressource Communication Services déployée. Vous pouvez utiliser le portail Azure ou le Azure PowerShell pour le configurer.

Initialisation du client

Pour initialiser le client Rooms, la chaîne de connexion peut être utilisée pour instancier.

from azure.communication.rooms import RoomsClient

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

Exemples

Paramètres clés

valid_from: objet datetime à partir duquel la salle démarrera existante
valid_until: objet datetime après lequel la réunion de salle se termine
participants: liste de RoomParticipants contenant les IRM des invités dans la salle, ainsi que les options facultatives ParticipantRole. Si ParticipantRole n’est pas spécifié, il le sera Attendee par défaut. Tous les attributs ci-dessus sont facultatifs. Le service fournit les valeurs par défaut de valid_until et de valid_from si elles sont manquantes. La valeur par défaut pourvalid_from est l’heure de date actuelle et la valeur par défaut pour valid_until est valid_from + 180 days.

Créer une salle

Pour créer une salle, appelez la create_room fonction à partir de RoomsClient. Les valid_fromarguments , valid_untilet participants sont tous facultatifs.

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)

Mettre à jour une salle

Les valid_from propriétés et valid_until d’une salle créée peuvent être mises à jour en appelant la update_room fonction à partir de RoomsClient.

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))

Obtenir une salle

Une salle créée peut être récupérée en appelant la get_room fonction à partir de RoomsClient et en transmettant le associé room_id.

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

Répertorier les salles

Récupérez toutes les salles valides créées avec une ressource ACS en appelant la list_rooms fonction à partir de RoomsClient.

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

Supprimer une salle

Pour supprimer une salle, appelez la delete_room fonction à partir de RoomsClient.

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

Ajouter ou mettre à jour des participants dans une salle

Pour insérer de nouveaux participants ou mettre à jour des participants existants, appelez la add_or_update_participants fonction à partir de RoomsClient.

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))

Supprimer des participants

Supprimez des participants d’une salle en appelant la remove_participants fonction à partir de RoomsClient.

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)

Lister les participants

Récupérez la liste des participants pour une salle existante en référençant :room_id

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

Dépannage

Les opérations de salle lèvent une exception si la demande adressée au serveur échoue. Le client Rooms déclenche des exceptions définies dans Azure Core.

Étapes suivantes

Autres exemples de code

Consultez le répertoire d’exemples pour obtenir des exemples détaillés sur la façon d’utiliser cette bibliothèque pour créer et gérer des salles.

Fournir des commentaires

Si vous rencontrez des bogues ou si vous avez des suggestions, veuillez déposer un problème dans la section Problèmes du projet

Contribution

Ce projet accepte les contributions et les suggestions. La plupart des contributions vous demandent d’accepter un contrat de licence de contribution (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez réellement, les droits d’utilisation de votre contribution. Pour plus d’informations, visitez https://cla.microsoft.com.

Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous ne devez effectuer cette opération qu’une seule fois sur tous les dépôts utilisant notre contrat CLA.

Ce projet a adopté le Code de conduite Open Source de Microsoft. Pour plus d’informations, consultez la FAQ sur le code de conduite ou contactez opencode@microsoft.com pour toute question ou tout commentaire supplémentaire.

Partager via