Rooms - Create

Tjänst:

Communication

API-version:

2025-03-13

Skapar ett nytt rum.

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

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 genererats med hjälp av 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 repeterbarhet –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 ogenomskinlig sträng som representerar en klientgenererad, globalt unik för hela tiden, identifierare för begäran. Vi rekommenderar att du använder UUID:er i version 4 (slumpmässigt).
Repeatability-First-Sent		string (date-time-rfc1123)	Om repeterbarhet –Request-ID rubrik anges måste även repeterbarhetFirst-Sent rubrik anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av IMF-fixdate-formen av HTTP-date.

Begärandetext

Name	Typ	Description
participants	<string,  ParticipantProperties>	(Valfritt) Deltagare som ska bjudas in till rummet.
pstnDialOutEnabled	boolean	Ställ in den här flaggan på sant om du vid tidpunkten för samtalet har aktiverat ett PSTN-nummer i ett visst rum. Som standard är den här flaggan inställd på false.
validFrom	string (date-time)	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 (date-time)	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 aktuell datumtid plus 180 dagar.

Svar

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

Säkerhet

Authorization

En autentiseringssträng som innehåller en signatur som genererats med hjälp av HMAC-SHA256 schema.

Typ: apiKey
I: header

Exempel

Create a new meeting room.

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

201

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

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

Objekt

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	Ställ in den här flaggan på sant om du vid tidpunkten för samtalet har aktiverat ett PSTN-nummer i ett visst rum. Som standard är den här flaggan inställd på false.
validFrom	string (date-time)	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 (date-time)	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 aktuell datumtid plus 180 dagar.

ParticipantProperties

Objekt

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

Role

Uppräkning

Rollen som rumsdeltagare. Standardvärdet är Deltagare.

Värde	Description
Presenter
Attendee
Consumer
Collaborator

RoomModel

Objekt

Mötesrummet.

Name	Typ	Description
createdAt	string (date-time)	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	Ställ in den här flaggan på sant om du vid tidpunkten för samtalet har aktiverat ett PSTN-nummer i ett visst rum. Som standard är den här flaggan inställd på false.
validFrom	string (date-time)	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 (date-time)	Tidsstämpeln från när rummet inte längre kan kopplas. Tidsstämpeln är i RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.