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

删除回调配置

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

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

我的收藏

删除指定的 Vhost 和 APP 下的某个指定类型的回调配置。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString否push.live.example.com域名空间名称。如创建回调 UpdateCallback 时传了参数 Vhost，删除时需要传 Vhost
DomainString否push.live.example.com推流域名。如创建回调 UpdateCallback 时传了参数 Domain，删除时需要传 Domain

MessageType

String

否

push

消息类型。缺省情况下表示删除所有消息类型。包括以下类型。

  • push：推流开始回调；
  • push_end：推流结束回调；
  • snapshot：截图回调；
  • record：录制回调；
  • audit_snapshot：截图审核回调。
AppString否example_app应用名称。缺省情况下表示删除 Vhost 下的所有回调配置。如果入参选择 Domain，则不可同时传 App

返回参数

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

示例

请求示例

POST https://live.volcengineapi.com?Action=DeleteCallback&Version=2020-08-01
{
  "App": "example_app",
  "Domain": "",
  "MessageType": "push",
  "Vhost": "push.live.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "DeleteCallback",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

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