Call Connection - Cancel Add Participant

Referenz

Dienst:: Communication

API-Version:: 2024-09-15

Abbrechen des Vorgangs zum Hinzufügen von Teilnehmern.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:cancelAddParticipant?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
invitationId	True	string	Einladungs-ID zum Hinzufügen eines Teilnehmers.
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	CancelAddParticipantResponse	Gibt die cancelAddParticipant-Antwort zurück.
Other Status Codes	CommunicationErrorResponse	Fehler

Sicherheit

Authorization

Ein Azure Communication Services-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

CallConnection_CancelAddParticipant

Beispielanforderung

HTTP

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

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

Beispiel für eine Antwort

Statuscode:: 202

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

Definitionen

Name	Beschreibung
CancelAddParticipantRequest	Anforderungsnutzlast zum Abbrechen der Anforderung zum Hinzufügen von Teilnehmern.
CancelAddParticipantResponse	Antwortnutzlast zum Abbrechen der Anforderung zum Hinzufügen eines Teilnehmers.

CancelAddParticipantRequest

Anforderungsnutzlast zum Abbrechen der Anforderung zum Hinzufügen von Teilnehmern.

Name	Typ	Beschreibung
invitationId	string	Einladungs-ID zum Hinzufügen eines Teilnehmers.
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.

CancelAddParticipantResponse

Antwortnutzlast zum Abbrechen der Anforderung zum Hinzufügen eines Teilnehmers.

Name	Typ	Beschreibung
invitationId	string	Einladungs-ID zum Abbrechen der Aktion "Teilnehmer hinzufügen".
operationContext	string	Der vom Client bereitgestellte Vorgangskontext.

Freigeben über