Partager via


Rooms - Create

Crée une salle.

POST {endpoint}/rooms?api-version=2023-10-30-preview

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 du schéma HMAC-SHA256.

Repeatability-Request-ID

string

uuid

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

Repeatability-First-Sent

string

date-time-rfc1123

Si l’en-tête Repeatability-Request-ID 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 demande a été créée pour la première fois, exprimée à l’aide de la forme IMF-fixdate de HTTP-date.

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 est défini sur False.

validFrom

string

Horodatage à partir du moment où la salle est ouverte pour la jonction. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle.

validUntil

string

Horodatage à partir du moment où 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 180 jours.

Réponses

Nom Type Description
201 Created

RoomModel

La demande a réussi. 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 du schéma HMAC-SHA256.

Type: apiKey
Dans: header

Exemples

Create a new meeting room.

Exemple de requête

POST https://contoso.communication.azure.com//rooms?api-version=2023-10-30-preview

{
  "validFrom": "2023-06-30T00:00:00Z",
  "validUntil": "2023-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"
    }
  }
}

Exemple de réponse

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

Définitions

Nom Description
CreateRoomRequest

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

ParticipantProperties
Role

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

RoomModel

Salle de réunion.

CreateRoomRequest

Charge utile de demande pour la création d’une nouvelle 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 est défini sur False.

validFrom

string

Horodatage à partir du moment où la salle est ouverte pour la jonction. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ. La valeur par défaut est l’heure de date actuelle.

validUntil

string

Horodatage à partir du moment où 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 180 jours.

ParticipantProperties

Nom Type Description
role

Role

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

Role

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

Nom Type Description
Attendee

string

Consumer

string

Presenter

string

RoomModel

Salle de réunion.

Nom Type Description
createdAt

string

Horodatage lors de la création de la salle sur le serveur. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.

id

string

Identificateur unique d’une salle. 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 est défini sur False.

validFrom

string

Horodatage à partir du moment où la salle est ouverte pour la jonction. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.

validUntil

string

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