https://xxxxxx/v4/room_engine_http_srv/get_banned_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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/get_banned_member_list | Request API |
sdkappid | The SDKAppID assigned by the Chat console when an app is created |
identifier | |
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 |
{"RoomId":"room-test","Limit":100,"Offset":0}
Field | Type | Attribute | Description |
RoomId | String | Mandatory | Room ID |
Limit | Integer | Optional | Get the number of banned members at a time, with a maximum of 100 |
Next | String | Optional | Offset, starting from 0 for the first pull, subsequent requests are based on the NextOffset value in the response packet |
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-99d6df2213b54216a02bc18024a5c218-O-Seq-57681","Response": {"BannedAccountList": [{"Member_Account": "user2","BannedUntil": 1703559417}],"NextOffset": 0}}
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. |
BannedAccountList | Array | Banned member information, BannedUntil is the ban expiry time of the member, Member_Account is the banned member's account ID. |
NextOffset | Integer | The Offset value for the next request. If this value is 0, it means that the list of banned members has been completely pulled. |
Error code | Description |
100001 | Internal server error, please retry. |
100002 | Invalid parameter, please check the request for correctness based on the error description. |
100004 | The room does not exist, or it once existed but now has been destroyed. |
100005 | Non-room members |
100006 | Insufficient operational permissions |
Was this page helpful?