文档反馈
文档反馈

查看房间内成员信息

查看指定房间内的在线成员信息,包括在线人数、在线成员的用户 ID 和加入房间的时间。

URL

URL 中参数说明:

参数名称 类型 是否必选 示例 描述
cid int64 必选 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。

请求参数

该 API 的 body 中无需指定任何请求参数。

返回参数

参数名称 类型 示例 描述
cname String netease 房间名称。
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
total int 1 房间内在线用户总数。
members Array[如何描述成员的结构体详细信息] 1513145726 房间内的在线成员信息。参数说明请参考下表。

members

名称 类型 是否必选 示例 描述
uid 193992653091841 房间中在线成员的用户 ID。
starttime int64 1513145926 该成员加入房间的时间。UTC 时间戳格式。

示例

请求示例

https://logic-dev.netease.im/v2/api/rooms/6207760637435905/members

正常返回示例

{
    "cname": "netease",      
    "cid" : 6207760637435905,      
    "total" : 1,                    
    "members":[                   
        {
            "uid":193992653091841,    
            "starttime":1513145926    
        }
    ]
}

错误码

该接口在 HTTP Header 中返回错误码,错误码列表请参考 HTTP Header 中的状态码

×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。