Rooms - Create

Serviço:

Communication

Versão da API:

2024-04-15

Cria uma nova sala.

POST {endpoint}/rooms?api-version=2024-04-15

Parâmetros do URI

Name	Em	Necessá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 invocar.

Cabeçalho do Pedido

Name	Necessá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 é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com o mesmoRequest-ID de repetibilidade e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-ID de repetibilidade é uma cadeia de caracteres opaca que representa um identificador gerado pelo cliente, globalmente exclusivo para todos os tempos, para a solicitação. Recomenda-se o uso da versão 4 (aleatória) UUIDs.
Repeatability-First-Sent		string (date-time-rfc1123)	Se o cabeçalho Repeatability-Request-ID for especificado, o cabeçalho Repeatability-First-Sent 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 IMF-fixdate de HTTP-date.

Corpo do Pedido

Name	Tipo	Description
participants	<string,  ParticipantProperties>	(Opcional) Os participantes serão 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 a partir de quando a sala está aberta para adesão. 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 a partir de quando a sala não pode mais ser associada. 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

Name	Tipo	Description
201 Created	RoomModel	Pedido bem-sucedido. A ação devolve 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.

Pedido de amostra

HTTP

POST https://contoso.communication.azure.com//rooms?api-version=2024-04-15

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

Resposta da amostra

Código de estado:

201

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

Definições

Name	Description
CreateRoomRequest	Solicite carga útil para criar uma nova sala.
ParticipantProperties
Role	O papel de um participante da sala. O valor padrão é Attendee.
RoomModel	A sala de reuniões.

CreateRoomRequest

Object

Solicite carga útil para criar uma nova sala.

Name	Tipo	Description
participants	<string,  ParticipantProperties>	(Opcional) Os participantes serão 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 a partir de quando a sala está aberta para adesão. 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 a partir de quando a sala não pode mais ser associada. 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

Object

Name	Tipo	Description
role	Role	O papel de um participante da sala. O valor padrão é Attendee.

Role

Enumeração

O papel de um participante da sala. O valor padrão é Attendee.

Valor	Description
Attendee
Consumer
Presenter

RoomModel

Object

A sala de reuniões.

Name	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 único de uma sala. Este id é gerado 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 a partir de quando a sala está aberta para adesão. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
validUntil	string (date-time)	O carimbo de data/hora a partir de quando a sala não pode mais ser associada. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.