You need to enable JavaScript to run this app.
导航
添加或更新回调配置
最近更新时间:2023.10.12 17:39:57首次发布时间:2021.11.10 15:01:13

添加或更新直播推流、直播断流、录制和截图的回调。在更新场景下,调用成功后,会对所有的回调内容做全量更新。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版添加或更新回调配置接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=UpdateCallback&Version=2020-08-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringUpdateCallback接口名称。当前 API 的名称为 UpdateCallback
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述

MessageType

String

push

消息类型。包括以下类型。

  • push:推流开始回调;
  • push_end:推流结束回调;
  • snapshot:截图回调;
  • record:录制回调;
  • audit_snapshot:截图审核回调。
VhostStringpush.live.example.com域名空间名称。Vhost 和 Domain 传且仅传一个。
DomainStringpush.live.example.com推流域名。Vhost 和 Domain 传且仅传一个。

App

String

example_app

应用名称,默认查询所有应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成。
如果入参选择 Domain,则不可同时传 App

TranscodeCallback

Integer

0

是否开启转码流回调,默认为 0。取值及含义如下所示。

  • 0:false,不开启;
  • 1:true,开启。
CallbackDetailListArray of CallbackDetailList-回调信息列表

AuthEnable

Boolean

false

是否开启鉴权,默认为 false。取值及含义如下所示。

  • false:不开启;
  • true:开启。

AuthKeyPrimary

String

1622194197-0-0-5552*****e4e20387c6dc18afce****

回调密钥

说明

如果 AuthEnable 为 true,则回调密钥必填。

CallbackDetailList

参数类型是否必选示例值描述
CallbackTypeStringhttp回调类型,支持设置为 HTTP,表示可以使用 HTTP 和 HTTPS 接收回调事件
URLStringhttp://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"
  },
}

错误码

访问公共错误码获取详细信息。