最近更新时间:2024.04.11 11:50:48
首次发布时间:2023.12.27 19:58:10
你可以使用此接口查询一段时间内,某个应用下进行音视频通话的房间列表及房间相关信息。
你可以调用 ListRoomInfo
接口,指定你所属的 AppId
和查询时间段,查询该时间段内的房间列表及房间相关信息。
当前房间创建时间在查询时间范围内时,可查询到该房间的相关信息。
关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用OpenAPI。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数名称 | 数据类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListRoomInfo | 接口名称。当前 API 的名称为 ListRoomInfo 。 |
Version | String | 是 | 2023-11-01 | 接口版本。当前 API 的版本为 2023-11-01 。 |
AppId | String | 是 | Your_AppId | 应用的唯一标志 |
RoomId | String | 否 | Your_RoomId | 房间 ID,是房间的唯一标志 |
StartTime | String | 是 | 2022-09-09T12:06:16+08:00 | 查询起始时间戳,格式为 RFC3339,单位为秒 |
EndTime | String | 是 | 2022-09-09T12:06:16+08:00 | 查询结束时间戳,格式为 RFC3339,单位为秒 |
PageNum | Long | 否 | 1 | 分页序号,默认值为 1 |
PageSize | Long | 否 | 20 | 每页房间数,最大不能超过 100。默认为 20 。如果指定值超过 100,每页的房间数为 100。 |
下表仅列出本接口特有的返回参数,公共返回参数请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Total | Long | 2 | 查询到的房间总数。若同一 RoomId 下有多次通话,记为多个房间。 |
HasMore | Boolean | false | 是否还有房间未列出。若为true,表示符合条件房间过多。若要查询房间未列出,请修改查询条件。 |
PageNum | Long | 1 | 分页序号 |
PageSize | Long | 20 | 每页房间数 |
RoomList | Object[] | 房间信息 | |
CallId | String | Your_CallId | 通话 Id,是通话的唯一标识 |
RoomId | String | Your_RoomId | 返回房间 Id |
IsFinished | Boolean | true | 通话是否结束 |
CreatedTime | String | 2022-04-17T22:38:13+08:00 | 通话创建时间,格式为 RFC3339,单位秒 |
DestroyTime | String | 2022-04-17T22:38:13+08:00 | 通话结束时间,格式为 RFC3339,单位秒,若查询时还未结束,则返回空值。 |
ActiveUserNum | Long | 0 | 前仍在房间用户数 |
GET https://rtc.volcengineapi.com?Action=ListRoomInfo&Version=2023-11-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": "2023-11-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 } ] } }
您可访问公共错误码,获取更多错误码信息。