文档中心

设置回调事件

最近更新时间：2024.01.08 20:39:16

首次发布时间：2022.08.03 11:07:54

此接口用于设置回调事件。

使用说明

关于视频点播的回调机制和事件列表，请参见事件通知概述。

请求说明

请求地址：https://vod.volcengineapi.com?Action=SetCallbackEvent&Version=2022-01-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`SetCallbackEvent`	接口名称。当前 API 的名称为 `SetCallbackEvent`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
SpaceName	String	是	`test`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
Events	String	是	`FileUploadByUrlComplete`	回调事件列表。取值如下： `FileUploadByUrlComplete`：URL 批量拉取上传完成 `FileUploadComplete`：媒资上传完成 `MaterialUploadComplete`：素材上传完成 `TranscodeComplete`：工作流执行完成 `DeleteMediaComplete`：媒资删除完成 `DeleteTranscodesComplete`：媒体文件删除完成 `VideoTrackComplete`：视频剪辑完成 `UploadGetMetaComplete`：媒资上传抽取元信息完成 `UpdateMediaStorageClassComplete`：修改媒资存储类型完成说明支持设置多个回调事件，用 `,` 隔开。
AuthEnabled	String	是	`1`	是否开启回调鉴权。取值如下： `0`：（默认）关闭。 `1`：开启。
PrivateKey	String	否	`dsfhaesg887977`	设置回调鉴权密钥。取值范围为 [8,20]，支持大写字母、小写字母和数字。说明当 `AuthEnabled` 参数取值为 `1` 时，`PrivateKey` 才有效。

返回参数

本接口无特有的返回参数。更多信息请见公共返回参数。

请求示例

https://vod.volcengineapi.com?Action=SetCallbackEvent&Version=2022-01-01&AuthEnabled=1&Events=FileUploadByUrlComplete&PrivateKey=dsfhaesg887977&SpaceName=test

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202205132051******9900805A33D89",
    "Action": "SetCallbackEvent",
    "Version": "2022-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：