在线调试
查询聊天室的禁言列表
更新时间: 2024/07/17 17:26:06
该接口用于查询指定聊天室中的禁言列表。
该接口默认只查询 100 个禁言用户,若需要扩展,请联系云信技术支持,最大可扩展至查询 1000 个账号。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/chat_banned
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
room_id |
Long | 必选 | 聊天室 ID。 |
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
+
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": [
{
"room_nick": "",
"room_avatar": "",
"account_id": "yx1"
}
]
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频率超限 | rate limit exceeded |
113410 | 聊天室服务未开通 | chatroom service disabled |
113404 | 聊天室不存在 | chatroom not exist |
113406 | 聊天室已关闭 | chatroom closed |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?