根据房间ID、用户ID、房间名称等分页查询房间列表。

查询时间范围不能超过7天。

请求

URI

GET https://data.netease.im/data/v3/nrtc/rooms

路径参数

参数	类型	是否必填	描述
begin_time	Long	是	查询的时间范围起点。Unix 时间戳。单位：毫秒（ms）
end_time	Long	是	查询的时间范围终点。Unix 时间戳。单位：毫秒（ms）
cid	String	否	房间ID
cname	String	否	频道名称
uid	String	否	用户ID
status	String	否	房间状态（枚举值）。 all：全部，默认值 all calling：进行中 finished：已结束
page_num	Integer	否	查询页数。默认第一页
page_size	Integer	否	每次查询的最大条数。默认10（最大为100）

请求示例

curl --location 'localhost:8080/data/v3/nrtc/rooms?begin_time=1697040000000&end_time=1697114144825&status=all&page_num=1&page_size=1'
--header 'X-custom-traceid:91629c975c4f269a6fc67bf9da0609be ' \
--header 'AppKey:b2efc79xxxxxxx155e7d2' \
--header 'Nonce:8dfdb33d2840' \
--header 'CurTime:1443592222' \
--header 'CheckSum:b404199cdb06d20991bc6e758f47c007dc61016d' \
--header 'Content-Type:application/json; charset=utf-8'

响应

响应字段

字段	类型	描述
code	Integer	响应状态码。200 表示请求成功
msg	String	错误信息
request_id	String	请求 ID
+ data	Object	响应数据
current_page	Integer	当前页数
page_num	Integer	总页数
page_size	Integer	每页数量
total_records	Integer	总记录数
+ list	Array of objects	响应结果，包含cid、房间开始时间和结束时间
appid	Long	应用ID
cid	String	房间ID
begin_time	Long	房间开始时间
end_time	Long	房间结束时间， 若房间仍未结束，则不返回 end_time
cname	String	房间名称
finished	Boolean	房间是否结束
accumulated_user_number	Integer	房间累计人数

响应示例

json{
    "code":200,
    "data":{
        "total_records":8983,
        "page_num":8983,
        "list":[
            {
                "accumulated_user_number":2,
                "appid":20810224,
                "cname":"3375568",
                "begin_time":1697022331000,
                "finished":false,
                "cid":"1347341054560217"
            }
        ],
        "current_page":1,
        "page_size":1
    },
    "request_id":"4e64620446f6476c90b49fb8a5f9e60a"
}