1. 接口描述
接口请求域名： ivld.tencentcloudapi.com 。
创建一个视频缩编任务。
回调事件消息通知协议
网络协议
- 回调接口协议目前仅支持http/https协议；
- 请求：HTTP POST 请求，包体内容为 JSON，每一种消息的具体包体内容参见后文。
- 应答：HTTP STATUS CODE = 200，服务端忽略应答包具体内容，为了协议友好，建议客户应答内容携带 JSON：
{"code":0}
通知可靠性
事件通知服务具备重试能力，事件通知失败后会总计重试3次；
为了避免重试对您的服务器以及网络带宽造成冲击，请保持正常回包。触发重试条件如下：
- 长时间（5 秒）未回包应答。
- 应答 HTTP STATUS 不为200。
回调接口协议
分析任务完成消息回调
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| TaskId | 是 | String | 任务ID |
| TaskStatus | 是 | Integer | 任务执行状态 |
| FailedReason | 是 | String | 若任务失败，该字段为失败原因 |
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateVideoSummaryTask。 |
| Version | 是 | String | 公共参数，本接口取值：2021-09-03。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| SummaryType | 是 | Integer | 目前只支持 1，表示新闻缩编。 示例值：1 |
| VideoURL | 是 | String | 待处理的视频的URL，目前只支持不带签名的COS地址，长度最长1KB 示例值：cos://bucket/object.mp4 |
| CallbackURL | 否 | String | 任务处理完成的回调地址。 示例值：http://xxx |
| WriteBackCosPath | 否 | String | 如果需要你输出 TTS 或者视频，该字段为转存的cos桶地址且不可为空; 示例：https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${PathPrefix}/ (注意，cos路径需要以/分隔符结尾)。 示例值：https://bucket/path/ |
| ActiveVideoGenerate | 否 | Boolean | 是否开启结果视频生成功能，如果开启，需要指定WriteBackCosPath 参数 示例值：true |
| VideoRotationMode | 否 | VideoRotationMode | 生成结果视频的时候，控制生成的结果视频的横转竖参数。如果 ActiveVideoGenerate 为 false, 该参数无效。 |
| TTSMode | 否 | TTSMode | 语音合成相关的控制参数 |
| ActiveTTSOutput | 否 | Boolean | 是否输出合成好的语音列表。 示例值：true |
| ExactAsrSet.N | 否 | Array of AsrResult | 用户指定的精确的 asr 结果列表 |
| ExactTextSummary | 否 | String | 用户指定的精确的文本摘要 示例值："文本摘要" |
| ExactTextSegSet.N | 否 | Array of String | 用户指定的精确的文本摘要分割结果 示例值：["文本摘要分割1", "文本摘要分割2"] |
| ExactShotSegSet.N | 否 | Array of ShotInfo | 用户指定的精确的镜头分割结果 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 返回的任务 id 示例值：task-xxxx |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建视频缩编任务
创建视频缩编任务，并且生成视频回写到 cos。
输入示例
POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVideoSummaryTask
<公共请求参数>
{
"SummaryType": 1,
"VideoURL": "https://ai-media-1256936300.cos.ap-guangzhou.myqcloud.com/test_data/test-beijingninzao-6mins.mp4",
"WriteBackCosPath": "https://test-media-ai-251202827.cos.ap-guangzhou.myqcloud.com/ai-media/video-summary/",
"ActiveVideoGenerate": true
}输出示例
{
"Response": {
"RequestId": "5646aef2-9481-409b-ba6f-91c40f5f9de6",
"TaskId": "task-5bMQVrmJyPJ"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
