Partager via


Rooms - Create

Crée une salle.

POST {endpoint}/rooms?api-version=2025-03-13

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string (url)

Point de terminaison de la ressource Azure Communication.

api-version
query True

string

Version de l’API à appeler.

En-tête de la demande

Nom Obligatoire Type Description
Authorization True

string

Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.

Repeatability-Request-ID

string (uuid)

S’il est spécifié, le client indique que la requête est reproductible ; autrement dit, que le client peut effectuer la requête plusieurs fois avec la même répétabilité -Request-ID et récupérer une réponse appropriée sans que le serveur exécute la requête plusieurs fois. La valeur de la répétabilité -Request-ID est une chaîne opaque représentant une chaîne générée par le client, globalement unique pour tout le temps, identificateur de la requête. Il est recommandé d’utiliser les UUID de la version 4 (aléatoire).

Repeatability-First-Sent

string (date-time-rfc1123)

Si repeatability-Request-ID en-tête est spécifié, l’en-tête repeatability-First-Sent doit également être spécifié. La valeur doit être la date et l’heure à laquelle la requête a été créée pour la première fois, exprimée à l’aide de la forme IMF-fixdate de la date HTTP.

Corps de la demande

Nom Type Description
participants

<string,  ParticipantProperties>

(Facultatif) Les participants doivent être invités à la salle.

pstnDialOutEnabled

boolean

Définissez cet indicateur sur true si, au moment de l’appel, la numérotation vers un numéro RTC est activée dans une salle particulière. Par défaut, cet indicateur a la valeur false.

validFrom

string (date-time)

Horodatage à partir duquel la pièce est ouverte pour la jointure. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle.

validUntil

string (date-time)

Horodatage à partir duquel la salle ne peut plus être jointe. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle plus de 180 jours.

Réponses

Nom Type Description
201 Created

RoomModel

Demande réussie. L’action retourne une nouvelle salle.

Other Status Codes

CommunicationErrorResponse

Réponse d’erreur

En-têtes

x-ms-error-code: string

Sécurité

Authorization

Chaîne d’authentification contenant une signature générée à l’aide de HMAC-SHA256 schéma.

Type: apiKey
Dans: header

Exemples

Create a new meeting room.

Exemple de requête

POST https://contoso.communication.azure.com//rooms?api-version=2025-03-13

{
  "validFrom": "2025-06-30T00:00:00Z",
  "validUntil": "2025-07-30T00:00:00Z",
  "pstnDialOutEnabled": true,
  "participants": {
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666": {
      "role": "Attendee"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777": {
      "role": "Presenter"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000888": {
      "role": "Collaborator"
    }
  }
}

Exemple de réponse

{
  "id": "99117812428622880",
  "createdAt": "2025-06-26T05:46:17.8159131+00:00",
  "validFrom": "2025-06-30T00:00:00+00:00",
  "validUntil": "2025-07-30T00:00:00+00:00",
  "pstnDialOutEnabled": true
}

Définitions

Nom Description
CreateRoomRequest

Charge utile de la demande pour la création d’une salle.

ParticipantProperties
Role

Rôle d’un participant de salle. La valeur par défaut est Participant.

RoomModel

Salle de réunion.

CreateRoomRequest

Charge utile de la demande pour la création d’une salle.

Nom Type Description
participants

<string,  ParticipantProperties>

(Facultatif) Les participants doivent être invités à la salle.

pstnDialOutEnabled

boolean

Définissez cet indicateur sur true si, au moment de l’appel, la numérotation vers un numéro RTC est activée dans une salle particulière. Par défaut, cet indicateur a la valeur false.

validFrom

string (date-time)

Horodatage à partir duquel la pièce est ouverte pour la jointure. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle.

validUntil

string (date-time)

Horodatage à partir duquel la salle ne peut plus être jointe. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle plus de 180 jours.

ParticipantProperties

Nom Type Description
role

Role

Rôle d’un participant de salle. La valeur par défaut est Participant.

Role

Rôle d’un participant de salle. La valeur par défaut est Participant.

Valeur Description
Presenter
Attendee
Consumer
Collaborator

RoomModel

Salle de réunion.

Nom Type Description
createdAt

string (date-time)

Horodatage lorsque la salle a été créée sur le serveur. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.

id

string

Identificateur unique d’une pièce. Cet ID est généré par le serveur.

pstnDialOutEnabled

boolean

Définissez cet indicateur sur true si, au moment de l’appel, la numérotation vers un numéro RTC est activée dans une salle particulière. Par défaut, cet indicateur a la valeur false.

validFrom

string (date-time)

Horodatage à partir duquel la pièce est ouverte pour la jointure. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.

validUntil

string (date-time)

Horodatage à partir duquel la salle ne peut plus être jointe. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.