查询房间信息
更新时间: 2024/03/19 14:31:03
查询房间的详细信息,包括房间号、房间模板、访问用户人次等信息。
使用场景:如果您的业务系统需要了解房间的详细信息,您可以调用该接口。
接口请求地址
- 请求方法:GET
- URL:https://roomkit.netease.im/apps/v2/room?roomArchiveId={roomArchiveId}
URL 中参数说明
请求 Header 的设置请参见请求结构。
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
roomArchiveId | String | 是 | 4***251 | 创建房间时,NERoom 服务端自动生成的一个用于标识房间的 ID,全局唯一,最大长度36个字符。 获取方法请参见创建房间 中的返回参数。 |
返回参数
参数名称 | 类型 | 示例 | 描述 |
---|---|---|---|
code | Integer | 0 | 状态码,0表示成功,具体请参见错误码。 |
msg | String | Success | 业务结果描述,Success表示成功。 |
ts | Long | 1648021056815 | NERoom 服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。 |
requestId | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识。 |
cost | String | 48ms | 处理该请求所消耗的时间。 |
+ data | Object | - | 房间列表。 |
示例
请求示例
javahttps://roomkit.netease.im/apps/v2/room?roomArchiveId=123412341234
返回示例
java{
"code":0,
"msg":"Success",
"ts":1619068087795,
"requestId":"6e507107d1f4447ea731f651dc6d2432",
"cost":"66ms",
"data":{
"roomArchiveId":"2130786",
"roomUuid":"1693563551311990784",
"roomStatus":1,
"templateId":40,
"roomName":"会议Example",
"uv":0,
"pv":0,
"onlineUserCount":0,
"chatRoomId": 41234234
}
}
此文档是否对你有帮助?