Call Connection - Remove Participant

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Entfernen Sie einen Teilnehmer aus dem Anruf mithilfe des Bezeichners.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
callConnectionId	path	True	string	Die Anrufverbindungs-ID.
endpoint	path	True	string url	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services-Benutzerzugriffstoken.
Repeatability-Request-ID		string uuid	Wenn angegeben, leitet der Client an, dass die Anforderung wiederholbar ist; d. h., dass der Client die Anforderung mehrmals mit derselben Wiederholbarkeit vornehmen kann–Request-Id und eine entsprechende Antwort zurückzuholen, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeit-Request-Id ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine Version 4 (zufällig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Wenn "Repeatability-Request-ID Header" angegeben ist, muss auch "Repeatability"First-Sent Header angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, zu dem die Anforderung zuerst erstellt wurde, ausgedrückt mithilfe des IMF-Fixdate-Formulars des HTTP-Datums. Beispiel: Sun, 06 Nov 1994 08:49:37 GMT.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext		string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.

Antworten

Name	Typ	Beschreibung
202 Accepted	RemoveParticipantResponse	Der Dienst hat die Anforderung zum Entfernen von Teilnehmern akzeptiert und beginnt mit der Verarbeitung. Sie erhalten entweder "RemoveParticipantSucceeded" oder "RemoveParticipantFailed"-Ereignis bei Ihrem angegebenen Rückruf-URI, um Sie über den Status der Anforderung zu aktualisieren.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallConnection_RemoveParticipant

Beispielanforderung

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c/participants:remove?api-version=2024-09-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"
}

Beispiel für eine Antwort

Statuscode:: 202

{
  "operationContext": "removing participant"
}

Definitionen

Name	Beschreibung
RemoveParticipantRequest	Der Teilnehmer nach Id-Anforderung entfernen.
RemoveParticipantResponse	Die Antwortnutzlast zum Entfernen der Teilnehmer des Anrufs.

RemoveParticipantRequest

Der Teilnehmer nach Id-Anforderung entfernen.

Name	Typ	Beschreibung
operationCallbackUri	string	Legen Sie einen Rückruf-URI fest, der den von CreateCall/AnswerCall für diesen Vorgang festgelegten Standardrückruf-URI außer Kraft setzt. Diese Einrichtung erfolgt pro Aktion. Wenn dies nicht festgelegt ist, wird der von CreateCall/AnswerCall festgelegte Standardrückruf-URI verwendet.
operationContext	string	Wird von Kunden beim Aufrufen von Mid-Call-Aktionen verwendet, um die Anforderung mit dem Antwortereignis zu korrelieren.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Die Antwortnutzlast zum Entfernen der Teilnehmer des Anrufs.

Name	Typ	Beschreibung
operationContext	string	Der vom Client bereitgestellte Vorgangskontext.

Freigeben über