该接口用于在聊天室中查询虚构用户列表。

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members

Header

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

查询参数

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

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
+ items	Array of objects	返回的虚构用户信息。	是
account_id	String	虚构用户账号 ID。	是
room_nick	String	虚构用户昵称。	否
room_avatar	String	虚构用户头像。	否
enter_time	Long	虚构用户进入聊天室的时间。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "items": {
            "account_id": "哈哈哈",
            "room_nick": "zhangsan",
            "room_avatar": "incididunt ad"
        }
    }
}

错误码

错误码	错误码描述	错误信息示例
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