Rooms - Remove Participants

Szolgáltatás:

Communication

API-verzió:

2022-02-01

Résztvevők eltávolítása egy szobából.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	Az Azure Communication-erőforrás végpontja.
roomId	path	True	string	Szobaazonosító a résztvevők eltávolításához.
api-version	query	True	string	A meghívandó API verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
Authorization	True	string	ACS (Azure Communication Services) felhasználói hozzáférési jogkivonat.

Kérelem törzse

Name	Kötelező	Típus	Description
participants	True	RoomParticipant[]	A résztvevőket el kell távolítani egy szobából.

Válaszok

Name	Típus	Description
200 OK	ParticipantsCollection	A résztvevőket sikeresen törölték. A művelet a résztvevők frissített listáját adja vissza.
Other Status Codes	CommunicationErrorResponse	Hibaválasz Fejlécek x-ms-error-code: string

Biztonság

Authorization

ACS (Azure Communication Services) felhasználói hozzáférési jogkivonat.

Típus: apiKey
In: header

Példák

Remove participant

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
CommunicationIdentifierModel	Azonosítja a résztvevőket az Azure Communication Servicesben. A résztvevők például azure-beli kommunikációs felhasználók. Ezt a modellt egyesítőként kell értelmezni: a rawId mellett legfeljebb egy további tulajdonság állítható be.
ParticipantsCollection	Résztvevők gyűjteménye egy szobában.
RemoveParticipantsRequest	A résztvevőket el kell távolítani egy szobából.
RoleType	A szoba résztvevőinek szerepe.
RoomParticipant	A szoba egyik résztvevője.

CommunicationIdentifierModel

Objektum

Azonosítja a résztvevőket az Azure Communication Servicesben. A résztvevők például azure-beli kommunikációs felhasználók. Ezt a modellt egyesítőként kell értelmezni: a rawId mellett legfeljebb egy további tulajdonság állítható be.

Name	Típus	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	Az azonosító nyers azonosítója. Nem kötelező a kérelmekben, a válaszokban kötelező megadni.

ParticipantsCollection

Objektum

Résztvevők gyűjteménye egy szobában.

Name	Típus	Description
participants	RoomParticipant[]	Szoba résztvevői.

RemoveParticipantsRequest

Objektum

A résztvevőket el kell távolítani egy szobából.

Name	Típus	Description
participants	RoomParticipant[]	A résztvevőket el kell távolítani egy szobából.

RoleType

Enumerálás

A szoba résztvevőinek szerepe.

Érték	Description
Presenter
Attendee
Consumer

RoomParticipant

Objektum

A szoba egyik résztvevője.

Name	Típus	Description
communicationIdentifier	CommunicationIdentifierModel	Azonosítja a résztvevőket az Azure Communication Servicesben. A résztvevők például azure-beli kommunikációs felhasználók. Ezt a modellt egyesítőként kell értelmezni: a rawId mellett legfeljebb egy további tulajdonság állítható be.
role	RoleType	A szoba résztvevőinek szerepe.