ListCallbackConfigs - 获取回调配置信息--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

ListCallbackConfigs - 获取回调配置信息

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

调用 ListCallbackConfigs接口，获取主账号或子账号指定类型的回调配置信息。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCallbackConfigs`	接口名称。当前 API 的名称为 `ListCallbackConfigs`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
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`：签到参与回调
CallbackUrl	String	否	`a.com`	按回调地址筛选，必须以 HTTPS 或 HTTP 开头。支持模糊搜索。例如，当参数取值为 `a` 时，返回回调地址为 `a.com`、`*.a.com` 等回调配置。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认值为 `10`。取值范围为 [1,500]。
SubAccountName	String	否	`admin@bytedance.com`	按回调生效账号筛选。默认返回所有回调生效账号的回调配置信息。参数取值为 `admin@bytedance.com` 时，仅返回回调生效账号为主账号的回调配置信息。参数取值为子账号的账号时，仅返回回调生效账号为该子账号的回调配置信息。您可通过调用 ListSubAccounts 接口，获取子账号的账号。

返回参数

参数	类型	示例值	描述
CallbackConfigs	Array of CallbackConfigs	`-`	回调配置信息。
TotalCount	Long	`10`	回调配置总数。

CallbackConfigs

参数	类型	示例值	描述
Id	Long	`123456`	回调配置的唯一标识符。
CallbackType	Integer	`1`	回调消息类型，用于标识回调事件的具体类型。取值如下： `1`：直播状态变化回调 `2`：直播间创建或删除回调 `4`：直播间基础配置变化回调 `6`：直播回放生成回调 `7`：直播预约结果回调 `8`：实时抽奖结果回调 `9`：累计观看抽奖结果回调 `10`：红包结果回调 `11`：合并回放视频结果回调 `13`：剪辑视频结果回调 `14`：直播预约点击回调 `16`：飞书客户端内企业直播子账号申请回调 `17`：直播间数据导出回调 `18`：聊天 AI 分析结果回调 `19`：卡券领取批量聚合回调 `20`：切片录制视频生成回调 `21`：商品卡片配置变化回调 `22`：评论发送回调 `23`：观众状态变化回调 `24`：累计观看抽奖结果批量聚合回调 `25`：参与实时抽奖回调 `26`：批量上传视频至视频库结果回调 `27`：媒资库视频转码完成回调
CallbackUrls	String	`https://example.com/callback`	回调地址，包含协议头。用于接收 `CallbackType` 对应类型的回调消息。
FollowerUserName	String	`+86188xxxxx1234`	回调生效账号。回调生效账号为主账号时，参数取值固定为 `admin@bytedance.com`。回调生效账号为子账号时，参数取值为子账号的账号。
FollowerNickName	String	`子账号 A`	子账号的昵称。
AccountSecret	String	`abc123xyz`	回调生效账号的鉴权密钥，用于计算回调的校验签名。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListCallbackConfigs&Version=2023-08-01&CallbackType=1&CallbackUrl=a.com&PageNumber=1&PageSize=10&SubAccountName=admin@bytedance.com

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListCallbackConfigs",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "CallbackConfigs": [
            {
                "CallbackType": 1,
                "FollowerUserName": "+86188xxxxx1234",
                "FollowerNickName": "子账号 A",
                "AccountSecret": "abc123xyz",
                "Id": 123456,
                "CallbackUrls": "https://example.com/callback"
            }
        ],
        "TotalCount": 10
    }
}

错误码

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