查询房间在线成员信息

更新时间: 2025/04/01 15:52:22

查看指定房间内的在线成员信息,包括在线人数、在线成员的用户 ID,以及加入房间的时间。该功能支持返回最多 3000 人的信息。

请求信息

请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考 如何处理调用服务端 RESTful API 超出频率限制

请求 URL

  • 请求方法:GET
  • URL:网易云信为该功能提供以下三个 API 请求地址,使用 V2 地址需在 URL 中指定 cid,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。
    https://rtc.yunxinapi.com/v2/api/rooms/{cid}/members?userRole={0}
    https://rtc.yunxinapi.com/v2/api/rooms/{cid}/members/{uid}
    https://rtc.yunxinapi.com/v3/api/rooms/members?cname={cname}&uid={uid}&userRole={0}
    
  • Content-Type:application/json

URL 中参数说明:

参数名称 类型 是否必选 示例 说明
cid Long V2 必选 6207760637435905 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。仅在调用 V2 接口时需要设置。
cname String V3 必选 abc 房间名称。仅在调用 V3 接口时需要设置。
uid Number 193992653091841 用户 ID,用于查看指定用户的信息。
如果不指定 uid,则返回该房间内所有成员信息。您也可以通过错误码判断 uid 是否在指定房间中。
userRole Number 0 用户角色,查看指定角色的成员信息。
如果不指定角色,则默认查看房间内所有用户的信息。
  • 0:只返回主播列表
  • 1:只返回观众列表

请求 Header

请求中 Header 的设置请参考 请求结构 描述。

请求示例

https://rtc.yunxinapi.com/v2/api/rooms/6207760637435905/members

https://rtc.yunxinapi.com/v2/api/rooms/6207760637435905/members/193992653091841

https://rtc.yunxinapi.com/v3/api/rooms/members?cname=abc&uid=193992653091841

响应信息

返回参数

参数名称 类型 示例 说明
cname String netease 房间名称。
cid Long 6207760637435905 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。
total Integer 1 房间内在线用户总数。
members Array of JSON 1513145726 房间内的在线成员信息。参数说明请参考 members

返回示例

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

错误码

该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求频率
  • 请求 URL
  • 请求 Header
  • 请求示例
  • 响应信息
  • 返回参数
  • 返回示例
  • 错误码