Call Connection - Remove Participant

Referenz

Service:: Communication

API Version:: 2023-10-15

Entfernen Sie einen Teilnehmer mithilfe des Bezeichners aus dem Anruf.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:remove?api-version=2023-10-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 aufgerufenen API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Azure Communication Services Benutzerzugriffstoken.
Repeatability-Request-ID		string uuid	Falls angegeben, leitet der Client an, dass die Anforderung wiederholbar ist. Das heißt, dass der Client die Anforderung mehrmals mit derselben Repeatability-Request-ID stellen und eine entsprechende Antwort zurückbekommt, ohne dass der Server die Anforderung mehrmals ausführt. Der Wert der Wiederholbarkeitsanforderungs-ID ist eine undurchsichtige Zeichenfolge, die einen vom Client generierten eindeutigen Bezeichner für die Anforderung darstellt. Es handelt sich um eine (zufällige) UUID der Version 4.
Repeatability-First-Sent		string date-time-rfc1123	Wenn der Header "Repeatability-Request-ID" angegeben ist, muss auch der Header "Repeatability-First-Sent" angegeben werden. Der Wert sollte das Datum und die Uhrzeit sein, an dem die Anforderung zum ersten Mal erstellt wurde, ausgedrückt mit der FORM "IMF-fixdate" von HTTP-date. Beispiel: So, 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 standardmäßigen Rückruf-URI von CreateCall/AnswerCall für diesen Vorgang außer Kraft setzt. Dieses Setup 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 des Teilnehmers akzeptiert und beginnt mit der Verarbeitung. Sie erhalten entweder das RemoveParticipantSucceed-Ereignis oder das RemoveParticipantFailed-Ereignis an Ihrem angegebenen Rückruf-URI, um Sie auf dem status der Anforderung zu aktualisieren.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services Benutzerzugriffstoken.

Type: apiKey
In: header

Beispiele

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

Definitionen

Name	Beschreibung
RemoveParticipantRequest	Die Anforderung "Teilnehmer nach Bezeichner entfernen".
RemoveParticipantResponse	Die Antwortnutzlast zum Entfernen der Teilnehmer des Anrufs.

RemoveParticipantRequest

Die Anforderung "Teilnehmer nach Bezeichner entfernen".

Name	Typ	Beschreibung
operationCallbackUri	string	Legen Sie einen Rückruf-URI fest, der den standardmäßigen Rückruf-URI von CreateCall/AnswerCall für diesen Vorgang außer Kraft setzt. Dieses Setup 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