AddCallbackConfig - 新增回调配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

AddCallbackConfig - 新增回调配置信息

最近更新时间：2025.11.05 11:00:13首次发布时间：2025.08.01 16:30:19

调用 AddCallbackConfig接口，为主账号或子账号新增指定类型的回调配置信息。

注意事项

请求频率：单用户请求频率限制为 1 次/秒。
前提条件：确保您拥有火山引擎主账号或具备开发集成 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=AddCallbackConfig&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AddCallbackConfig`	接口名称。当前 API 的名称为 `AddCallbackConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

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

参数	类型	是否必选	示例值	描述
CallbackType	Integer	是	`1`	回调消息类型，用于标识回调事件的具体类型。取值如下： `1`：直播状态变化回调 `2`：直播间创建或删除回调 `4`：直播间基础配置变化回调 `6`：直播回放生成回调 `7`：直播预约结果回调 `8`：实时抽奖结果回调 `10`：红包结果回调 `11`：合并回放视频结果回调 `13`：剪辑视频结果回调 `14`：直播预约点击回调 `16`：飞书客户端内企业直播子账号申请回调 `17`：直播间数据导出回调 `18`：聊天 AI 分析结果回调 `19`：卡券领取批量聚合回调 `20`：切片录制视频生成回调 `21`：商品卡片配置变化回调 `22`：评论发送回调 `23`：观众状态变化回调 `24`：累计观看抽奖结果批量聚合回调 `25`：参与实时抽奖回调 `26`：批量上传视频至视频库结果回调 `27`：媒资库视频转码完成回调 `28`：签到状态变化回调 `29`：签到参与回调
CallbackUrls	String	是	`https://example.com/callback`	回调地址，必须以 HTTPS 或 HTTP 开头。用于接收 `CallbackType` 对应类型的回调消息。说明每个回调生效账号最多可配置 10 个回调地址，每个回调地址之间通过分号（;）分隔。
SubAccountName	String	否	`xxx@qq.com`	回调生效账号。参数取值为子账号的账号。您可调用 ListSubAccounts 接口，通过参数 `Name` 获取子账号的账号。仅在使用主账号调用接口时该参数生效。调用接口后，主账号会替该子账号新增对应回调消息类型的回调配置，如果子账号为回调生效账号，则仅当该子账号的资源触发回调时，才会向回调地址发送回调消息。例如，您为卡券领取批量聚合回调设置子账号 A 作为回调生效账号，则只有当观众在子账号 A 创建的直播间领取卡券时，企业直播才会发送回调消息到对应的回调地址。说明如果该子账号无开发集成的可编辑权限，则无法编辑或删除该回调配置。如果不传该参数或传空值，回调生效账号为调用接口的账号。

CallbackType

Integer

是

1

回调消息类型，用于标识回调事件的具体类型。取值如下：

1：直播状态变化回调
2：直播间创建或删除回调
4：直播间基础配置变化回调
6：直播回放生成回调
7：直播预约结果回调
8：实时抽奖结果回调
10：红包结果回调
11：合并回放视频结果回调
13：剪辑视频结果回调
14：直播预约点击回调
16：飞书客户端内企业直播子账号申请回调
17：直播间数据导出回调
18：聊天 AI 分析结果回调
19：卡券领取批量聚合回调
20：切片录制视频生成回调
21：商品卡片配置变化回调
22：评论发送回调
23：观众状态变化回调
24：累计观看抽奖结果批量聚合回调
25：参与实时抽奖回调
26：批量上传视频至视频库结果回调
27：媒资库视频转码完成回调
28：签到状态变化回调
29：签到参与回调

CallbackUrls

String

是

https://example.com/callback

回调地址，必须以 HTTPS 或 HTTP 开头。用于接收 CallbackType 对应类型的回调消息。

说明

每个回调生效账号最多可配置 10 个回调地址，每个回调地址之间通过分号（;）分隔。

SubAccountName

String

否

xxx@qq.com

回调生效账号。参数取值为子账号的账号。您可调用 ListSubAccounts 接口，通过参数 Name 获取子账号的账号。
仅在使用主账号调用接口时该参数生效。调用接口后，主账号会替该子账号新增对应回调消息类型的回调配置，
如果子账号为回调生效账号，则仅当该子账号的资源触发回调时，才会向回调地址发送回调消息。例如，您为卡券领取批量聚合回调设置子账号 A 作为回调生效账号，则只有当观众在子账号 A 创建的直播间领取卡券时，企业直播才会发送回调消息到对应的回调地址。

说明

如果该子账号无开发集成的可编辑权限，则无法编辑或删除该回调配置。
如果不传该参数或传空值，回调生效账号为调用接口的账号。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	回调配置是否新增成功。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=AddCallbackConfig&Version=2023-08-01
{
    "CallbackType": 1,
    "CallbackUrls": "https://example.com/callback",
    "SubAccountName": "xxx@qq.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddCallbackConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

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