Rooms - Create

Layanan:

Communication

Versi API:

2025-03-13

Membuat ruang baru.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (url)	Titik akhir sumber daya Azure Communication.
api-version	query	True	string	Versi API yang akan dipanggil.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Authorization	True	string	String autentikasi yang berisi tanda tangan yang dihasilkan menggunakan skema HMAC-SHA256.
Repeatability-Request-ID		string (uuid)	Jika ditentukan, klien mengarahkan bahwa permintaan dapat diulang; artinya, klien dapat membuat permintaan beberapa kali dengan Pengulangan yang sama-Request-ID dan mendapatkan kembali respons yang sesuai tanpa server yang menjalankan permintaan beberapa kali. Nilai pengulangan-Request-ID adalah string buram yang mewakili yang dihasilkan klien, unik secara global untuk semua waktu, pengidentifikasi untuk permintaan tersebut. Disarankan untuk menggunakan UUID versi 4 (acak).
Repeatability-First-Sent		string (date-time-rfc1123)	Jika Pengulangan- headerRequest-ID ditentukan, header Pengulangan-First-Sent juga harus ditentukan. Nilai harus berupa tanggal dan waktu saat permintaan pertama kali dibuat, dinyatakan menggunakan bentuk tanggal HTTP tetap IMF.

Isi Permintaan

Nama	Jenis	Deskripsi
participants	<string,  ParticipantProperties>	(Opsional) Peserta yang akan diundang ke ruangan.
pstnDialOutEnabled	boolean	Atur bendera ini ke true jika, pada saat panggilan, putar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.
validFrom	string (date-time)	Tanda waktu dari ketika ruangan terbuka untuk bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Nilai default adalah waktu tanggal saat ini.
validUntil	string (date-time)	Tanda waktu dari ketika ruangan tidak dapat lagi bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Nilai default adalah waktu tanggal saat ini ditambah 180 hari.

Respons

Nama	Jenis	Deskripsi
201 Created	RoomModel	Permintaan berhasil. Tindakan mengembalikan ruang baru.
Other Status Codes	CommunicationErrorResponse	Respons kesalahan Header x-ms-error-code: string

Keamanan

Authorization

String autentikasi yang berisi tanda tangan yang dihasilkan menggunakan skema HMAC-SHA256.

Jenis: apiKey
Dalam: header

Contoh

Create a new meeting room.

Permintaan sampel

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

Respon sampel

Kode status:

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
}

Definisi

Nama	Deskripsi
CreateRoomRequest	Minta payload untuk membuat ruang baru.
ParticipantProperties
Role	Peran peserta ruangan. Nilai defaultnya adalah Attendee.
RoomModel	Ruang rapat.

CreateRoomRequest

Objek

Minta payload untuk membuat ruang baru.

Nama	Jenis	Deskripsi
participants	<string,  ParticipantProperties>	(Opsional) Peserta yang akan diundang ke ruangan.
pstnDialOutEnabled	boolean	Atur bendera ini ke true jika, pada saat panggilan, putar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.
validFrom	string (date-time)	Tanda waktu dari ketika ruangan terbuka untuk bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Nilai default adalah waktu tanggal saat ini.
validUntil	string (date-time)	Tanda waktu dari ketika ruangan tidak dapat lagi bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ. Nilai default adalah waktu tanggal saat ini ditambah 180 hari.

ParticipantProperties

Objek

Nama	Jenis	Deskripsi
role	Role	Peran peserta ruangan. Nilai defaultnya adalah Attendee.

Role

Enumeration

Peran peserta ruangan. Nilai defaultnya adalah Attendee.

Nilai	Deskripsi
Presenter
Attendee
Consumer
Collaborator

RoomModel

Objek

Ruang rapat.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu ketika ruangan dibuat di server. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	Pengidentifikasi unik ruangan. Id ini adalah server yang dihasilkan.
pstnDialOutEnabled	boolean	Atur bendera ini ke true jika, pada saat panggilan, putar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.
validFrom	string (date-time)	Tanda waktu dari ketika ruangan terbuka untuk bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ.
validUntil	string (date-time)	Tanda waktu dari ketika ruangan tidak dapat lagi bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ.