查看房间信息
更新时间: 2023/07/13 02:47:56
查看房间的基本信息,包括房间 ID、房间名称、房间创建者 ID、房间内在线用户总数、房间状态、房间创建时间、房间结束时间。
其中,房间状态包括:
- 1:初始状态:房间已被初始化,但尚未有成员加入到房间。
- 2:进行中:房间已启用,正在通话或视频中。
- 3:正常结束:该房间中的音视频通话已正常结束。
- 4:异常结束:该房间中的音视频通话被异常挂断。
URL
-
请求方法:GET
-
URL:
网易云信为该功能提供以下两个 API 请求地址,使用 V2 地址需在 URL 中指定
cid
,使用 V3 地址需在 URL 中指定cname
,您可以根据业务需求调用任一接口。https://logic-dev.netease.im/v2/api/rooms/{cid}
https://logic-dev.netease.im/v3/api/rooms?cname={cname}
URL中参数说明:
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
cid | int64 | 6207760637435905 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。 |
cname | String | abc | 房间名称。仅在调用 V3 接口时需要设置。 |
接口请求频率
默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
请求参数
该 API 的 body 中无需指定任何请求参数。
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
cid | int64 | 6207760637435905 | 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。 |
cname | string | netease | 房间名称。 |
uid | int64 | 193992653091841 | 房间创建者的用户 ID。 |
total | int | 3 | 房间内在线用户总数。 |
stats |
int |
1 |
房间状态。包括:
|
createtime | int64 | 1513145726 | 房间创建时间,UTC 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的秒数。 |
destroytime | int64 | 1513145926 | 房间结束时间,UTC 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的秒数。 |
示例
请求示例
https://logic-dev.netease.im/v2/api/rooms/6207760637435905
https://logic-dev.netease.im/v3/api/rooms?cname=abc
正常返回示例
{
"cid":6207760637435905,
"cname":"netease",
"uid": 193992653091841,
"total":3,
"stats":1,
"createtime":1513145726,
"destroytime":1513145926
}
错误码
该接口仅在 HTTP header 中返回状态码,状态码列表请参考 header 中的 HTTP 状态码。
此文档是否对你有帮助?