在线调试
分页查询标签下的在线成员列表
更新时间: 2024/07/17 17:26:07
该接口用于分页查询某标签下的聊天室在线成员列表。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/list_tag_members
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
room_id |
Long | 必选 | 聊天室 ID。 |
请求参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
tag |
String | 必选 | 需要查询的目标标签。 |
offset |
Long | 必选 | 查询的偏移量,首次查询传入 0,后续查询传入上一次查询结果中的 offset。 |
limit |
Integer | 必选 | 每页返回的成员数上限,最大为 100。小于等于 0,或者大于 100,会报 414 错误。 |
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
+
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": {
"offset": 100,
"has_more": false,
"items": [
{
"extension": "",
"level": 0,
"account_id": "yx23",
"room_nick": "yx23",
"room_avatar": "http://w03d",
"member_role": 1,
"is_online": true,
"enter_time": 1705302091747,
"blocked": false,
"chat_banned": false,
"temp_chat_banned_time": 12322,
"temp_chat_banned": false,
"notify_target_tags": "{\"tag\": \"abc\"} and {\"tag\": \"def\"}",
"tags": "[\"tag\"]",
"online_info_list": [{
"room_nick": "yx23",
"room_avatar": "http://wwww",
"enter_time": 1705302091747,
"client_type": 1
}],
"online_count": 1
}
]
}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频率超限 | rate limit exceeded |
113404 | 聊天室不存在 | chatroom not exist |
113410 | 聊天室服务未开通 | chatroom service disabled |
113406 | 聊天室已关闭 | chatroom closed |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?