有奖:语音产品征文挑战赛火热进行中> HOT

1. 接口描述

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

用于获取云录像下载 url

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVideoDownloadUrl。
Version String 公共参数,本接口取值:2023-05-17。
Region String 公共参数,详见产品支持的 地域列表
ChannelId String 通道 ID
示例值:00037e5f-2aaa---f30b13a86b02
BeginTime String 下载的开始时间,UTC 秒数,开始和结束时间段最长为60分钟,且不能跨天。
注意:实际下载的文件时长可能会大于该时段时长,通过指定IsRespActualTime参数可以获取实际下载的开始时间和结束时间。 原因是下载是TS切片对齐的,其目的也是为了保证用户下载数据的完整性,完全包含其指定的时间段。
示例值:1706148000
EndTime String 下载的结束时间,UTC 秒数,开始和结束时间段最长为60分钟,且不能跨天。
注意:实际下载的文件时长可能会大于该时段时长,通过指定IsRespActualTime参数可以获取实际下载的开始时间和结束时间。 原因是下载是TS切片对齐的,其目的也是为了保证用户下载数据的完整性,完全包含其指定的时间段。
示例值:1706148060
FileType String 文件格式,"mp4":mp4格式,"ts":ts文件格式
示例值:mp4
IsRespActualTime Boolean 响应data中是否携带实际下载录像的开始时间与结束时间
示例值:false
IsInternal Boolean 是否返回内网下载URL,默认是false,返回公网下载URL,true则返回内网下载URL
示例值:false

3. 输出参数

参数名称 类型 描述
Data DescribeVideoDownloadUrlData 返回的数据结构
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取云录像下载URL

输入示例

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

{
    "ChannelId": "4dfb778c-xxxxxx",
    "BeginTime": "1668996000",
    "EndTime": "1668996600",
    "FileType": "mp4"
}

输出示例

{
    "Response": {
        "Data": {
            "Url": "https://userdomain/video.mp4?source=xxxxxx",
            "ActualBeginTime": "1668996000",
            "ActualEndTime": "1668996600"
        },
        "RequestId": "******************"
    }
}

示例2 获取云录像下载URL和实际下载的录像时间

指定请求参数IsRespActualTime为true, 不指定或IsRespActualTime为false时,不返回实际的时间

输入示例

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

{
    "ChannelId": "4dfb778c-xxxxxxx",
    "BeginTime": "1668996000",
    "EndTime": "1668996600",
    "FileType": "mp4",
    "IsRespActualTime": true
}

输出示例

{
    "Response": {
        "Data": {
            "Url": "https://userdomain/video.mp4?source=xxxxxx",
            "ActualBeginTime": "1668996000",
            "ActualEndTime": "1668996600"
        },
        "RequestId": "******************"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败
InvalidParameter.DownloadUrlError 非法的下载URL
InvalidParameter.DownloadUrlHasExpired 下载URL已过期
InvalidParameterValue.InvalidBeginTime 无效的开始时间
InvalidParameterValue.InvalidChannelId 无效的通道ID
InvalidParameterValue.InvalidEndTime 无效的结束时间
InvalidParameterValue.InvalidFileType 无效的文件格式
InvalidParameterValue.NonSameDay 时间不能跨天
InvalidParameterValue.OutOfTimeRange 时间范围超限
OperationDenied.BandwidthLimitZero 带宽受限
OperationDenied.ConcurrentDownloadsOverLimit 并发下载数超限
OperationDenied.ConnectsLimitZero 链接数受限
ResourceNotFound 资源不存在
ResourceNotFound.VideoNotFound 录像不存在
ResourceUnavailable.VideoArchived 录像已归档
UnsupportedOperation.UnopenedIntranetServicesInRegion 该地域未开通内网服务