1. 接口描述
接口请求域名: lcic.tencentcloudapi.com 。
信令录制视频观看记录查询接口,用于查询指定课堂在指定时间段内的用户播放记录。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribePlayRecords。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-17。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| SdkAppId | 是 | Integer | 低代码互动课堂的SdkAppId。 示例值:3520371 |
| RoomId | 是 | Integer | 房间ID。 示例值:322220255 |
| StartTime | 是 | Integer | 开始时间,unix时间戳(秒)。 示例值:1770174290 |
| EndTime | 是 | Integer | 结束时间,unix时间戳(秒)。 示例值:1770260690 |
| Page | 是 | Integer | 页码,从1开始递增。 默认值:1 示例值:1 |
| PageSize | 是 | Integer | 每页获取的记录条数。 取值范围:[1, 200] 默认值:20 示例值:10 |
| UserId | 否 | String | 用户ID。 示例值:2qkMhWixIzNQC7UizlM7*** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总条数。 示例值:8 |
| Records | Array of PlayRecord | 信令录制视频回放观看记录列表。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询信令录制回放观看记录。
输入示例
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePlayRecords
<公共请求参数>
{
"SdkAppId": 3520371,
"RoomId": 322220255,
"StartTime": 1770174290,
"EndTime": 1770260690,
"Page": 1,
"PageSize": 10,
"UserId": "2qkMhWixIzNQC7UizlM7*******"
}
输出示例
{
"Response": {
"Records": [
{
"Duration": 93677,
"PlayBeginTime": 1770184233,
"PlayEndTime": 1770184329,
"RoomId": 322220255,
"SessionId": "322220255-1770184231997-1345",
"UserId": "2qkMhWixIzNQC7UizlM7*******"
}
],
"Total": 8,
"RequestId": "c29649d6-a8c7-4c0c-923f-ad569af81598"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。