MidConnections

Remove a participant from the call using identifier.

Changed on

Remove a participant from the call using identifier.

post/calling/callConnections/{callConnectionId}/participants:remove

Request

  • Base URL
    https://contoso.communication.azure.com
  • Auth
    API key in header Authorization

Path parameters

callConnectionIdstring required

The call connection id.

Query parameters

api-versionstring required

Version of the API to invoke.

Headers

Repeatability-Request-IDstring 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-Sentstring 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

operationContextstring

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

operationCallbackUristring

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.

Response

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.

operationContextstring

The operation context provided by client.

Changes

  • 2022-04-07-previewd4d02a642780Revision changes
    • info

      api operation id CallConnections_RemoveParticipants removed and replaced with CallConnection_RemoveParticipant