查询房间列表

最近更新时间:2020-06-16 08:54:38

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询5天内的数据。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeRoomInformation。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou
SdkAppId String 用户sdkappid
StartTime Integer 查询开始时间,5天内。本地unix时间戳(1588031999s)
EndTime Integer 查询结束时间,本地unix时间戳(1588031999s)
RoomId String 数字房间号
PageNumber String 分页index(不填默认只返回10个)
PageSize String 分页大小(不填默认返回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 Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库查询异常。
InternalError.EsQueryError ES查询异常。
InternalError.HttpParaseFalied http请求解析失败。
InternalError.InterfaceErr 接口错误。
InternalError.MethodErr 不支持的方法。
InvalidParameter.BodyParamsError body 解析参数失败。
InvalidParameter.EndTs EndTs参数错误。
InvalidParameter.PageSizeOversize PageSize超过100。
InvalidParameter.QueryScaleOversize 查询范围超过1个小时。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.StartTs StartTs参数错误。
InvalidParameter.StartTsOversize 查询开始时间不在5天内。
InvalidParameter.UrlParamsError Url解析参数失败。
InvalidParameter.UserId UserId参数错误。
MissingParameter.EndTs 缺少endTS_s参数。
MissingParameter.RoomNum 缺少RoomNum参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.StartTs 缺少startTS_s参数。
目录