Bagikan melalui


Rooms - Create

Membuat ruang baru.

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

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 Repeatability-Request-ID yang sama dan mendapatkan kembali respons yang sesuai tanpa server menjalankan permintaan beberapa kali. Nilai Repeatability-Request-ID adalah string buram yang mewakili pengidentifikasi unik global yang dihasilkan klien untuk semua waktu. Disarankan untuk menggunakan UUID versi 4 (acak).

Repeatability-First-Sent

string

date-time-rfc1123

Jika header Repeatability-Request-ID ditentukan, header Repeatability-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, panggilan keluar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.

validFrom

string

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

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

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

Respon sampel

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

Definisi

Nama Deskripsi
CreateRoomRequest

Minta payload untuk membuat ruang baru.

ParticipantProperties
Role

Peran peserta ruangan. Nilai defaultnya adalah Peserta.

RoomModel

Ruang pertemuan.

CreateRoomRequest

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, panggilan keluar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.

validFrom

string

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

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

Nama Jenis Deskripsi
role

Role

Peran peserta ruangan. Nilai defaultnya adalah Peserta.

Role

Peran peserta ruangan. Nilai defaultnya adalah Peserta.

Nama Jenis Deskripsi
Attendee

string

Consumer

string

Presenter

string

RoomModel

Ruang pertemuan.

Nama Jenis Deskripsi
createdAt

string

Tanda waktu ketika ruang 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, panggilan keluar ke nomor PSTN diaktifkan di ruang tertentu. Secara default, bendera ini diatur ke false.

validFrom

string

Tanda waktu dari ketika ruangan terbuka untuk bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ.

validUntil

string

Tanda waktu dari ketika ruangan tidak dapat lagi bergabung. Tanda waktu dalam format RFC3339: yyyy-MM-ddTHH:mm:ssZ.