1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
腾讯云点播为客户提供了媒体上传、媒体管理、媒体处理等等服务,在这些服务执行过程或执行结束时,腾讯云点播也提供各种对应的事件通知,方便开发者感知服务处理状态,并做下一步的业务操作。
开发者可以通过调用本接口来实现:
- 设置接收回调通知的类型,目前有 HTTP 回调通知 和 基于消息队列的可靠通知 两种类型。
- 对于 HTTP 回调通知,可设置 3.0 格式回调的地址。3.0 格式回调的说明参见 历史格式回调。
- 对具体事件服务的通知事件选择设置接收或者忽略。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyEventConfig。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Mode | 否 | String | 接收事件通知的方式。 示例值:PUSH |
NotificationUrl | 否 | String | 采用 HTTP 回调通知 接收方式时,用于接收 3.0 格式回调的地址。 注意:如果带 NotificationUrl 参数且值为空字符串时将会清空 3.0 格式回调地址。 示例值:http://mydemo.com/receiveevent |
UploadMediaCompleteEventSwitch | 否 | String | 是否接收 视频上传完成 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。 示例值:ON |
DeleteMediaCompleteEventSwitch | 否 | String | 是否接收 视频删除完成 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。 示例值:ON |
PersistenceCompleteEventSwitch | 否 | String | 是否接收剪辑固化完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。 示例值:OFF |
SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:123 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置事件通知信息
输入示例
https://vod.tencentcloudapi.com/?Action=ModifyEventConfig
&Mode=PUSH
&NotificationUrl=http://mydemo.com/receiveevent
&UploadMediaCompleteEventSwitch=ON
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
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 | 操作失败。 |
FailedOperation.InvalidVodUser | 没有开通点播业务。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |