有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

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

查询互动白板房间维度每天计费用量。

  1. 单次查询统计区间最多不能超过31天。
  2. 由于统计延迟等原因,暂时不支持查询当天数据,建议在次日上午7点以后再来查询前一天的用量,例如在10月27日上午7点后,再来查询到10月26日整天的用量

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTIWRoomDailyUsage。
Version String 公共参数,本接口取值:2019-09-19。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 互动白板应用SdkAppId
示例值:1400000001
SubProduct String 需要查询的子产品用量,支持传入以下值
- sp_tiw_board: 互动白板时长,单位为分钟
- sp_tiw_ric: 实时录制时长,单位分钟
示例值:sp_tiw_board
StartTime Date 开始时间,格式YYYY-MM-DD,查询结果里包括该天数据
示例值:2021-10-01
EndTime Date 结束时间,格式YYYY-MM-DD,查询结果里包括该天数据,单次查询统计区间最多不能超过31天。
示例值:2021-10-31
RoomIDs.N Array of Integer 需要查询的房间ID列表,不填默认查询全部房间
Offset Integer 查询偏移量,默认为0
示例值:0
Limit Integer 每次查询返回条目限制,默认为20
示例值:20

3. 输出参数

参数名称 类型 描述
Usages Array of RoomUsageDataItem 指定区间指定产品的房间用量列表
Total Integer 用量列表总数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询房间维度每天计费用量

查询2022-11-24到2022-11-25的互动白板房间计费用量

输入示例

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

{
    "SdkAppId": "1400000001",
    "SubProduct": "sp_tiw_board",
    "Limit": "20",
    "StartTime": "2022-11-24",
    "Offset": "0",
    "EndTime": "2022-11-25"
}

输出示例

{
    "Response": {
        "RequestId": "916f3549-8e91-467c-afcb-b8dacf188e12",
        "Usages": [
            {
                "Time": "2022-11-24",
                "SdkAppId": 1400000001,
                "SubProduct": "sp_tiw_board",
                "RoomID": 432946024,
                "Value": 5
            },
            {
                "Time": "2022-11-24",
                "SdkAppId": 1400000001,
                "SubProduct": "sp_tiw_board",
                "RoomID": 523696026,
                "Value": 60
            },
            {
                "Time": "2022-11-24",
                "SdkAppId": 1400000001,
                "SubProduct": "sp_tiw_board",
                "RoomID": 1284910005,
                "Value": 4
            }
        ],
        "Total": 3
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.SdkAppIdNotFound SdkAppId不存在或格式错误。
InvalidParameter.TranscodeParameter 文档转码参数格式不正确。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。