Freigeben über


Rooms - Create

Erstellt einen neuen Raum.

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

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 aufzurufenden API.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

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

Repeatability-Request-ID

string

uuid

Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist. Das heißt, dass der Client die Anforderung mehrmals mit derselben Repeatability-Request-ID ausführen und eine entsprechende Antwort erhalten kann, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Repeatability-Request-ID ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten, global eindeutigen Bezeichner für die Anforderung darstellt. Es wird empfohlen, UUIDs der Version 4 (zufällig) zu verwenden.

Repeatability-First-Sent

string

date-time-rfc1123

Wenn der Header "Repeatability-Request-ID" angegeben ist, muss auch der Header "Repeatability-First-Sent" angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, an dem die Anforderung zum ersten Mal erstellt wurde, ausgedrückt unter Verwendung der IMF-Fixdate-Form http-date.

Anforderungstext

Name Typ Beschreibung
participants

<string,  ParticipantProperties>

(Optional) Die Teilnehmer sollen in den Raum eingeladen werden.

pstnDialOutEnabled

boolean

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

validFrom

string

Der Zeitstempel ab dem Zeitpunkt, an dem der Raum für den Beitritt geöffnet ist. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit.

validUntil

string

Der Zeitstempel, ab dem der Raum nicht mehr verknüpft werden kann. Der Zeitstempel hat 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 dem HMAC-SHA256-Schema generiert wurde.

Typ: apiKey
In: header

Beispiele

Create a new meeting room.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
CreateRoomRequest

Anforderungsnutzlast zum Erstellen eines neuen Raums.

ParticipantProperties
Role

Die Rolle eines Teilnehmers für einen Raum. Der Standardwert ist Attendee.

RoomModel

Der Besprechungsraum.

CreateRoomRequest

Anforderungsnutzlast zum Erstellen eines neuen Raums.

Name Typ Beschreibung
participants

<string,  ParticipantProperties>

(Optional) Die Teilnehmer sollen in den Raum eingeladen werden.

pstnDialOutEnabled

boolean

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

validFrom

string

Der Zeitstempel ab dem Zeitpunkt, an dem der Raum für den Beitritt geöffnet ist. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit.

validUntil

string

Der Zeitstempel, ab dem der Raum nicht mehr verknüpft werden kann. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ. Der Standardwert ist die aktuelle Datumszeit plus 180 Tage.

ParticipantProperties

Name Typ Beschreibung
role

Role

Die Rolle eines Teilnehmers für einen Raum. Der Standardwert ist Attendee.

Role

Die Rolle eines Teilnehmers für einen Raum. Der Standardwert ist Attendee.

Name Typ Beschreibung
Attendee

string

Consumer

string

Presenter

string

RoomModel

Der Besprechungsraum.

Name Typ Beschreibung
createdAt

string

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

id

string

Eindeutiger Bezeichner eines Raums. Diese ID wird vom Server generiert.

pstnDialOutEnabled

boolean

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

validFrom

string

Der Zeitstempel ab dem Zeitpunkt, an dem der Raum für den Beitritt geöffnet ist. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.

validUntil

string

Der Zeitstempel, ab dem der Raum nicht mehr verknüpft werden kann. Der Zeitstempel hat RFC3339 Format: yyyy-MM-ddTHH:mm:ssZ.