检查用户是否在线

检查用户是否在线

API 地址

api.vhallyun.com/api/v2/channel/check-user-online

描述

根据频道ID和第三方用户ID,检查第三方用户是否在线

入参

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

参数 类型 是否必选 含义
channel_id string 是 频道ID
third_party_user_ids string 是 第三用户ID,多个用英文逗号分割

出参

参数 类型 是否必选 含义
channel string 是 频道ID
connections object 是 第三方用户id在线列表的对象,第三方用户ID为key,在线状态为值,大于0为在线,等于0为不在线

错误码

错误码 类型 含义
10006 int 第三方用户ID不能为空
10016 int 频道ID不能为空
20004 int 频道查询为空
30002 int 不是当前频道拥有者
40006 int 频道类型不正确
50013 int 检查聊天频道第三方用户在线状态失败

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "channel": "ch_fc9c96d5",
        "connections": {
            "vhallyun_5b86182cd89c2": 1,
            "vhallyun_5b8619c942f23": 1
        }
    }
}