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

Locking or Unlocking a Meeting

Description

This API is used to lock or unlock a meeting. After a meeting is locked, users cannot actively join the meeting. Uses can use the host password or host link to join the locked meeting, or the host can invite users to the meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

PUT

Request Address

/v1/mmc/control/conferences/lock

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.

isLock

Yes

Integer

Body
  • 0: Unlock the meeting.
  • 1: Lock the meeting.

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/lock?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
Content-Type: application/json
Content-Length: 20
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
 "isLock":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: 81e59ca1730e459417bf8b6c5376ecfa
Server: api-gateway
X-Request-Id: 2a40022a27536e9fbf3dba3dc7d4d443

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 '{"isLock": 1}' 'https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/lock?conferenceID=914083136'
Parent topic: APIs