Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Mute all participants in the call.
Note: This API is deprecated and will be removed by March 15th, 2020. To mute a single participant, see participant: mute.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
Not supported. |
Not supported. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Calls.JoinGroupCall.All |
Calls.JoinGroupCallasGuest.All |
HTTP request
POST /app/calls/{id}/participants/muteAll
POST /communications/calls/{id}/participants/muteAll
Note: The /app path is deprecated. Going forward, use the /communications path.
Request body
In the request body, provide a JSON object with the following parameters.
| Parameter |
Type |
Description |
| participants |
String collection |
The participants to be muted. |
| clientContext |
String |
The client context. |
Response
If successful, this method returns a 200 OK response code and a commsOperation object in the response body.
Example
The following example shows how to call this API.
Request
The following example shows the request.
POST https://graph.microsoft.com/beta/communications/calls/{id}/participants/muteAll
Content-Type: application/json
Content-Length: 81
{
"participants": [
""
],
"clientContext": "clientContext-value"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Communications.Calls.Item.Participants.MuteAll;
var requestBody = new MuteAllPostRequestBody
{
Participants = new List<string>
{
"",
},
ClientContext = "clientContext-value",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Communications.Calls["{call-id}"].Participants.MuteAll.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphcommunications "github.com/microsoftgraph/msgraph-beta-sdk-go/communications"
//other-imports
)
requestBody := graphcommunications.NewMuteAllPostRequestBody()
participants := []string {
"",
}
requestBody.SetParticipants(participants)
clientContext := "clientContext-value"
requestBody.SetClientContext(&clientContext)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
muteAll, err := graphClient.Communications().Calls().ByCallId("call-id").Participants().MuteAll().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.communications.calls.item.participants.muteall.MuteAllPostRequestBody muteAllPostRequestBody = new com.microsoft.graph.beta.communications.calls.item.participants.muteall.MuteAllPostRequestBody();
LinkedList<String> participants = new LinkedList<String>();
participants.add("");
muteAllPostRequestBody.setParticipants(participants);
muteAllPostRequestBody.setClientContext("clientContext-value");
var result = graphClient.communications().calls().byCallId("{call-id}").participants().muteAll().post(muteAllPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const muteParticipantsOperation = {
participants: [
''
],
clientContext: 'clientContext-value'
};
await client.api('/communications/calls/{id}/participants/muteAll')
.version('beta')
.post(muteParticipantsOperation);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Communications\Calls\Item\Participants\MuteAll\MuteAllPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new MuteAllPostRequestBody();
$requestBody->setParticipants(['', ]);
$requestBody->setClientContext('clientContext-value');
$result = $graphServiceClient->communications()->calls()->byCallId('call-id')->participants()->muteAll()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.communications.calls.item.participants.mute_all.mute_all_post_request_body import MuteAllPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = MuteAllPostRequestBody(
participants = [
"",
],
client_context = "clientContext-value",
)
result = await graph_client.communications.calls.by_call_id('call-id').participants.mute_all.post(request_body)
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Location: https://graph.microsoft.com/beta/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/0fe0623f-d628-42ed-b4bd-8ac290072cc5
{
"@odata.type": "#microsoft.graph.commsOperation",
"clientContext": "clientContext-value",
"id": "0fe0623f-d628-42ed-b4bd-8ac290072cc5",
"resultInfo": null,
"status": "completed"
}