跳到主要内容

Rest接口查询在线客户端列表 - PubSub (Websocket)

前置条件

资费

1.每调用一次扣减消息量1条

服务端Rest接口查询

    Request: 
URL: http(s)://<Rest Host>/v2/pubsub/herenow?appkey={appkey}&channel={channel}&includeUsers={includeUsers}&distinct={distinct}
Method: GET
参数:
channel //必须项,可以包含一个或多个channel
includeUsers //可选项,是否返回用户列表,默认false
distinct //可选项,相同userId的客户端,列表中只保留一个,默认false

Response JSON:
//response示例
{
"code": 200,
"content": {
"channels": {
"channel_A": { //channel name
"channel": "channel_A",
"clientAmount": 3, //在线客户端数量
"userAmount": 2, //在线用户数量
"users": [ //在线用户id列表
{"id":"Jack2","data":{"avatar":"/www/xxx.png","nickname":"Jack2"}}, //在线用户id
{"id":"Ted2","data":{"avatar":"/www/xxx.png","nickname":"Ted2"}}
]
},
"channel_B": { //channel name
"channel": "channel_B",
"clientAmount": 1, //在线客户端数量
"userAmount": 1, //在线用户数量
"users": [ //在线用户id列表
{"id":"Tom","data":{"avatar":"/www/xxx.png","nickname":"Tom"}}, //在线用户id
]
}
}
}
}