Call Connection - Remove Participant

Referens

Service:: Communication

API Version:: 2023-10-15

Ta bort en deltagare från anropet med identifierare.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
callConnectionId	path	True	string	Samtalsanslutnings-ID: t.
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 det 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 version 4 (slumpmässig) UUID.
Repeatability-First-Sent		string date-time-rfc1123	Om Repeatability-Request-ID-header anges måste även rubriken Repeatability-First-Sent anges. Värdet ska vara det datum och den tid då begäran först skapades, uttryckt med hjälp av HTTP-datum i IMF-fixdate-form. Exempel: Sön, 06 nov 1994 08:49:37 GMT.

Begärandetext

Name	Obligatorisk	Typ	Description
participantToRemove	True	CommunicationIdentifierModel
operationCallbackUri		string	Ange en återanrops-URI som åsidosätter standardanrops-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 har angetts används standardåteranrops-URI:n som angetts 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	RemoveParticipantResponse	Tjänsten har accepterat begäran om att ta bort deltagare och börjar bearbeta den. Du får antingen RemoveParticipantSucceeded- eller RemoveParticipantFailed-händelsen vid din angivna återanrops-URI för att uppdatera dig om status för begäran.
Other Status Codes	CommunicationErrorResponse	Fel

Säkerhet

Authorization

En Azure Communication Services användaråtkomsttoken.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
RemoveParticipantRequest	Begäran om att ta bort deltagaren efter identifierare.
RemoveParticipantResponse	Svarsnyttolasten för att ta bort deltagarna i samtalet.

RemoveParticipantRequest

Begäran om att ta bort deltagaren efter identifierare.

Name	Typ	Description
operationCallbackUri	string	Ange en återanrops-URI som åsidosätter standardanrops-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 har angetts används standardåteranrops-URI:n som angetts 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.
participantToRemove	CommunicationIdentifierModel

RemoveParticipantResponse

Svarsnyttolasten för att ta bort deltagarna i samtalet.

Name	Typ	Description
operationContext	string	Åtgärdskontexten som tillhandahålls av klienten.

Share via