Rooms - Remove Participants

Služba:

Communication

Verze rozhraní API:

2022-02-01

Odeberte účastníky z místnosti.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod prostředku komunikace Azure.
roomId	path	True	string	ID místnosti pro odebrání účastníků.
api-version	query	True	string	Verze rozhraní API k vyvolání

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele ACS (Azure Communication Services).

Text požadavku

Name	Vyžadováno	Typ	Description
participants	True	RoomParticipant[]	Účastníci, kteří se mají odebrat z místnosti.

Odpovědi

Name	Typ	Description
200 OK	ParticipantsCollection	Účastníci byli úspěšně odstraněni. Akce vrátí aktualizovaný seznam účastníků.
Other Status Codes	CommunicationErrorResponse	Chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Authorization

Přístupový token uživatele ACS (Azure Communication Services).

Typ: apiKey
V: header

Příklady

Remove participant

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
    }
  ]
}

Definice

Name	Description
CommunicationIdentifierModel	Identifikuje účastníka ve službách Azure Communication Services. Účastník je například komunikační uživatel Azure. Tento model musí být interpretován jako sjednocení: Kromě rawId může být nastavena maximálně jedna další vlastnost.
ParticipantsCollection	Kolekce účastníků v místnosti
RemoveParticipantsRequest	Účastníci, kteří se mají odebrat z místnosti.
RoleType	Role účastníka místnosti.
RoomParticipant	Účastník místnosti.

CommunicationIdentifierModel

Objekt

Identifikuje účastníka ve službách Azure Communication Services. Účastník je například komunikační uživatel Azure. Tento model musí být interpretován jako sjednocení: Kromě rawId může být nastavena maximálně jedna další vlastnost.

Name	Typ	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	Nezpracované ID identifikátoru. Volitelné v požadavcích, které jsou požadovány v odpovědích.

ParticipantsCollection

Objekt

Kolekce účastníků v místnosti

Name	Typ	Description
participants	RoomParticipant[]	Účastníci místnosti.

RemoveParticipantsRequest

Objekt

Účastníci, kteří se mají odebrat z místnosti.

Name	Typ	Description
participants	RoomParticipant[]	Účastníci, kteří se mají odebrat z místnosti.

RoleType

Výčet

Role účastníka místnosti.

Hodnota	Description
Presenter
Attendee
Consumer

RoomParticipant

Objekt

Účastník místnosti.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel	Identifikuje účastníka ve službách Azure Communication Services. Účastník je například komunikační uživatel Azure. Tento model musí být interpretován jako sjednocení: Kromě rawId může být nastavena maximálně jedna další vlastnost.
role	RoleType	Role účastníka místnosti.