Share via

Call Connection - Remove Participant

Service:
Communication
API Version:
2025-06-15

Remove a participant from the call using identifier.

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

URI Parameters

Name In Required Type Description
callConnectionId
 path True

string

The call connection id.
endpoint
 path True

string (url)

The endpoint of the Azure Communication resource.
api-version
 query True

string

Version of API to invoke.

Request Header

Name Required Type Description
Authorization True

string

An Azure Communication Services user access token.
Repeatability-Request-ID

string (uuid)

If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated unique identifier for the request. It is a version 4 (random) UUID.
Repeatability-First-Sent

string (date-time-rfc1123)

If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.

Request Body

Name Required Type Description
participantToRemove True

CommunicationIdentifierModel

operationCallbackUri

string

Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext

string

Used by customers when calling mid-call actions to correlate the request to the response event.

Responses

Name Type Description
202 Accepted

RemoveParticipantResponse

The service has accepted the remove participant request and will begin processing it. You will receive either RemoveParticipantSucceeded or RemoveParticipantFailed event at your specified callback URI to update you on the status of the request.
Other Status Codes

CommunicationErrorResponse

Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_RemoveParticipant

Sample request

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

Definitions

Name Description
RemoveParticipantRequest

The remove participant by identifier request.
RemoveParticipantResponse

The response payload for removing participants of the call.

RemoveParticipantRequest

Object

The remove participant by identifier request.

Name Type Description
operationCallbackUri

string

Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.
operationContext

string

Used by customers when calling mid-call actions to correlate the request to the response event.
participantToRemove

CommunicationIdentifierModel

RemoveParticipantResponse

Object

The response payload for removing participants of the call.

Name Type Description
operationContext

string

The operation context provided by client.