Rooms - Create

Service:

Communication

API Version:

2023-10-30-preview

Skapar ett nytt rum.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string url	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En autentiseringssträng som innehåller en signatur som genereras med HMAC-SHA256-schema.
Repeatability-Request-ID		string uuid	Om det anges dirigerar klienten att begäran kan upprepas. Det vill säga att klienten kan göra begäran flera gånger med samma Repeatability-Request-ID och få tillbaka ett lämpligt svar utan att servern kör begäran flera gånger. Värdet för Repeatability-Request-ID är en täckande sträng som representerar en klientgenererad, globalt unik för hela tiden, identifierare för begäran. Vi rekommenderar att du använder UUID:erna i version 4 (slumpmässigt).
Repeatability-First-Sent		string date-time-rfc1123	Om Repeatability-Request-ID-header anges måste även rubriken Repeatability-First-Sent anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av HTTP-datum i IMF-fixdate-form.

Begärandetext

Name	Typ	Description
participants	<string,  ParticipantProperties>	(Valfritt) Deltagare som ska bjudas in till rummet.
pstnDialOutEnabled	boolean	Ange den här flaggan till true om du vid tidpunkten för samtalet har aktiverat uppringning till ett PSTN-nummer i ett visst rum. Standardvärdet för flaggan är False.
validFrom	string	Tidsstämpeln från när rummet är öppet för anslutning. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ. Standardvärdet är den aktuella datumtiden.
validUntil	string	Tidsstämpeln från när rummet inte längre kan kopplas. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ. Standardvärdet är den aktuella datumtiden plus 180 dagar.

Svar

Name	Typ	Description
201 Created	RoomModel	Begäran lyckades. Åtgärden returnerar ett nytt rum.
Other Status Codes	CommunicationErrorResponse	Felsvar Headers x-ms-error-code: string

Säkerhet

Authorization

En autentiseringssträng som innehåller en signatur som genereras med HMAC-SHA256-schema.

Type: apiKey
In: header

Exempel

Create a new meeting room.

Sample Request

HTTP

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

Sample Response

Status code:

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
}

Definitioner

Name	Description
CreateRoomRequest	Begär nyttolast för att skapa ett nytt rum.
ParticipantProperties
Role	Rollen som rumsdeltagare. Standardvärdet är Deltagare.
RoomModel	Mötesrummet.

CreateRoomRequest

Begär nyttolast för att skapa ett nytt rum.

Name	Typ	Description
participants	<string,  ParticipantProperties>	(Valfritt) Deltagare som ska bjudas in till rummet.
pstnDialOutEnabled	boolean	Ange den här flaggan till true om du vid tidpunkten för samtalet har aktiverat uppringning till ett PSTN-nummer i ett visst rum. Standardvärdet för flaggan är False.
validFrom	string	Tidsstämpeln från när rummet är öppet för anslutning. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ. Standardvärdet är den aktuella datumtiden.
validUntil	string	Tidsstämpeln från när rummet inte längre kan kopplas. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ. Standardvärdet är den aktuella datumtiden plus 180 dagar.

ParticipantProperties

Name	Typ	Description
role	Role	Rollen som rumsdeltagare. Standardvärdet är Deltagare.

Role

Rollen som rumsdeltagare. Standardvärdet är Deltagare.

Name	Typ	Description
Attendee	string
Consumer	string
Presenter	string

RoomModel

Mötesrummet.

Name	Typ	Description
createdAt	string	Tidsstämpeln när rummet skapades på servern. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
id	string	Unik identifierare för ett rum. Det här ID:t genereras av servern.
pstnDialOutEnabled	boolean	Ange den här flaggan till true om du vid tidpunkten för samtalet har aktiverat uppringning till ett PSTN-nummer i ett visst rum. Standardvärdet för flaggan är False.
validFrom	string	Tidsstämpeln från när rummet är öppet för anslutning. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
validUntil	string	Tidsstämpeln från när rummet inte längre kan kopplas. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.