Skip to content

participant-muteall.md

Latest commit

 

History

History
146 lines (113 loc) · 4.84 KB

participant-muteall.md

File metadata and controls

146 lines (113 loc) · 4.84 KB
title participant: muteAll
description Mute all participants in the call.
author rahulva-msft
ms.localizationpriority medium
ms.subservice cloud-communications
doc_type apiPageType
ms.date 04/05/2024

participant: muteAll

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

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 headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json. Required.

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.

HTTP

POST https://graph.microsoft.com/beta/communications/calls/{id}/participants/muteAll
Content-Type: application/json
Content-Length: 81

{
  "participants": [
    ""
  ],
  "clientContext": "clientContext-value"
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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"
}