Help Center/ Meeting/ Server API Reference/ Meeting Control/ APIs/ Admitting Waiting Room Members to a Meeting
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Admitting Waiting Room Members to a Meeting

Description

This API is used to allow members in the waiting room to join a meeting. You can admit all members or specified members to the meeting.

Debugging

You can debug this API in API Explorer.

URI

PUT /v1/mmc/control/conferences/allowWaitingParticipant

Table 1 Query parameter

Parameter

Mandatory

Type

Description

conferenceID

Yes

String

Meeting ID.

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Conference-Authorization

Yes

String

Meeting control token, which can be obtained by calling the API for Obtaining a Meeting Control Token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

participantID

No

String

Waiting room member ID. The value is obtained by listening to the event of waiting room members in Meeting-Level Event Push.

allowAll

No

Boolean

Whether all members in the waiting room can join the meeting.

  • false: Only specific members can join the meeting.

  • true: All members can join the meeting.

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

PUT https://{endpoint}/v1/mmc/control/conferences/allowWaitingParticipant?conferenceID=914370850

{
  "allowAll" : true
}

Example Response

Status code: 400

Invalid parameters.

{
  "error_code" : "MMC.111072065",
  "error_msg" : "CONF_NOT_FOUND_OR_AUTH_FAILED"
}

Status Codes

Status Code

Description

200

Operation successful.

400

Invalid parameters.

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.

Parent topic: APIs