获取在线用户列表更新时间：2020-01-14 19:10:22

获取在线用户列表

API 地址

api.vhallyun.com/api/v2/channel/get-userid-list

描述

根据频道ID，获取聊天频道在线用户列表

入参

关于公共请求参数详细内容，请参考 公共请求参数。

参数 类型 是否必选 含义
channel_id string 是 频道ID
curr_page int 否 当前页，默认为1
page_size int 否 每页大小。默认为10,最大为1000

出参

参数 类型 是否必选 含义
list list 是 第三方用户id列表
context object 是 用户自定义内容
disable_users list 是 禁言用户列表
channel_disable bool 是 频道禁言状态，true未被禁言，false已被禁言
total int 是 消息总条数
page_num int 是 当前页
page_all int 是 总页数

错误码

错误码 类型 含义
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40008 int 当前页数不正确
40009 int 分页条目不正确
50016 int 获取聊天频道在线用户列表失败
70001 int 分页条目超过限制

响应格式

{
	"code": 200,
	"msg": null,
	"data": {
		"list": ["vhallyun_5b6c126b69d43", //发送消息者ID
		"vhallyun_5b6c1289458db" //发送消息者ID
		],
		"context": {
			"vhallyun_5b6c126b69d43": false //用户自定义内容
		},
		"disable_users": ["vhallyun_5b6c1289458db" //禁言用户列表
		],
		"channel_disable": false,
		//频道禁言状态
		"total": 2,
		"page_num": 1,
		"page_all": 1
	}
}