API 参考
在线调试

查询聊天室固定成员列表

更新时间: 2024/07/17 17:10:04

该接口用于查询指定聊天室中的固定成员列表。

聊天室中的固定成员包括创建者、管理员以及普通成员。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/list_members

请求 Header 的参数说明请参见请求 Header

路径参数

参数名称 类型 是否必选 描述
room_id String 必选 聊天室 ID。

查询参数

参数名称 类型 是否必选 描述 默认值
member_roles String 可选 需要查询的聊天室成员类型。
0:普通用户;1:创建者;2:管理员
"1,2,3",即查询全部固定成员

响应

Header

响应 Header 的参数说明请参见 响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": false,
        "items": [{
            "extension": "extension",
            "account_id": "yx32",
            "room_nick": "yx32",
            "room_avatar": "https://nim-nosdn.netease.im/MTAxMTAxMA\u003d\u003d/bmltd18wXzE2OTA5NDgwMDM2MTVfNDI4NDFiYjMtYTI1Yi00Y2UxLThmMWQtYzZhM2UyNDE0MDU5",
            "member_role": "TEMPORARY",
            "is_online": true,
            "enter_time": 1698657572668,
            "blocked": false,
            "chat_banned": false,
            "temp_chat_banned": false,
            "online_info_list": [{
                "room_nick": "yx32",
                "room_avatar": "https://nim-nosdn.netease.im/MTAxMTAxMA\u003d\u003d/bmltd18wXzE2OTA5NDgwMDM2MTVfNDI4NDFiYjMtYTI1Yi00Y2UxLThmMWQtYzZhM2UyNDE0MDU5",
                "enter_time": 1698657572668,
                                "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
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码