当直播间基础配置发生变化时,企业直播会对所设置的接口地址进行回调通知。
将接收回调通知的接口地址提供给企业直播技术支持。
设置回调的接口地址后,当直播间基础配置发生变化时,企业直播会将直播间 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 次。
说明
请联系技术支持获取鉴权 AccountSecret
。
参数 | 类型 | 说明 |
---|---|---|
ActivityID | String | 直播间 ID。 |
SubAccountName | String | 创建直播间的账号。参数值 |
EventType | String | 回调通知的事件类型,固定取值为 |
Timestamp | String | 发送回调请求的时间。Unix 时间戳,单位为秒。 |
Sign | String | 校验签名。
|
Name | String | 直播间标题。 |
Announcement | String | 直播间描述。 说明 仅在直播间开启并配置了直播描述时,该参数有值。 |
CoverImage | String | 横屏封面图 URL。
|
ViewUrl | String | 观看地址。 |
LiveTime | String | 开播时间。Unix 时间戳,单位为秒。 |
RequestUuid | String | 请求回调的唯一标识。 |
ActivityTags | String | 直播间配置的标签信息。详见 ActivityTags。 说明 仅在直播间配置了分类标签或文本标签值时,该参数有值。 |
VerticalCoverImage | String | 竖屏封面图 URL,包含协议头。 |
LanguageType | Array of Integer | 观看页语言。取值如下:
说明 仅在直播间开启并配置了观看页语言时,该参数有值。 |
参数 | 类型 | 描述 |
---|---|---|
SelectTags | Array of ActivityTag | 直播间分类标签列表。 |
TextTags | Array of ActivityTag | 直播间文本标签列表。 |
参数 | 类型 | 描述 |
---|---|---|
Index | Integer | 标签的索引值,用于标识标签在控制台展示的位置。索引值越小,位置越靠前。取值从 |
Name | String | 标签名称。 |
Value | String | 标签值。 |
TagType | Integer | 标签类型。取值如下:
|