You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
直播消息回调
直播间基础配置变化回调
复制全文
下载 pdf
直播间基础配置变化回调

作用

当直播间基础配置发生变化时,企业直播会向您设置的回调地址发送回调消息。

配置方式

完成回调配置。详见回调配置

详情

完成回调配置后,当直播间基础配置发生变化时,企业直播会将直播间 ID 等直播间基础配置信息以 POST 方式提交给您设置的回调地址。
请求示例如下所示:

POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
    "ActivityID": "182565784636****",
    "ActivityTags": "{\"SelectTags\":[{\"Name\":\"标签 1\",\"Index\":1,\"Value\":\"A\",\"TagType\":0},{\"Name\":\"标签 2\",\"Index\":2,\"Value\":\"B\",\"TagType\":0}],\"TextTags\":[{\"Name\":\"标签 3\",\"Index\":0,\"Value\":\"C\",\"TagType\":1},{\"Name\":\"标签 4\",\"Index\":1,\"Value\":\"D\",\"TagType\":1}]}",
    "Announcement": "",
    "CoverImage": "//p1-live.****.com/tos-cn-i-********/29133e7411044423ac4201********~tplv-gjr7********.image",
    "EventType": "ActivityBasicConfigModifyCallBack",
    "LanguageType": [],
    "LiveTime": "1741178280",
    "Name": "直播间 A",
    "RequestUuid": "ActivityBasicConfigModifyCallBack-182574625960****",
    "Sign": "8e1d9be111d24211ccca103335c4****",
    "SubAccountName": "admin@bytedance.com",
    "Timestamp": "1741175815",
    "VerticalCoverImage": "https://p1-live.****.com/tos-cn-i-********/29133e7411044423ac4201********~tplv-gjr7********.image",
    "ViewUrl": "https://example.com/6326********/1300********"
}

超时重试

回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。

参数

参数

类型

说明

ActivityID

String

直播间 ID。

SubAccountName

String

创建直播间的账号。参数值 admin@bytedance.com 表示直播间为主账号创建。

EventType

String

回调通知的事件类型,固定取值为 ActivityBasicConfigModifyCallBack

Timestamp

String

发送回调请求的时间。Unix 时间戳,单位为秒。

Sign

String

校验签名。
完成以下步骤,计算校验签名。

  1. 按照 AccountSecretActivityIDAnnouncementCoverImageEventTypeLiveTimeNameTimestampViewUrl 的顺序,拼接对应的参数值。
  2. 将拼接后的内容进行 MD5 加密生成 32 位小写字符串。

说明

AccountSecret 的取值可通过控制台获取。详见步骤二:获取鉴权密钥

Name

String

直播间标题。

Announcement

String

直播间描述。

说明

仅在直播间开启并配置了直播描述时,该参数有值。

CoverImage

String

横屏封面图 URL。

  • 若通过控制台配置横屏封面图且配置成功,则封面图 URL 无协议头。
  • 若通过调用 API 接口配置横屏封面图,则封面图 URL 有协议头。

ViewUrl

String

观看地址。

LiveTime

String

开播时间。Unix 时间戳,单位为秒。

RequestUuid

String

请求回调的唯一标识。

ActivityTags

String

直播间配置的标签信息。详见 ActivityTags

说明

仅在直播间配置了分类标签或文本标签值时,该参数有值。

VerticalCoverImage

String

竖屏封面图 URL,包含协议头。

LanguageType

Array of Integer

观看页语言。取值如下:

  • 0:简中
  • 1:英文
  • 2:日文
  • 3:繁中
  • 4:韩语

说明

仅在直播间开启并配置了观看页语言时,该参数有值。

ActivityTags

参数

类型

描述

SelectTags

Array of ActivityTag

直播间分类标签列表。

TextTags

Array of ActivityTag

直播间文本标签列表。

ActivityTag

参数

类型

描述

Index

Integer

标签的索引值,用于标识标签在控制台展示的位置。索引值越小,位置越靠前。取值从 0 开始计数。

Name

String

标签名称。

Value

String

标签值。

TagType

Integer

标签类型。取值如下:

  • 0:分类标签
  • 1:文本标签
最近更新时间:2025.08.01 16:30:18
这个页面对您有帮助吗?
有用
有用
无用
无用