最近更新时间：2023.09.25 21:09:55
首次发布时间：2021.11.10 15:01:13
添加或更新直播推流、直播断流、录制和截图的回调。在更新场景下，调用成功后，会对所有的回调内容做全量更新。
说明
该接口数据历史版本 API，我们计划于 2023 年 12 月 25 日停止对其进行维护，并于 2024 年 3 月 25 日下线文档，建议您使用新版添加或更新回调配置接口。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateCallback | 接口名称。当前 API 的名称为 UpdateCallback。 |
| Version | String | 是 | 2020-08-01 | 接口版本。当前 API 的版本为 2020-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
MessageType | String | 是 |
| 消息类型。包括以下类型。
|
| Vhost | String | 否 | push.live.example.com | 域名空间名称。Vhost 和 Domain 传且仅传一个。 |
| Domain | String | 否 | push.live.example.com | 推流域名。Vhost 和 Domain 传且仅传一个。 |
App | String | 否 |
| 应用名称，默认查询所有应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。 |
TranscodeCallback | Integer | 否 |
| 是否开启转码流回调，默认为 0。取值及含义如下所示。
|
| CallbackDetailList | Array of CallbackDetailList | 是 | - | 回调信息列表 |
AuthEnable | Boolean | 否 |
| 是否开启鉴权，默认为 false。取值及含义如下所示。
|
AuthKeyPrimary | String | 否 |
| 回调密钥 说明 如果 AuthEnable 为 true，则回调密钥必填。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| CallbackType | String | 是 | http | 回调类型，支持设置为 HTTP，表示可以使用 HTTP 和 HTTPS 接收回调事件 |
| URL | String | 是 | http://example.com/callback | 回调的 URL |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://live.volcengineapi.com?Action=UpdateCallback&Version=2020-08-01 { "Vhost": "push.live.example.com", "App": "example_app", "MessageType": "push", "TranscodeCallback": 0, "CallbackDetailList": [ { "CallbackType": "http", "URL": "http://example.com/callback" } ] }
{ "ResponseMetadata":{ "RequestId":"201806041104200100100232280022D30", "Action":"UpdateCallback", "Version":"2020-08-01", "Service":"live", "Region": "cn-north-1" }, }
访问公共错误码获取详细信息。