有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

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

可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeScaleInfo。
Version String 公共参数,本接口取值:2019-07-22。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-mumbai 。
SdkAppId Integer 用户SdkAppId(如:1400xxxxxx)
示例值:1400xxxxxx
StartTime Integer 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)
注意:支持查询14天内的数据。
示例值:1590065777
EndTime Integer 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。
注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。
示例值:1590065777

3. 输出参数

参数名称 类型 描述
Total Integer 返回的数据条数
示例值:1
ScaleList Array of ScaleInfomation 返回的数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "Time": 1587830400, "RoomNumbe
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询历史房间与用户规模信息

查询历史房间与用户规模信息。

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeScaleInfo
<公共请求参数>

{
    "StartTime": 1590065777,
    "SdkAppId": 1400353843,
    "EndTime": 1590065877
}

输出示例

{
    "Response": {
        "Total": 4,
        "ScaleList": [
            {
                "Time": 1587830400,
                "RoomNumbers": 130644,
                "UserNumber": 2111978,
                "UserCount": 7004243
            },
            {
                "Time": 1587744000,
                "RoomNumbers": 79241,
                "UserNumber": 781494,
                "UserCount": 2968232
            },
            {
                "Time": 1587657600,
                "RoomNumbers": 180341,
                "UserNumber": 3047931,
                "UserCount": 10839565
            },
            {
                "Time": 1587571200,
                "RoomNumbers": 185469,
                "UserNumber": 3267726,
                "UserCount": 11656700
            }
        ],
        "RequestId": "70259dd1-c935-4a31-8576-f4daadd942ef"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库查询异常。
InternalError.HttpParaseFalied http请求解析失败。
InternalError.InterfaceErr 接口错误。
InternalError.MethodErr 不支持的方法。
InvalidParameter.BodyParamsError body 解析参数失败。
InvalidParameter.EndTs EndTs参数错误。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.SdkAppid 不能操作的SdkAppid。
InvalidParameter.StartTs StartTs参数错误。
InvalidParameter.StartTsOversize 查询开始时间超过文档限制。
InvalidParameter.UserIdsMorethanSix 用户数超过6个。
MissingParameter.EndTs 缺少endTS_s参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.StartTs 缺少startTS_s参数。