Rooms - Remove Participants

Dienst:

Communication

API-Version:

2022-02-01

Entfernen sie Teilnehmer aus einem Chatroom.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Der Endpunkt der Azure Communication-Ressource.
roomId	path	True	string	Raum-ID, um die Teilnehmer zu entfernen.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
participants	True	RoomParticipant[]	Teilnehmer, die aus einem Raum entfernt werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	ParticipantsCollection	Die Teilnehmer wurden erfolgreich gelöscht. Die Aktion gibt eine aktualisierte Liste der Teilnehmer zurück.
Other Status Codes	CommunicationErrorResponse	Fehlerantwort Header x-ms-error-code: string

Sicherheit

Authorization

Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

Remove participant

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CommunicationIdentifierModel	Identifiziert einen Teilnehmer an Azure Communication Services. Ein Teilnehmer ist beispielsweise ein Azure-Kommunikationsbenutzer. Dieses Modell muss als Vereinigung interpretiert werden: Abgesehen von rawId kann eine weitere Eigenschaft festgelegt werden.
ParticipantsCollection	Sammlung von Teilnehmern in einem Raum.
RemoveParticipantsRequest	Teilnehmer, die aus einem Raum entfernt werden sollen.
RoleType	Die Rolle eines Raumteilnehmers.
RoomParticipant	Ein Teilnehmer des Raums.

CommunicationIdentifierModel

Objekt

Identifiziert einen Teilnehmer an Azure Communication Services. Ein Teilnehmer ist beispielsweise ein Azure-Kommunikationsbenutzer. Dieses Modell muss als Vereinigung interpretiert werden: Abgesehen von rawId kann eine weitere Eigenschaft festgelegt werden.

Name	Typ	Beschreibung
communicationUser	CommunicationUserIdentifierModel
rawId	string	Unformatierte ID des Bezeichners. Optional in Anforderungen, die in Antworten erforderlich sind.

ParticipantsCollection

Objekt

Sammlung von Teilnehmern in einem Raum.

Name	Typ	Beschreibung
participants	RoomParticipant[]	Raumteilnehmer.

RemoveParticipantsRequest

Objekt

Teilnehmer, die aus einem Raum entfernt werden sollen.

Name	Typ	Beschreibung
participants	RoomParticipant[]	Teilnehmer, die aus einem Raum entfernt werden sollen.

RoleType

Enumeration

Die Rolle eines Raumteilnehmers.

Wert	Beschreibung
Presenter
Attendee
Consumer

RoomParticipant

Objekt

Ein Teilnehmer des Raums.

Name	Typ	Beschreibung
communicationIdentifier	CommunicationIdentifierModel	Identifiziert einen Teilnehmer an Azure Communication Services. Ein Teilnehmer ist beispielsweise ein Azure-Kommunikationsbenutzer. Dieses Modell muss als Vereinigung interpretiert werden: Abgesehen von rawId kann eine weitere Eigenschaft festgelegt werden.
role	RoleType	Die Rolle eines Raumteilnehmers.