1. 接口描述
接口请求域名: iss.tencentcloudapi.com 。
用于获取云端录像回放url地址
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRecordPlaybackUrl。 |
Version | 是 | String | 公共参数,本接口取值:2023-05-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ChannelId | 是 | String | 设备通道ID 示例值:32525dd7-c3fc-****-d5beb4acd1e1 |
StartTime | 是 | Integer | 回放开始时间,UTC秒数,例如:1662114146,开始和结束时间段最长为一天,且不能跨天 示例值:1687677795 |
EndTime | 是 | Integer | 回放结束时间,UTC秒数,例如:1662114246,开始和结束时间段最长为一天,且不能跨天 示例值:1687688595 |
IsInternal | 否 | Boolean | 是否获取内网地址 示例值:false |
CorrectTimestamp | 否 | Boolean | 云录像回放时,是否需要开启时间戳矫正,主要解决时间戳反转,会退等问题导致无法播放 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | RecordPlaybackUrl | 返回结果 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
POST / HTTP/1.1
Host: iss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRecordPlaybackUrl
<公共请求参数>
{
"ChannelId": "32525dd7-c3fc-****-****-d5beb4acd1e1",
"StartTime": 1687677795,
"EndTime": 1687688595
}
输出示例
{
"Response": {
"Data": {
"Hls": "https://test5.maxshang.cn/playback/32525dd7-c3fc-****-****-d5beb4acd1e1/hls.m3u8?starttime=1687677795&endtime=1687688595&token=13*******2_1687677842_68dfc39854510520f29de4da78bd6e93"
},
"RequestId": "ba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败 |
InvalidParameter.InvalidBodyFormat | 无效的消息体格式 |
InvalidParameter.InvalidParameter | 无效的输入参数 |
InvalidParameterValue.IllegalChannelId | 通道ID包含了非法字符 |
InvalidParameterValue.InvalidChannelId | 无效的通道ID |
InvalidParameterValue.InvalidStartTimeOrEndTime | 无效的开始或结束时间 |
InvalidParameterValue.NonSameDay | 时间不能跨天 |
InvalidParameterValue.StartTimeGreaterThanOrEqualEndTime | 开始时间不能大于等于结束时间 |
ResourceNotFound.ChannelNotExist | 通道不存在 |
ResourceNotFound.DeviceNotExist | 设备不存在 |
UnsupportedOperation.UnopenedIntranetServicesInRegion | 该地域未开通内网服务 |