Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Muting or Unmuting All Participants
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Muting or Unmuting All Participants

Description

This API is used to mute or unmute all participants (except the host) in a meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/mute

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

X-Conference-Authorization

Yes

String

Header

Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.

isMute

Yes

Integer

Body
  • 0: unmuted.
  • 1: muted.

allowUnmuteByOneself

No

Integer

Body

Whether to allow participants to unmute themselves. This parameter is valid only when participants are muted.

  • 0: no.
  • 1: yes.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

None

Example Request

PUT /v1/mmc/control/conferences/mute?conferenceID=914083136
Connection: keep-alive
Content-Type: application/json
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Length: 20
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "allowUnmuteByOneself":1,
 "isMute":1
}

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 39
Connection: keep-alive
http_proxy_id: f48fd467413ebe6032fa102ba53fcafe
Server: api-gateway
X-Request-Id: f6cab3797cb5b310d498c0e97db0f927

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -H 'content-type: application/json' -X PUT -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"isMute":1}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/mute?conferenceID=914083136'
Parent topic: APIs