1. 接口描述
接口请求域名: trtc.tencentcloudapi.com 。
查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。
注意:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。
默认接口请求频率限制:200次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRoomInformation。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SdkAppId | 是 | String | 用户sdkappid |
StartTime | 是 | Integer | 查询开始时间,14天内。本地unix时间戳(1588031999) |
EndTime | 是 | Integer | 查询结束时间,本地unix时间戳(1588034999) |
RoomId | 否 | String | 字符串房间号 |
PageNumber | 否 | String | 分页index,从0开始(PageNumber和PageSize 其中一个不填均默认返回10条数据) |
PageSize | 否 | String | 分页大小(PageNumber和PageSize 其中一个不填均默认返回10条数据,最大不超过100) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 返回当页数据总数 |
RoomList | Array of RoomState | 房间信息列表 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询sdkappid下房间列表
输入示例
https://trtc.tencentcloudapi.com/?Action=DescribeRoomInformation
&StartTime=1588031999
&EndTime=1588034999
&SdkAppId=1400188366
&<公共请求参数>
输出示例
{
"Response": {
"Total": 10,
"RoomList": [
{
"CommId": "1400188366_563398783_1587959355",
"RoomString": "113a730673fee2d86e93e26cddb25b7d",
"CreateTime": 1587959355,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_113a730673fee2d86e93e26cddb25b7d"
},
{
"CommId": "1400188366_3791597063_1587959341",
"RoomString": "4724f5b26c36bd53ea139e7e1c3dea1e",
"CreateTime": 1587959341,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_4724f5b26c36bd53ea139e7e1c3dea1e"
},
{
"CommId": "1400188366_15343445_1587731480",
"RoomString": "ae4e2ebc3a71d5b151efca3e1dbe32e9",
"CreateTime": 1587731480,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_ae4e2ebc3a71d5b151efca3e1dbe32e9"
},
{
"CommId": "1400188366_1100067693_1587730962",
"RoomString": "f83dec1f40adaf92117b62d6f9e7e0b4",
"CreateTime": 1587730962,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_f83dec1f40adaf92117b62d6f9e7e0b4"
},
{
"CommId": "1400188366_2420034035_1587723604",
"RoomString": "76f067dfad1044171dad37bf65b1cf4b",
"CreateTime": 1587723604,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_76f067dfad1044171dad37bf65b1cf4b"
},
{
"CommId": "1400188366_2420034035_1587713998",
"RoomString": "76f067dfad1044171dad37bf65b1cf4b",
"CreateTime": 1587713998,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "mixer_76f067dfad1044171dad37bf65b1cf4b"
},
{
"CommId": "1400188366_3501_1586952940",
"RoomString": "3501",
"CreateTime": 1586952940,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "yuting"
},
{
"CommId": "1400188366_3015068783_1586952940",
"RoomString": "7651c9da1253981c8b842bcdcad11c3e",
"CreateTime": 1586952940,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "7651c9da1253981c8b842bcdcad11c3e"
},
{
"CommId": "1400188366_3501_1586952865",
"RoomString": "3501",
"CreateTime": 1586952865,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "yuting"
},
{
"CommId": "1400188366_3015068783_1586952865",
"RoomString": "7651c9da1253981c8b842bcdcad11c3e",
"CreateTime": 1586952865,
"DestroyTime": 1588040628,
"IsFinished": false,
"UserId": "7651c9da1253981c8b842bcdcad11c3e"
}
],
"RequestId": "83ca6fdd-cf4c-46a9-a577-74c3497ad3fa"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBError | 数据库查询异常。 |
InternalError.EsQueryError | ES查询异常。 |
InternalError.HttpParaseFalied | http请求解析失败。 |
InternalError.InterfaceErr | 接口错误。 |
InternalError.MethodErr | 不支持的方法。 |
InvalidParameter.BodyParamsError | body 解析参数失败。 |
InvalidParameter.EndTs | EndTs参数错误。 |
InvalidParameter.PageNumber | PageNumber 参数错误。 |
InvalidParameter.PageSize | PageSize参数错误。 |
InvalidParameter.PageSizeOversize | PageSize超过100。 |
InvalidParameter.QueryScaleOversize | 查询范围超过文档限制。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
InvalidParameter.SdkAppid | 不能操作的SdkAppid。 |
InvalidParameter.StartTs | StartTs参数错误。 |
InvalidParameter.StartTsOversize | 查询开始时间超过文档限制。 |
InvalidParameter.UrlParamsError | Url解析参数失败。 |
InvalidParameter.UserId | UserId参数错误。 |
MissingParameter.CommIdOrSdkAppId | 缺少SdkAppId参数或CommID参数。 |
MissingParameter.EndTs | 缺少endTS_s参数。 |
MissingParameter.RoomNum | 缺少RoomNum参数。 |
MissingParameter.SdkAppId | 缺少SdkAppId参数。 |
MissingParameter.StartTs | 缺少startTS_s参数。 |