功能说明
App 管理员可以通过该接口解除成员封禁。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/live_engine_http_srv/get_banned_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com |
v4/live_engine_http_srv/get_banned_member_list | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
{"RoomId": "test","Offset":0,"Limit":10}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间 ID |
Offset | Integer | 选填 | 偏移量，初次拉取从0开始，后续请求以响应包 NextOffset 为准 |
Limit | Integer | 选填 | 单次分页拉取的数量，最大为100 |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-138c94122acc4ca485c8c7bf270686ac-O-Seq-135511","Response": { //响应体"BannedAccountList": [{"Member_Account": "user2","BannedUntil": 1719300627},{"Member_Account": "user1","BannedUntil": 1719300627}],"NextOffset": 0 // 分页标识}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
RequestId | String | 唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId |
BannedAccountList | Array | 封禁成员列表 |
Member_Account | String | 封禁成员账号 ID |
BannedUntil | Integer | 封禁截止时间 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的
ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 含义说明 |
100001 | 服务器内部错误，请重试 |
100002 | 请参数非法，请根据错误描述检查请求是否正确 |
100004 | 房间不存在，原因可能是房间没被创建过，或者已经被解散了 |
