商品卡片配置变化回调--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

商品卡片配置变化回调

最近更新时间：2025.11.12 10:56:54首次发布时间：2025.07.16 11:43:47

作用

当商品卡片配置发生变化时，例如上架商品卡片、调整商品卡片顺序、更新商品图等，企业直播会向您设置的回调地址发送回调消息。

注意

商品脚本中的商品卡片配置发生变化时，不会触发该回调。

配置方式

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

详情

完成回调配置后，当商品卡片配置发生变化时，例如上架商品卡片、调整商品卡片顺序、更新商品图等，企业直播会将发生变化的商品卡片配置信息，以及商品卡片所属的直播间 ID 等信息以 POST 方式提交给您设置的回调地址。
请求示例如下所示：

POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
    "ActivityId": "183708****043755",
    "EventType": "ProductCardModifyCallBack",
    "Products": [
        {
            "Id": 79**28,
            "Before": null,
            "After": {  
                "DirectUrls": [
                "https://example.com"
                ],
                "EnableStatus": 1,
                "ExplainStatus": 0,
                "ExplainTime": 0,
                "FloatingStatus": 0,
                "FloatingTime": 0,
                "Highlight": "¥15",
                "HotSale": "1000",
                "Id": 79**28,
                "Index": 1,
                "IntroduceImage": "https://p.example.org/***.png",
                "IsOrderMsgEnable": 1,
                "MiniAppDirectUrl": "https://example.com",
                "PromotionTagType": 1,
                "PromotionTagUrl": "https://p.example.org/***.png",
                "RedirectImage": "https://p.example.org/***.png",
                "RedirectUrl": "https://example.com",
                "Remark": "超级好吃的玫瑰慕斯蛋糕",
                "ReminderType": 1,
                "SellingPointTag": "买二赠一；满50减20",
                "Stock": "50",
                "Strikethrough": "¥30",
                "Title": "玫瑰慕斯蛋糕（小）"
            }
        }
    ],
    "RequestUuid": "ProductCardModifyCallBack-1837171****99577",
    "Sign": "d4306551c194****1af33f697456df57",
    "SubAccountName": "admin@bytedance.com",
    "Timestamp": "1741175815"
}

超时重试

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

参数

参数	类型	说明
ActivityId	String	直播间 ID。
EventType	String	回调通知的事件类型，固定取值为 `ProductCardModifyCallBack`。
Products	Array of Products	发生变化的商品卡片配置信息。
SubAccountName	String	创建直播间的账号。参数值 `admin@bytedance.com` 表示直播间为主账号创建。
Sign	String	校验签名。完成以下步骤，计算校验签名。按照 `AccountSecret`、`ActivityId`、`EventType` 的顺序，拼接对应的参数值。将拼接后的内容进行 MD5 加密生成 32 位小写字符串。说明 `AccountSecret` 的取值可通过控制台获取。详见步骤二：获取鉴权密钥。
RequestUuid	String	请求回调的唯一标识。
Timestamp	String	商品卡片配置发生变化的时间。Unix 时间戳，单位为秒。

Products

参数	类型	说明
Id	Long	商品卡片 ID。
Before	Object of Product	变化前的商品卡片配置信息。如果是新增商品卡片，则取值为 `null`。
After	Object of Product	变化后的商品卡片配置信息。如果是删除商品卡片，则取值为 `null`。

Product

参数	类型	说明
DirectUrls	Array of String	直达链接，包含协议头。当观众在环境 UA 匹配成功的移动端平台上点击商品卡片时，即可跳转至该链接。说明仅在当前商品卡片菜单开启直达链接功能时生效。
EnableStatus	Integer	是否上架商品。取值如下： `0`：下架 `1`：上架
ExplainStatus	Integer	商品讲解状态。取值如下： `0`：未讲解 `1`：讲解中 `2`：讲解结束说明仅在开启直播时移功能时，该参数生效。更多有关直播时移的信息，详见直播时移。
ExplainTime	Long	最近一次修改商品讲解状态的时间。Unix 时间戳，单位为秒。取值为 `0` 表示未修改过商品讲解状态。
FloatingStatus	Integer	是否浮窗展示商品卡片。取值如下： `1`：浮窗展示 `其他值`：非浮窗展示说明仅在未开启直播时移功能时，该参数生效。
FloatingTime	Long	最近一次浮窗展示商品卡片的时间。Unix 时间戳，单位为秒。取值为 `0` 表示商品卡片从未浮窗展示过。说明仅在未开启直播时移功能时，该参数生效。
Highlight	String	商品的售卖价，即当前价格。
HotSale	String	热卖提醒数量。说明该参数仅在 `ReminderType` 取值为 `1` 时生效。
Id	Long	商品卡片 ID。
Index	Integer	商品卡片的序号。取值范围为 [0,499]。
IntroduceImage	String	商品图的 URL，包含协议头。
IsOrderMsgEnable	Integer	是否开启下单消息。取值如下： `0`：关闭 `1`：开启
MiniAppDirectUrl	String	微信小程序链接，包含协议头。当观众在移动端微信环境点击商品卡片时，即可跳转至该微信小程序。说明仅在当前商品卡片菜单开启微信小程序跳转功能时生效。
PromotionTagType	Integer	活动标签类型。取值如下： `0`：无 `1`：自定义 `2`：超值购 `3`：惊喜特惠 `4`：低价秒杀
PromotionTagUrl	String	活动标签的 URL，包含协议头。
RedirectImage	String	跳转图的 URL，包含协议头。
RedirectUrl	String	跳转链接，即商品详情页的链接，包含协议头。如果观众无法跳转至直达链接或微信小程序，则会跳转至该链接。
Remark	String	商品介绍。
ReminderType	Integer	在商品讲解期间的浮窗商品卡片和商品卡片菜单中，动效展示的提醒类型。取值如下： `0`：无 `1`：热卖 `2`：库存
SellingPointTag	String	卖点标签。卖点间以分号（；）相隔。
Stock	String	库存提醒数量。说明该参数仅在 `ReminderType` 取值为 `2` 时生效。
Strikethrough	String	商品的参考价，即原价。
Title	String	商品名称。