You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

添加或更新回调配置

最近更新时间：2023.10.23 16:15:05

首次发布时间：2023.09.25 14:37:16

我的收藏

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

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

MessageType

String

是

push

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

  • push：推流开始回调；
  • push_end：推流结束回调；
  • snapshot：截图回调；
  • record：录制回调；
  • audit_snapshot：截图审核回调。
VhostString否push.live.example.com域名空间名称。Vhost 和 Domain 传且仅传一个。
DomainString否push.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

参数类型是否必选示例值描述
CallbackTypeString是http回调类型，支持设置为 HTTP，表示可以使用 HTTP 和 HTTPS 接收回调事件。
URLString是http://example.com/callback回调的 URL。

返回参数

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

示例

请求示例

POST https://live.volcengineapi.com?Action=UpdateCallback&Version=2023-01-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":"2023-01-01",
    "Service":"live",
    "Region": "cn-north-1"
  },
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.Format%s format error参数格式错误，请检查错误消息中指定参数中是否存在非法字符或 URL 格式错误。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围，请检查错误消息中指定参数的取值是否超出取值范围。
400InvalidParam.DomainAndAppdomain and app exist can not exist at the same time入参不能同时传入 Domain 和 App ，请修改入参。
400InvalidParam.Empty%s is required参数缺失，请检查错误消息中指定的参数是否传入。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
404ResourceNotFound.VhostNotExistvhost not found未找到域名空间（Vhost）。请检查传入的域名空间是否与实际使用的域名空间一致。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.DBan internal error related to database occurred, please contact the administrator.出现与数据库相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。