查询房间在线成员信息
更新时间: 2024/03/25 11:00:40
查看指定房间内的在线成员信息,包括在线人数、在线成员的用户 ID ,以及加入房间的时间。该功能支持返回最多 3000 人的信息。
URL
- 请求方法:GET
- URL:网易云信为该功能提供以下三个 API 请求地址,使用 V2 地址需在 URL 中指定 cid,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。
https://logic-dev.netease.im/v2/api/rooms/{cid}/members?userRole={0} https://logic-dev.netease.im/v2/api/rooms/{cid}/members/{uid} https://logic-dev.netease.im/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 ,则返回该房间内所有成员信息。 |
userRole | Number | 可选 | 0 | 用户角色,查看指定角色的成员信息。 如果不指定角色,则默认查看房间内所有用户的信息。
|
接口请求频率
默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
该 API 的 Body 中无需指定任何请求参数。
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
cname | String | netease | 房间名称。 |
cid | Long | 6207760637435905 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。 |
total | Integer | 1 | 房间内在线用户总数。 |
members | Array of JSON | 1513145726 | 房间内的在线成员信息。参数说明请参考 members。 |
示例
请求示例
https://logic-dev.netease.im/v2/api/rooms/6207760637435905/members
https://logic-dev.netease.im/v2/api/rooms/6207760637435905/members/193992653091841
https://logic-dev.netease.im/v3/api/rooms/members?cname=abc&uid=193992653091841
正常返回示例
{
"cname": "netease",
"cid" : 6207760637435905,
"total" : 1,
"members":[
{
"uid":193992653091841,
"userRole":0,
"starttime":1513145926
}
]
}
错误码
该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码。
此文档是否对你有帮助?