Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Locking or Unlocking the Video Source of a Participant
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Locking or Unlocking the Video Source of a Participant

Description

This API is used to lock or unlock the video source of a participant. This API can only be called for professional meeting terminals (such as TE series).

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/lockView

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

conferenceID

Yes

String

Query

Meeting ID.

participantID

Yes

String

Query

Participant ID of a professional meeting terminal.

X-Conference-Authorization

Yes

String

Header

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

status

Yes

Integer

Body

Lock flag.

  • 0: Unlock the video source.
  • 1: Lock the video source.

participantID

Yes

String

Body

ID of the participant whose video source is locked.

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/lockView?conferenceID=914083136&participantID=6a1acfe867f211eaa1cd59f41ff47e04
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
content-type: application/json
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "status":1,
        "participantID":"f131536e21ff11eab12735e1cddf6d01"
}

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
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 571b4dfceff545fae29aa14cea761079
Server: api-gateway
X-Request-Id: f78b007ec2dabf1498620131c7bc19e0

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 '{"status":1,"participantID":"f131536e21ff11eab12735e1cddf6d01"}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/
lockView?conferenceID=914083136&participantID=6a1acfe867f211eaa1cd59f41ff47e04
Parent topic: APIs