- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍 (TUIRoomKit)
- 开通服务 (TUIRoomKit)
- 跑通 Demo（TUIRoomKit）
- 快速接入 (TUIRoomKit)
- 界面定制 (TUIRoomKit)
- 虚拟背景（TUIRoomKit）
- 会议控制 (TUIRoomKit)
- 云端录制 (TUIRoomKit)
- AI 降噪 (TUIRoomKit)
- 会中聊天 (TUIRoomKit)
- 机器人推流 (TUIRoomKit)
- 更多特性 (TUIRoomKit)
- 客户端 API (TUIRoomKit)
- 服务端 API (TUIRoomKit)
- 常见问题 (TUIRoomKit)
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 多人会议（含 UI）
- 组件介绍 (TUIRoomKit)
- 开通服务 (TUIRoomKit)
- 跑通 Demo（TUIRoomKit）
- 快速接入 (TUIRoomKit)
- 界面定制 (TUIRoomKit)
- 虚拟背景（TUIRoomKit）
- 会议控制 (TUIRoomKit)
- 云端录制 (TUIRoomKit)
- AI 降噪 (TUIRoomKit)
- 会中聊天 (TUIRoomKit)
- 机器人推流 (TUIRoomKit)
- 更多特性 (TUIRoomKit)
- 客户端 API (TUIRoomKit)
- 服务端 API (TUIRoomKit)
- 常见问题 (TUIRoomKit)
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
功能说明
App 管理员可以通过该接口获取被封禁的成员列表。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/room_engine_http_srv/get_banned_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 新加坡： adminapisgp.im.qcloud.com |
v4/room_engine_http_srv/get_banned_member_list | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
{"RoomId":"room-test","Limit":100,"Offset":0}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间 ID |
Limit | Integer | 选填 | 单次获取封禁成员的数量，最大为100 |
Next | String | 选填 | 偏移量，初次拉取从0开始，后续请求以响应包 NextOffset 为准 |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-99d6df2213b54216a02bc18024a5c218-O-Seq-57681","Response": {"BannedAccountList": [{"Member_Account": "user2","BannedUntil": 1703559417}],"NextOffset": 0}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
RequestId | String | 唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId |
BannedAccountList | Array | 封禁成员信息，BannedUntil 为封禁成员的封禁截止时间，Member_Account 为封禁成员账号 ID |
NextOffset | Integer | 下次请求的 Offset 值，如果此值为0，表示该封禁成员列表已经拉取完毕 |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码 | 含义说明 |
100001 | 服务器内部错误，请重试 |
100002 | 请参数非法，请根据错误描述检查请求是否正确 |
100004 | 房间不存在，或者曾经存在过，但是目前已经被解散。 |
100005 | 非房间成员 |
100006 | 操作权限不足 |
是
否
本页内容是否解决了您的问题？