Rooms - Remove Participants

Usługa:

Communication

Wersja interfejsu API:

2022-02-01

Usuń uczestników z pokoju.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Punkt końcowy zasobu usługi Azure Communication.
roomId	path	True	string	Identyfikator pokoju w celu usunięcia uczestników z.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług ACS (Azure Communication Services).

Treść żądania

Nazwa	Wymagane	Typ	Opis
participants	True	RoomParticipant[]	Uczestnicy zostaną usunięci z pokoju.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ParticipantsCollection	Uczestnicy zostali pomyślnie usunięci. Akcja zwraca zaktualizowaną listę uczestników.
Other Status Codes	CommunicationErrorResponse	Odpowiedź na błąd Nagłówki x-ms-error-code: string

Zabezpieczenia

Authorization

Token dostępu użytkownika usług ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Remove participant

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
CommunicationIdentifierModel	Identyfikuje uczestnika usług Azure Communication Services. Uczestnik jest na przykład użytkownikiem komunikacji platformy Azure. Ten model musi być interpretowany jako związek: oprócz parametru rawId można ustawić co najwyżej jedną kolejną właściwość.
ParticipantsCollection	Kolekcja uczestników w pokoju.
RemoveParticipantsRequest	Uczestnicy zostaną usunięci z pokoju.
RoleType	Rola uczestnika pokoju.
RoomParticipant	Uczestnik pokoju.

CommunicationIdentifierModel

Objekt

Identyfikuje uczestnika usług Azure Communication Services. Uczestnik jest na przykład użytkownikiem komunikacji platformy Azure. Ten model musi być interpretowany jako związek: oprócz parametru rawId można ustawić co najwyżej jedną kolejną właściwość.

Nazwa	Typ	Opis
communicationUser	CommunicationUserIdentifierModel
rawId	string	Nieprzetworzone identyfikatora. Opcjonalnie w żądaniach, wymagane w odpowiedziach.

ParticipantsCollection

Objekt

Kolekcja uczestników w pokoju.

Nazwa	Typ	Opis
participants	RoomParticipant[]	Uczestnicy pokoju.

RemoveParticipantsRequest

Objekt

Uczestnicy zostaną usunięci z pokoju.

Nazwa	Typ	Opis
participants	RoomParticipant[]	Uczestnicy zostaną usunięci z pokoju.

RoleType

Wyliczanie

Rola uczestnika pokoju.

Wartość	Opis
Presenter
Attendee
Consumer

RoomParticipant

Objekt

Uczestnik pokoju.

Nazwa	Typ	Opis
communicationIdentifier	CommunicationIdentifierModel	Identyfikuje uczestnika usług Azure Communication Services. Uczestnik jest na przykład użytkownikiem komunikacji platformy Azure. Ten model musi być interpretowany jako związek: oprócz parametru rawId można ustawić co najwyżej jedną kolejną właściwość.
role	RoleType	Rola uczestnika pokoju.