Condividi tramite


Rooms - Create

Crea una nuova stanza.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string

url

Endpoint della risorsa di comunicazione di Azure.

api-version
query True

string

Versione dell'API da richiamare.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Authorization True

string

Stringa di autenticazione contenente una firma generata usando lo schema HMAC-SHA256.

Repeatability-Request-ID

string

uuid

Se specificato, il client indica che la richiesta è ripetibile; ovvero che il client può effettuare la richiesta più volte con lo stesso ID richiesta ripetibilità e ottenere una risposta appropriata senza che il server eseeva la richiesta più volte. Il valore di Repeatability-Request-ID è una stringa opaca che rappresenta un identificatore per la richiesta generato dal client, globalmente univoco per tutto il tempo. È consigliabile usare uUID versione 4 (casuale).

Repeatability-First-Sent

string

date-time-rfc1123

Se viene specificata l'intestazione Repeatability-Request-ID, è necessario specificare anche l'intestazione Repeatability-First-Sent. Il valore deve essere la data e l'ora in cui la richiesta è stata creata per la prima volta, espressa utilizzando il formato IMF-fixdate di HTTP-date.

Corpo della richiesta

Nome Tipo Descrizione
participants

<string,  ParticipantProperties>

(Facoltativo) Partecipanti da invitare alla sala.

pstnDialOutEnabled

boolean

Impostare questo flag su true se, al momento della chiamata, la chiamata in uscita a un numero PSTN è abilitata in una determinata stanza. Per impostazione predefinita, questo flag è impostato su false.

validFrom

string

Timestamp da quando la stanza è aperta per l'unione. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. Il valore predefinito è l'ora di data corrente.

validUntil

string

Timestamp da quando la stanza non può più essere unita. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. Il valore predefinito è l'ora di data corrente più 180 giorni.

Risposte

Nome Tipo Descrizione
201 Created

RoomModel

Richiesta completata. L'azione restituisce una nuova stanza.

Other Status Codes

CommunicationErrorResponse

Risposta di errore

Intestazioni

x-ms-error-code: string

Sicurezza

Authorization

Stringa di autenticazione contenente una firma generata usando lo schema HMAC-SHA256.

Tipo: apiKey
In: header

Esempio

Create a new meeting room.

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
CreateRoomRequest

Richiedere il payload per la creazione di una nuova sala.

ParticipantProperties
Role

Ruolo di un partecipante alla sala. Il valore predefinito è Attendee.

RoomModel

Sala riunioni.

CreateRoomRequest

Richiedere il payload per la creazione di una nuova sala.

Nome Tipo Descrizione
participants

<string,  ParticipantProperties>

(Facoltativo) Partecipanti da invitare alla sala.

pstnDialOutEnabled

boolean

Impostare questo flag su true se, al momento della chiamata, la chiamata in uscita a un numero PSTN è abilitata in una determinata stanza. Per impostazione predefinita, questo flag è impostato su false.

validFrom

string

Timestamp da quando la stanza è aperta per l'unione. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. Il valore predefinito è l'ora di data corrente.

validUntil

string

Timestamp da quando la stanza non può più essere unita. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. Il valore predefinito è l'ora di data corrente più 180 giorni.

ParticipantProperties

Nome Tipo Descrizione
role

Role

Ruolo di un partecipante alla sala. Il valore predefinito è Attendee.

Role

Ruolo di un partecipante alla sala. Il valore predefinito è Attendee.

Nome Tipo Descrizione
Attendee

string

Consumer

string

Presenter

string

RoomModel

Sala riunioni.

Nome Tipo Descrizione
createdAt

string

Timestamp in cui è stata creata la sala nel server. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

id

string

Identificatore univoco di una stanza. Questo ID è il server generato.

pstnDialOutEnabled

boolean

Impostare questo flag su true se, al momento della chiamata, la chiamata in uscita a un numero PSTN è abilitata in una determinata stanza. Per impostazione predefinita, questo flag è impostato su false.

validFrom

string

Timestamp da quando la stanza è aperta per l'unione. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

validUntil

string

Timestamp da quando la stanza non può più essere unita. Il timestamp è in formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.