Freigeben über

Rooms - Create

  • Referenz
Dienst:
Communication
API-Version:
2025-03-13

Erstellt einen neuen Raum.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (url)

Der Endpunkt der Azure Communication-Ressource.
api-version
 query True

string

Version der API, die aufgerufen werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Eine Authentifizierungszeichenfolge mit einer Signatur, die mit HMAC-SHA256 Schema generiert wird.
Repeatability-Request-ID

string (uuid)

Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-ID und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-ID ist eine undurchsichtige Zeichenfolge, die eine vom Client generierte, global eindeutige Id für die Anforderung darstellt. Es wird empfohlen, UUIDs der Version 4 (zufällig) zu verwenden.
Repeatability-First-Sent

string (date-time-rfc1123)

Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums.

Anforderungstext

Name Typ Beschreibung
participants

<string,  ParticipantProperties>

(Optional) Teilnehmer, die zum Raum eingeladen werden sollen.
pstnDialOutEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Flag ist standardmäßig auf "false" festgelegt.
validFrom

string (date-time)

Der Zeitstempel, ab dem der Raum für die Teilnahme geöffnet ist. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit.
validUntil

string (date-time)

Der Zeitstempel, ab dem der Raum nicht mehr verbunden werden kann. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit plus 180 Tage.

Antworten

Name Typ Beschreibung
201 Created

RoomModel

Anforderung erfolgreich. Die Aktion gibt einen neuen Raum zurück.
Other Status Codes

CommunicationErrorResponse

Fehlerantwort

Header

x-ms-error-code: string

Sicherheit

Authorization

Eine Authentifizierungszeichenfolge mit einer Signatur, die mit HMAC-SHA256 Schema generiert wird.

Typ: apiKey
In: header

Beispiele

Create a new meeting room.

Beispielanforderung

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"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
201 
{
  "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
}

Definitionen

Name Beschreibung
CreateRoomRequest

Fordern Sie Nutzlast zum Erstellen eines neuen Raums an.
ParticipantProperties
Role

Die Rolle eines Raumteilnehmers. Der Standardwert ist "Attendee".
RoomModel

Der Besprechungsraum.

CreateRoomRequest

Objekt

Fordern Sie Nutzlast zum Erstellen eines neuen Raums an.

Name Typ Beschreibung
participants

<string,  ParticipantProperties>

(Optional) Teilnehmer, die zum Raum eingeladen werden sollen.
pstnDialOutEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Flag ist standardmäßig auf "false" festgelegt.
validFrom

string (date-time)

Der Zeitstempel, ab dem der Raum für die Teilnahme geöffnet ist. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit.
validUntil

string (date-time)

Der Zeitstempel, ab dem der Raum nicht mehr verbunden werden kann. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit plus 180 Tage.

ParticipantProperties

Objekt
Name Typ Beschreibung
role

Role

Die Rolle eines Raumteilnehmers. Der Standardwert ist "Attendee".

Role

Enumeration

Die Rolle eines Raumteilnehmers. Der Standardwert ist "Attendee".

Wert Beschreibung
Attendee
Collaborator
Consumer
Presenter

RoomModel

Objekt

Der Besprechungsraum.

Name Typ Beschreibung
createdAt

string (date-time)

Der Zeitstempel, zu dem der Raum auf dem Server erstellt wurde. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
id

string

Eindeutiger Bezeichner eines Chatrooms. Diese ID wird vom Server generiert.
pstnDialOutEnabled

boolean

Legen Sie dieses Kennzeichen auf "true" fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Flag ist standardmäßig auf "false" festgelegt.
validFrom

string (date-time)

Der Zeitstempel, ab dem der Raum für die Teilnahme geöffnet ist. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.
validUntil

string (date-time)

Der Zeitstempel, ab dem der Raum nicht mehr verbunden werden kann. Der Zeitstempel befindet sich im RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.