文档反馈
文档反馈

查看房间信息

查看房间的基本信息,包括房间 ID、房间名称、房间创建者 ID、房间内在线用户总数、房间状态、房间创建时间、房间结束时间。

其中,房间状态包括:

URL

URL中参数说明:

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

请求参数

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

返回参数

参数名称 类型 示例 描述
cid int64 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
cname string netease 房间名称。
uid int64 193992653091841 房间创建者的用户 ID。
total int 3 房间内在线用户总数。
stats int 1 房间状态。包括:
  • 1:初始状态。
  • 2:进行中。
  • 3:正常结束。
  • 4:异常结束。
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

正常返回示例

{
    "cid":6207760637435905,             
    "cname":"netease",                 
    "uid": 193992653091841,            
    "total":3,                         
    "stats":1,                         
    "createtime":1513145726,            
    "destroytime":1513145926            
}

错误码

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

×

反馈成功

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