Rooms - Remove Participants

Layanan:

Communication

Versi API:

2022-02-01

Menghapus peserta dari ruangan.

POST {endpoint}/rooms/{roomId}/participants:remove?api-version=2022-02-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir sumber daya Azure Communication.
roomId	path	True	string	Id ruang untuk menghapus peserta.
api-version	query	True	string	Versi API yang akan dipanggil.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Authorization	True	string	Token akses pengguna ACS (Azure Communication Services).

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
participants	True	RoomParticipant[]	Peserta yang akan dihapus dari ruangan.

Respons

Nama	Jenis	Deskripsi
200 OK	ParticipantsCollection	Peserta berhasil dihapus. Tindakan mengembalikan daftar peserta yang diperbarui.
Other Status Codes	CommunicationErrorResponse	Respons kesalahan Header x-ms-error-code: string

Keamanan

Authorization

Token akses pengguna ACS (Azure Communication Services).

Jenis: apiKey
Dalam: header

Contoh

Remove participant

Permintaan sampel

HTTP

POST https://contoso.communication.azure.com//rooms/99199690362660524/participants:remove?api-version=2022-02-01

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666"
        }
      },
      "role": "Presenter"
    }
  ]
}

Respon sampel

Kode status:

200

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777"
        }
      },
      "role": "Attendee"
    }
  ]
}

Definisi

Nama	Deskripsi
CommunicationIdentifierModel	Mengidentifikasi peserta dalam layanan Azure Communication. Peserta adalah, misalnya, pengguna komunikasi Azure. Model ini harus ditafsirkan sebagai penyatuan: Selain rawId, paling banyak satu properti lebih lanjut dapat diatur.
ParticipantsCollection	Kumpulan peserta di sebuah ruangan.
RemoveParticipantsRequest	Peserta yang akan dihapus dari ruangan.
RoleType	Peran peserta ruangan.
RoomParticipant	Peserta ruangan.

CommunicationIdentifierModel

Objek

Mengidentifikasi peserta dalam layanan Azure Communication. Peserta adalah, misalnya, pengguna komunikasi Azure. Model ini harus ditafsirkan sebagai penyatuan: Selain rawId, paling banyak satu properti lebih lanjut dapat diatur.

Nama	Jenis	Deskripsi
communicationUser	CommunicationUserIdentifierModel
rawId	string	Id mentah pengidentifikasi. Opsional dalam permintaan, diperlukan sebagai respons.

ParticipantsCollection

Objek

Kumpulan peserta di sebuah ruangan.

Nama	Jenis	Deskripsi
participants	RoomParticipant[]	Peserta Kamar.

RemoveParticipantsRequest

Objek

Peserta yang akan dihapus dari ruangan.

Nama	Jenis	Deskripsi
participants	RoomParticipant[]	Peserta yang akan dihapus dari ruangan.

RoleType

Enumeration

Peran peserta ruangan.

Nilai	Deskripsi
Presenter
Attendee
Consumer

RoomParticipant

Objek

Peserta ruangan.

Nama	Jenis	Deskripsi
communicationIdentifier	CommunicationIdentifierModel	Mengidentifikasi peserta dalam layanan Azure Communication. Peserta adalah, misalnya, pengguna komunikasi Azure. Model ini harus ditafsirkan sebagai penyatuan: Selain rawId, paling banyak satu properti lebih lanjut dapat diatur.
role	RoleType	Peran peserta ruangan.