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

查询回调配置

最近更新时间：2023.10.12 17:39:57

首次发布时间：2021.11.10 15:01:13

我的收藏

根据 Domain 和 App 类型信息，查询对应的回调信息。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString否push.live.example.com域名空间名称，Vhost 和 Domain 传且仅传一个。
DomainString否push.live.example.com推流域名。Vhost 和 Domain 传且仅传一个。

MessageType

String

否

push

消息类型，缺省情况下表示查询全部。包括以下类型。

  • push：推流开始回调；
  • push_end：推流结束回调；
  • snapshot：截图回调；
  • record：录制回调；
  • audit_snapshot：截图审核回调。
AppString否example_app应用名称，缺省情况下表示查询全部。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
CallbackListArray of CallbackList-回调列表。

CallbackList

参数类型示例值描述

MessageType

String

push

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

  • push：推流开始回调；
  • push_end：推流结束回调；
  • snapshot：截图回调；
  • record：录制回调；
  • audit_snapshot：截图审核回调。
VhostStringpush.live.example.com域名空间名称
AppStringpush.live.example.com应用名称
CallbackDetailListArray of CallbackDetailList-回调数据列表

TranscodeCallback

Integer

0

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

  • 0：false，不开启；
  • 1：true，开启。
CreateTimeString2021-01-02T15:04:05+8:00创建时间
AuthKeyPrimaryString1622194197-0-0-5552*****e4e20387c6dc18afce****密钥
AuthEnableBooleanfalse开启鉴权

CallbackDetailList

参数类型示例值描述
CallbackTypeStringhttp回调类型，返回 HTTP，表示可以使用 HTTP 和 HTTPS 接收回调事件
URLStringhttp://example.com/callback回调的 URL

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeCallback&Version=2020-08-01
{
  "Vhost": "push.live.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "202108291443190102121532040E197F15",
    "Action": "DescribeCallback",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "CallbackList": [
      {
        "App": "example",
        "AuthEnable": false,
        "AuthKeyPrimary": "",
        "CallbackDetailList": [
          {
            "CallbackType": "http",
            "URL": "http://example.com/callback"
          }
        ],
        "Domain": "",
        "MessageType": "push",
        "TranscodeCallback": 0,
        "Vhost": "push.live.example.com"
      }
    ]
  }
}

错误码

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