Call Connection - Cancel Add Participant

Referens

Tjänst:: Communication

API-version:: 2023-10-15

Avbryt åtgärden lägg till deltagare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
callConnectionId	path	True	string	Samtalsanslutnings-ID
endpoint	path	True	string url	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En Azure Communication Services användaråtkomsttoken.
Repeatability-Request-ID		string uuid	Om detta anges dirigerar klienten att begäran kan upprepas. Det vill säga att klienten kan göra begäran flera gånger med samma Repeatability-Request-ID och få tillbaka ett lämpligt svar utan att servern kör begäran flera gånger. Värdet för Repeatability-Request-Id är en täckande sträng som representerar en klientgenererad unik identifierare för begäran. Det är en UUID-version 4 (slumpmässig).
Repeatability-First-Sent		string date-time-rfc1123	Om Repeatability-Request-ID-huvudet anges måste även huvudet Repeatability-First-Sent anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av DEN IMF-fixdate formen av HTTP-datum. Exempel: Sön, 06 nov 1994 08:49:37 GMT.

Begärandetext

Name	Obligatorisk	Typ	Description
invitationId	True	string	Inbjudnings-ID som används för att lägga till en deltagare.
operationCallbackUri		string	Ange en motringnings-URI som åsidosätter standardåteranrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte anges används standardåteranrops-URI:n som anges av CreateCall/AnswerCall.
operationContext		string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.

Svar

Name	Typ	Description
202 Accepted	CancelAddParticipantResponse	Returnerar svaret cancelAddParticipant
Other Status Codes	CommunicationErrorResponse	Fel

Säkerhet

Authorization

En Azure Communication Services användaråtkomsttoken.

Typ: apiKey
I: header

Exempel

CallConnection_CancelAddParticipant

Exempelbegäran

HTTP

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

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

Exempelsvar

Statuskod:: 202

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

Definitioner

Name	Description
CancelAddParticipantRequest	Begär nyttolast för att avbryta lägg till deltagarbegäran.
CancelAddParticipantResponse	Svarsnyttolast för att avbryta begäran om att lägga till deltagare.

CancelAddParticipantRequest

Begär nyttolast för att avbryta lägg till deltagarbegäran.

Name	Typ	Description
invitationId	string	Inbjudnings-ID som används för att lägga till en deltagare.
operationCallbackUri	string	Ange en motringnings-URI som åsidosätter standardåteranrops-URI:n som angetts av CreateCall/AnswerCall för den här åtgärden. Den här konfigurationen är per åtgärd. Om detta inte anges används standardåteranrops-URI:n som anges av CreateCall/AnswerCall.
operationContext	string	Används av kunder när de anropar mellansamtalsåtgärder för att korrelera begäran till svarshändelsen.

CancelAddParticipantResponse

Svarsnyttolast för att avbryta begäran om att lägga till deltagare.

Name	Typ	Description
invitationId	string	Inbjudnings-ID som används för att avbryta åtgärden lägg till deltagare.
operationContext	string	Åtgärdskontexten som tillhandahålls av klienten.

Dela via