Call Connection - Remove Participant

Riferimento

Service:: Communication

API Version:: 2023-10-15

Rimuovere un partecipante dalla chiamata usando l'identificatore.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:remove?api-version=2023-10-15

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
callConnectionId	path	True	string	ID connessione di chiamata.
endpoint	path	True	string url	Endpoint della risorsa di comunicazione di Azure.
api-version	query	True	string	Versione dell'API da richiamare.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Token di accesso utente Servizi di comunicazione di Azure.
Repeatability-Request-ID		string uuid	Se specificato, il client indirizza che la richiesta è ripetibile; vale a dire che il client può effettuare la richiesta più volte con lo stesso ID richiesta ripetibilità e recuperare una risposta appropriata senza che il server eseva la richiesta più volte. Il valore di Repeatability-Request-Id è una stringa opaca che rappresenta un identificatore univoco generato dal client per la richiesta. È una versione 4 (casuale) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Se viene specificata l'intestazione Repeatability-Request-ID, è necessario specificare anche l'intestazione Repeatability-First-Sent. Il valore deve essere la data e l'ora in cui è stata creata la richiesta, espressa usando il formato FMI-fixdate di data HTTP. Esempio: Sun, 06 novembre 1994 08:49:37 GMT.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Impostare un URI di callback che esegue l'override dell'URI di callback predefinito impostato da CreateCall/AnswerCall per questa operazione. Questa configurazione è per azione. Se non è impostato, verrà usato l'URI di callback predefinito impostato da CreateCall/AnswerCall.
operationContext		string	Usato dai clienti quando si chiamano azioni di chiamata media per correlare la richiesta all'evento di risposta.

Risposte

Nome	Tipo	Descrizione
202 Accepted	RemoveParticipantResponse	Il servizio ha accettato la richiesta di rimozione del partecipante e inizierà l'elaborazione. Si riceverà l'evento RemoveParticipantSucceeded o RemoveParticipantFailed nell'URI di callback specificato per aggiornare lo stato della richiesta.
Other Status Codes	CommunicationErrorResponse	Errore

Sicurezza

Authorization

Token di accesso utente Servizi di comunicazione di Azure.

Type: apiKey
In: header

Esempio

CallConnection_RemoveParticipant

Sample Request

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:remove?api-version=2023-10-15

{
  "participantToRemove": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "removing participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Sample Response

Status code:: 202

{
  "operationContext": "removing participant"
}

Definizioni

Nome	Descrizione
RemoveParticipantRequest	Richiesta di rimozione del partecipante in base all'identificatore.
RemoveParticipantResponse	Payload della risposta per rimuovere i partecipanti della chiamata.

RemoveParticipantRequest

Richiesta di rimozione del partecipante in base all'identificatore.

Nome	Tipo	Descrizione
operationCallbackUri	string	Impostare un URI di callback che esegue l'override dell'URI di callback predefinito impostato da CreateCall/AnswerCall per questa operazione. Questa configurazione è per azione. Se non è impostato, verrà usato l'URI di callback predefinito impostato da CreateCall/AnswerCall.
operationContext	string	Usato dai clienti quando si chiamano azioni di chiamata media per correlare la richiesta all'evento di risposta.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Payload della risposta per rimuovere i partecipanti della chiamata.

Nome	Tipo	Descrizione
operationContext	string	Contesto dell'operazione fornito dal client.

Share via