participant: mute
Namespace: microsoft.graph
Mute a specific participant in the call.
This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio.
For more information about how to handle mute operations, see muteParticipantOperation.
Note: This method is only supported for group calls.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Not Supported |
| Delegated (personal Microsoft account) | Not Supported |
| Application | Calls.JoinGroupCallsasGuest.All or Calls.JoinGroupCalls.All |
HTTP request
POST /communications/calls/{id}/participants/{id}/mute
Request headers
| Name | Description |
|---|---|
| Authorization | Bearer {token}. Required. |
| Content-type | application/json. Required. |
Request body
In the request body, provide a JSON object with the following parameters.
| Parameter | Type | Description |
|---|---|---|
| clientContext | String | Unique Client Context string. Max limit is 256 chars. |
Response
If successful, this method returns a 200 OK response code and a muteParticipantOperation object in the response body.
Note: When this API returns a successful response, all participants will receive a roster update.
Example - Mute specific participant
The following example shows how to call this API.
Request
The following example shows the request.
POST https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/participants/2765eb15-01f8-47c6-b12b-c32111a4a86f/mute
Content-Type: application/json
{
"clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Location: https://graph.microsoft.com/v1.0/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/operations/17e3b46c-f61d-4f4d-9635-c626ef18e6ad
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.muteParticipantOperation",
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#muteParticipantOperation",
"id": "17e3b46c-f61d-4f4d-9635-c626ef18e6ad",
"status": "completed",
"clientContext": "d45324c1-fcb5-430a-902c-f20af696537c"
}
Notification - roster updated with participant muted
POST https://bot.contoso.com/api/calls
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.commsNotifications",
"value": [
{
"@odata.type": "#microsoft.graph.commsNotification",
"changeType": "updated",
"resourceUrl": "/communications/calls/57dab8b1-894c-409a-b240-bd8beae78896/participants",
"resourceData": [
{
"@odata.type": "#microsoft.graph.participant",
"id": "2765eb15-01f8-47c6-b12b-c32111a4a86f",
"info": {
"identity": {
"user": {
"displayName": "Bob",
"id": "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96"
}
},
"region": "westus",
"languageId": "en-US"
},
"mediaStreams": [
{
"mediaType": "audio",
"label": "main-audio",
"sourceId": "1",
"direction": "sendReceive"
}
],
"isMuted": true, // will be set to true on mute
"isInLobby": false
}
]
}
]
}
Feedback
Submit and view feedback for