Compartilhar via


Rooms - Create

Cria uma nova sala.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
path True

string (url)

O ponto de extremidade do recurso de Comunicação do Azure.

api-version
query True

string

Versão da API a ser invocada.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Uma cadeia de caracteres de autenticação que contém uma assinatura gerada usando HMAC-SHA256 esquema.

Repeatability-Request-ID

string (uuid)

Se especificado, o cliente direciona que a solicitação seja repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com a mesma RepetiçãoRequest-ID e obter uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor doRequest-ID de Repetição é uma cadeia de caracteres opaca que representa um identificador globalmente exclusivo para todos os tempos gerado pelo cliente para a solicitação. É recomendável usar UUIDs da versão 4 (aleatória).

Repeatability-First-Sent

string (date-time-rfc1123)

Se o cabeçalho repeatability-Request-ID for especificado, o cabeçalhoFirst-Sent de repetição também deverá ser especificado. O valor deve ser a data e a hora em que a solicitação foi criada pela primeira vez, expressa usando a forma fixada pelo FMI de data HTTP.

Corpo da solicitação

Nome Tipo Description
participants

<string,  ParticipantProperties>

(Opcional) Participantes a serem convidados para a sala.

pstnDialOutEnabled

boolean

Defina esse sinalizador como true se, no momento da chamada, discar para um número PSTN estiver habilitado em uma sala específica. Por padrão, esse sinalizador é definido como false.

validFrom

string (date-time)

O carimbo de data/hora de quando a sala está aberta para ingressar. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. O valor padrão é a hora da data atual.

validUntil

string (date-time)

O carimbo de data/hora de quando a sala não pode mais ser unida. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. O valor padrão é a data atual mais 180 dias.

Respostas

Nome Tipo Description
201 Created

RoomModel

Solicitação bem-sucedida. A ação retorna uma nova sala.

Other Status Codes

CommunicationErrorResponse

Resposta de erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Uma cadeia de caracteres de autenticação que contém uma assinatura gerada usando HMAC-SHA256 esquema.

Tipo: apiKey
Em: header

Exemplos

Create a new meeting room.

Solicitação de exemplo

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

Resposta de exemplo

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

Definições

Nome Description
CreateRoomRequest

Solicite conteúdo para criar uma nova sala.

ParticipantProperties
Role

A função de um participante da sala. O valor padrão é Participante.

RoomModel

A sala de reunião.

CreateRoomRequest

Solicite conteúdo para criar uma nova sala.

Nome Tipo Description
participants

<string,  ParticipantProperties>

(Opcional) Participantes a serem convidados para a sala.

pstnDialOutEnabled

boolean

Defina esse sinalizador como true se, no momento da chamada, discar para um número PSTN estiver habilitado em uma sala específica. Por padrão, esse sinalizador é definido como false.

validFrom

string (date-time)

O carimbo de data/hora de quando a sala está aberta para ingressar. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. O valor padrão é a hora da data atual.

validUntil

string (date-time)

O carimbo de data/hora de quando a sala não pode mais ser unida. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ. O valor padrão é a data atual mais 180 dias.

ParticipantProperties

Nome Tipo Description
role

Role

A função de um participante da sala. O valor padrão é Participante.

Role

A função de um participante da sala. O valor padrão é Participante.

Valor Description
Presenter
Attendee
Consumer
Collaborator

RoomModel

A sala de reunião.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora quando a sala foi criada no servidor. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

id

string

Identificador exclusivo de uma sala. Essa ID é gerada pelo servidor.

pstnDialOutEnabled

boolean

Defina esse sinalizador como true se, no momento da chamada, discar para um número PSTN estiver habilitado em uma sala específica. Por padrão, esse sinalizador é definido como false.

validFrom

string (date-time)

O carimbo de data/hora de quando a sala está aberta para ingressar. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

validUntil

string (date-time)

O carimbo de data/hora de quando a sala não pode mais ser unida. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.