Call Connection - Mute

Reference

Service:: Communication

API Version:: 2024-09-15

Mute participants from the call using identifier.

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:mute?api-version=2024-09-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
targetParticipants	True	CommunicationIdentifierModel[]	Participants to be muted from the call. Only ACS Users are supported.
operationContext		string	Used by customers when calling mid-call actions to correlate the request to the response event.

Responses

Name	Type	Description
200 OK	MuteParticipantsResult	Returns the mute participants response
Other Status Codes	CommunicationErrorResponse	Error

Security

Authorization

An Azure Communication Services user access token.

Type: apiKey
In: header

Examples

CallConnection_Mute

Sample request

HTTP

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

{
  "targetParticipants": [
    {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
      }
    }
  ],
  "operationContext": "mute participant"
}

Sample response

Status code:: 200

{
  "operationContext": "mute participant"
}

Definitions

Name	Description
MuteParticipantsRequest	The request payload for muting participants from the call.
MuteParticipantsResult	The result payload for muting participants from the call.

MuteParticipantsRequest

The request payload for muting participants from the call.

Name	Type	Description
operationContext	string	Used by customers when calling mid-call actions to correlate the request to the response event.
targetParticipants	CommunicationIdentifierModel[]	Participants to be muted from the call. Only ACS Users are supported.

MuteParticipantsResult

The result payload for muting participants from the call.

Name	Type	Description
operationContext	string	The operation context provided by client.

Share via