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

Disconnecting Participants

Description

This API is used to disconnect a participant who is in a meeting.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/control/conferences/participants/delete

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.

bulkHangUpParticipants

Yes

String[1..*]

Body

List of IDs of participants to disconnect.

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

POST /v1/mmc/control/conferences/participants/delete?conferenceID=914083136
Connection: keep-alive
X-Conference-Authorization:stbaf8fa2ea8a1b0e3ab2e007a85a75f88c55d5f6d5c1912dfb
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
  "bulkHangUpParticipants": [
    "ba9acb1e216d11eabc5165c2b91ad427"
  ]
}

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: 03b6db0b6804090f93fa80d4c1ed6c13
Server: api-gateway
X-Request-Id: bd6c09db2be3f986c2382c01deb240e6

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 POST -H 'X-Conference-Authorization:stb39b3f21898d4972fed86b3f22ac70914a77303def15e126a' -d '{"bulkHangUpParticipants":["ba9acb1e216d11eabc5165c2b91ad427"]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/participants/delete?conferenceID=914083136
Parent topic: APIs