You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

获取离线通话房间列表 ListRoomInfo

最近更新时间：2024.02.29 19:30:25

首次发布时间：2022.11.15 18:43:12

我的收藏

你可以使用此接口查询一段时间内，某个应用下进行音视频通话的房间列表及房间相关信息。

使用说明

接口行为

你可以调用 ListRoomInfo 接口，指定你所属的 AppId和查询时间段，查询该时间段内的房间列表及房间相关信息。
当前房间创建时间在查询时间范围内时，可查询到该房间的相关信息。

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

  • 最大请求次数：60 次/秒
  • 最远可查询时间：14 天
  • 最大单次查询时间跨度：24 小时（若查询时间超过 24 小时，结束时间自动调整为开始时间 + 24 小时）
  • 数据延迟：20 秒

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=ListRoomInfo&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
ListRoomInfo
接口名称。当前 API 的名称为 ListRoomInfo。
Version
String
是
2020-12-01
接口版本。当前 API 的版本为 2020-12-01。
AppId
String
是
Your_AppId
应用的唯一标志
StartTime
String
是
2022-09-09T10:30:25+08:00
查询起始时间戳，格式为 RFC3339，单位秒
EndTime
String
是
2022-09-09T12:06:16+08:00
查询结束时间戳，格式为 RFC3339，单位秒
RoomId
String
否
Your_RoomId
房间 ID，是房间的唯一标志
PageNum
Integer
否
1
分页序号，默认值为1
PageSize
Integer
否
20
每页房间数，最大不能超过 100。默认为 20。如果指定值超过 100，每页的房间数为 100。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数
类型
示例值
描述
Total
Integer
2
查询到的房间总数。若同一 RoomId 下有多次通话，记为多个房间。
PageNum
Integer
1
分页序号
PageSize
Integer
20
每页房间数
HasMore
Boolean
false
是否还有房间未列出。若为true，表示符合条件房间过多。若要查询房间未列出，请修改查询条件。
RoomList
Object[]
房间信息
CallId
String
Your_CallId
通话 Id，是通话的唯一标识
RoomId
String
Your_RoomId
返回房间 Id
CreatedTime
String
2022-04-17T22:38:13+08:00
通话创建时间，格式为 RFC3339，单位秒
DestroyTime
String
2022-04-17T22:38:13+08:00
通话结束时间，格式为 RFC3339，单位秒，若查询时还未结束，则返回空值。
ActiveUserNum
Integer
0
当前仍在房间用户数
IsFinished
Boolean
true
通话是否结束

请求示例

GET https://rtc.volcengineapi.com?Action=ListRoomInfo&Version=2020-12-01&AppId=Your_AppId&StartTime=2022-09-09T10:30:25+08:00&EndTime=2022-09-09T12:06:16+08:00&RoomId=Your_RoomId&PageNum=1&PageSize=20

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestID",
        "Action": "ListRoomInfo",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 2,
        "PageNum": 1,
        "PageSize": 20,
        "HasMore": false,
        "RoomList": [
            {
                "CallId": "test_call1",
                "RoomId": "test_room1",
                "CreateTime": "2022-10-31T19:17:47+08:00",
                "DestroyTime": "2022-10-31T19:18:05+08:00",
                "ActiveUserNum": 0,
                "IsFinished": true
            },
            {
                "CallId": "test_call2",
                "RoomId": "test_room1",
                "CreateTime": "2022-10-31T19:18:09+08:00",
                "DestroyTime": "2022-10-31T19:18:25+08:00",
                "ActiveUserNum": 0,
                "IsFinished": true
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。