Rooms - Remove Participants

Servizio:

Communication

Versione API:

2022-02-01

Rimuovere i partecipanti da una stanza.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Endpoint della risorsa di comunicazione di Azure.
roomId	path	True	string	ID sala da cui rimuovere i partecipanti.
api-version	query	True	string	Versione dell'API da richiamare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
participants	True	RoomParticipant[]	Partecipanti da rimuovere da una stanza.

Risposte

Nome	Tipo	Descrizione
200 OK	ParticipantsCollection	I partecipanti sono stati eliminati correttamente. L'azione restituisce un elenco aggiornato di partecipanti.
Other Status Codes	CommunicationErrorResponse	Risposta di errore Intestazioni x-ms-error-code: string

Sicurezza

Authorization

Un token di accesso utente ACS (Servizi di comunicazione di Azure).

Tipo: apiKey
In: header

Esempio

Remove participant

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
CommunicationIdentifierModel	Identifica un partecipante ai servizi di comunicazione di Azure. Un partecipante, ad esempio, è un utente di comunicazione di Azure. Questo modello deve essere interpretato come unione: a parte rawId, è possibile impostare al massimo un'altra proprietà.
ParticipantsCollection	Raccolta di partecipanti in una sala.
RemoveParticipantsRequest	Partecipanti da rimuovere da una stanza.
RoleType	Ruolo di un partecipante alla sala.
RoomParticipant	Partecipante della sala.

CommunicationIdentifierModel

Object

Identifica un partecipante ai servizi di comunicazione di Azure. Un partecipante, ad esempio, è un utente di comunicazione di Azure. Questo modello deve essere interpretato come unione: a parte rawId, è possibile impostare al massimo un'altra proprietà.

Nome	Tipo	Descrizione
communicationUser	CommunicationUserIdentifierModel
rawId	string	ID non elaborato dell'identificatore. Facoltativo nelle richieste, obbligatorio nelle risposte.

ParticipantsCollection

Object

Raccolta di partecipanti in una sala.

Nome	Tipo	Descrizione
participants	RoomParticipant[]	Partecipanti alla sala.

RemoveParticipantsRequest

Object

Partecipanti da rimuovere da una stanza.

Nome	Tipo	Descrizione
participants	RoomParticipant[]	Partecipanti da rimuovere da una stanza.

RoleType

Enumerazione

Ruolo di un partecipante alla sala.

Valore	Descrizione
Presenter
Attendee
Consumer

RoomParticipant

Object

Partecipante della sala.

Nome	Tipo	Descrizione
communicationIdentifier	CommunicationIdentifierModel	Identifica un partecipante ai servizi di comunicazione di Azure. Un partecipante, ad esempio, è un utente di comunicazione di Azure. Questo modello deve essere interpretato come unione: a parte rawId, è possibile impostare al massimo un'altra proprietà.
role	RoleType	Ruolo di un partecipante alla sala.