Udostępnij za pośrednictwem


Rooms - Create

Tworzy nowy pokój.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string

url

Punkt końcowy zasobu usługi Azure Communication.

api-version
query True

string

Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Authorization True

string

Ciąg uwierzytelniania zawierający podpis wygenerowany przy użyciu schematu HMAC-SHA256.

Repeatability-Request-ID

string

uuid

Jeśli zostanie określony, klient przekierowuje, że żądanie jest powtarzalne; oznacza to, że klient może wykonać żądanie wiele razy z tym samym repeatability-Request-ID i uzyskać odpowiednią odpowiedź bez serwera wykonującego żądanie wiele razy. Wartość Repeatability-Request-ID jest nieprzezroczystym ciągiem reprezentującym wygenerowaną przez klienta, globalnie unikatową przez cały czas identyfikator żądania. Zaleca się używanie identyfikatorów UUD w wersji 4 (losowych).

Repeatability-First-Sent

string

date-time-rfc1123

Jeśli określono nagłówek Repeatability-Request-ID, należy również określić nagłówek Repeatability-First-Sent. Wartość powinna być datą i godziną, o której żądanie zostało utworzone po raz pierwszy, wyrażone przy użyciu poprawionej formy HTTP-fixdate.

Treść żądania

Nazwa Typ Opis
participants

<string,  ParticipantProperties>

(Opcjonalnie) Uczestnicy, którzy zostaną zaproszeni do pokoju.

pstnDialOutEnabled

boolean

Ustaw tę flagę na wartość true, jeśli w momencie połączenia wybierz numer PSTN jest włączony w określonym pomieszczeniu. Domyślnie flaga ta jest ustawiona na wartość Fałsz.

validFrom

string

Sygnatura czasowa od momentu otwarcia pokoju do dołączenia. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Wartość domyślna to bieżąca data i godzina.

validUntil

string

Sygnatura czasowa, od kiedy nie można już dołączyć do pokoju. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Wartość domyślna to bieżąca data i 180 dni.

Odpowiedzi

Nazwa Typ Opis
201 Created

RoomModel

Żądanie powiodło się. Akcja zwraca nowy pokój.

Other Status Codes

CommunicationErrorResponse

Odpowiedź na błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Ciąg uwierzytelniania zawierający podpis wygenerowany przy użyciu schematu HMAC-SHA256.

Typ: apiKey
W: header

Przykłady

Create a new meeting room.

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
CreateRoomRequest

Zażądaj ładunku w celu utworzenia nowego pokoju.

ParticipantProperties
Role

Rola uczestnika pokoju. Wartość domyślna to Attendee.

RoomModel

Sala konferencyjna.

CreateRoomRequest

Zażądaj ładunku w celu utworzenia nowego pokoju.

Nazwa Typ Opis
participants

<string,  ParticipantProperties>

(Opcjonalnie) Uczestnicy, którzy zostaną zaproszeni do pokoju.

pstnDialOutEnabled

boolean

Ustaw tę flagę na wartość true, jeśli w momencie połączenia wybierz numer PSTN jest włączony w określonym pomieszczeniu. Domyślnie flaga ta jest ustawiona na wartość Fałsz.

validFrom

string

Sygnatura czasowa od momentu otwarcia pokoju do dołączenia. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Wartość domyślna to bieżąca data i godzina.

validUntil

string

Sygnatura czasowa, od kiedy nie można już dołączyć do pokoju. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Wartość domyślna to bieżąca data i 180 dni.

ParticipantProperties

Nazwa Typ Opis
role

Role

Rola uczestnika pokoju. Wartość domyślna to Attendee.

Role

Rola uczestnika pokoju. Wartość domyślna to Attendee.

Nazwa Typ Opis
Attendee

string

Consumer

string

Presenter

string

RoomModel

Sala konferencyjna.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa utworzenia pokoju na serwerze. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.

id

string

Unikatowy identyfikator pomieszczenia. Ten identyfikator jest generowany przez serwer.

pstnDialOutEnabled

boolean

Ustaw tę flagę na wartość true, jeśli w momencie połączenia wybierz numer PSTN jest włączony w określonym pomieszczeniu. Domyślnie flaga ta jest ustawiona na wartość Fałsz.

validFrom

string

Sygnatura czasowa od momentu otwarcia pokoju do dołączenia. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.

validUntil

string

Sygnatura czasowa, od kiedy nie można już dołączyć do pokoju. Znacznik czasu ma format RFC3339: yyyy-MM-ddTHH:mm:ssZ.