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

Removing Participants

Description

This API is used to remove a participant.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

POST

Request Address

/v1/mmc/control/conferences/attendees/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.

bulkDelAttendInfo

Yes

Array of DelAttendInfo objects

Body

List of participants to be removed.
Table 3 DelAttendInfo parameters

Parameter

Mandatory

Type

Location

Description

number

Yes

String

Body

Participant number.

participantID

No

String

Body

Participant ID. This parameter is mandatory for participants who have joined the meeting.

Status Codes

Table 4 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/attendees/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)

{
  "bulkDelAttendInfo": [
    {
      "number": "+991116003815",
      "participantID": "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: 8e6fe9e1d0a45e33398f426a227e855a
Server: api-gateway
X-Request-Id: 8957e54c2881f52125edd6439995fbf7

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 '{"bulkDelAttendInfo":[{"number":"+991116003815","participantID":"ba9acb1e216d11eabc5165c2b91ad427"}]}' https://api.meeting.huaweicloud.com/v1/mmc/control/conferences/attendees/delete?conferenceID=914083136
Parent topic: APIs