https://xxxxxx/v4/live_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: Others in China: console.tim.qq.com Singapore : adminapisgp.im.qcloud.com |
v4/live_engine_http_srv/get_banned_member_list | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | Request format fixed value: json |
{"RoomId": "test","Offset":0,"Limit":10}
Field | Type | Attribute | Description |
RoomId | String | Mandatory | Room ID |
Offset | Integer | Optional | Offset, initially starting from 0 for the first pull, subsequent requests are based on the NextOffset value in the response packet |
Limit | Integer | Optional | Quantity of single-page pull, maximum value: 100 |
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-138c94122acc4ca485c8c7bf270686ac-O-Seq-135511","Response": { //Response Body"BannedAccountList": [{"Member_Account": "user2","BannedUntil": 1719300627},{"Member_Account": "user1","BannedUntil": 1719300627}],"NextOffset": 0 // Pagination Identifier}}
Field | Type | Description |
ActionStatus | String | Results of request processing. OK indicates success, FAIL indicates failure |
ErrorCode | Integer | Error code. 0: success; other values: failure |
ErrorInfo | String | Error message |
RequestId | String | Unique Request ID, each request will return a Request ID, which is required when locating issues |
BannedAccountList | Array | Blocked Member List |
Member_Account | String | Blocked Member Account ID |
BannedUntil | Integer | Ban end time |
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, possibly because it was never created or has already been dissolved |
Was this page helpful?