このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Conference/
Web/
サーバー API/
REST インターフェース/
ユーザー管理/
Ban Room Members/

Ban Room Members

Feature Overview

App administrators can ban room members through this API. Once banned, the members will be removed from the room and will not be able to re-enter during the ban duration.

API Calling Description

Sample Request URL

https://xxxxxx/v4/room_engine_http_srv/ban_room_member?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The table below only lists the parameters modified when calling this API. For more details, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain for the country/region where the SDKAppID is located:
Singapore :adminapisgp.im.qcloud.com
v4/room_engine_http_srv/ban_room_member
Request API
sdkappid
The SDKAppID assigned by the Chat console when an app is created
identifier
Must be an App administrator account. For more details, please refer to App Administrator.
usersig
The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
random
Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
The request format fixed value is json

Maximum Calling Frequency

200 times per second.

Sample Request Packets

Basic Form
{
  "RoomId":"room-test",
  "MemberList_Account":["user1"],
  "Reason":"you are banned because of irregularities",
  "Duration":3600
}

Request Packet Field Description

Field
Type
Attribute
Description
RoomId
String
Mandatory
Room ID
MemberList_Account
Array
Mandatory
Banned members ID, up to 20 per request
Reason
String
Mandatory
Banned information, up to 1000 bytes
Duration
Integer
Mandatory
Ban duration, unit: seconds

Sample Response Packets

Basic Form
{
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ActionStatus": "OK",
  "RequestId": "Id-d4e0a71869c84352ac3a730fda71cdb0-O-Seq-47158"
}

Response Packet Field Description

Field
Type
Description
ActionStatus
String
The result of the request process. OK for success, FAIL for failure.
ErrorCode
Integer
Error code. 0 for success, others for failure.
ErrorInfo
String
Error message
RequestId
String
The unique request ID is returned with each request and required to provide this RequestId when locating issues.

Error Codes

Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. For common error codes (60000 to 79999), see Error Code documentation. The private error codes for this API are as follows:
Error code
Description
100001
Internal server error, please retry.
100002
Invalid parameter, please check the request for correctness based on the error description.
100004
Room does not exist, or it once existed but now has been destroyed.
100005
Non-room members
100006
Insufficient operational permissions