有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

该接口为监控数据接口,数据采集及统计方式与计费数据不同,仅供运营分析使用,不能用于计费对账参考。
用于查询回调事件。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCallbackRecordsList。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
StartTime String 起始时间点,接口查询支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 ISO 日期格式说明
2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。
示例值:2020-10-12T00:00:00+08:00
EndTime String 结束时间点,接口查询支持两种时间格式:
1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 ISO 日期格式说明
2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。

查询的起始和结束时间跨度不支持超过1天。仅支持查询最近14天的数据。
示例值:2020-10-12T00:00:00+08:00
StreamName String 流名称,精确匹配。
示例值:test
PageNum Integer 页码。
示例值:1
PageSize Integer 每页条数。
示例值:10
EventType Integer 事件类型。
0: "断流",
1: "推流",
100: "录制"
200: "截图回调"。
示例值:1
ResultCode Integer 回调结果。
0为成功,其他为失败。
示例值:0

3. 输出参数

参数名称 类型 描述
DataInfoList Array of CallbackEventInfo 回调事件列表。
PageNum Integer 页码。
示例值:1
PageSize Integer 每页条数。
示例值:10
TotalNum Integer 总条数。
示例值:11
TotalPage Integer 总页数。
示例值:2
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

用于查询回调事件。

输入示例

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

{
    "StreamName": "test",
    "StartTime": "2020-10-12T00:00:00+08:00",
    "EndTime": "2020-10-12T00:10:00+08:00",
    "PageNum": 1,
    "PageSize": 10
}

输出示例

{
    "Response": {
        "DataInfoList": [
            {
                "EventTime": "2020-10-12T00:00:00+08:00",
                "EventType": 1,
                "Request": "abc",
                "Response": "abc",
                "ResponseTime": "2020-10-12T00:00:00+08:00",
                "ResultCode": 1,
                "StreamId": "abc"
            }
        ],
        "PageNum": 1,
        "PageSize": 1,
        "TotalNum": 1,
        "TotalPage": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。