AccountID

String

账号 ID。

ActivityID

String

直播间 ID。

SubAccountName

String

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

EventType

String

回调通知的事件类型，固定取值为 ActivityAwardInfoCallBack。

Timestamp

String

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

Sign

String

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

1. 按照 AccountSecret、AccountID、ActivityID、EventType、Timestamp 的顺序，拼接对应的参数值。
2. 将拼接后的内容进行 MD5 加密生成 32 位小写字符串。

ActivityName

String

直播间标题。

AwardId

String

抽奖 ID。

Name

String

抽奖名称。

AwardItemId

String

奖品 ID。

RequestUuid

String

请求回调的唯一标识。

AwardName

String

奖品名称。

AwardItemType

String

奖品类型。取值如下：

• 1：实物奖品
• 2：虚拟奖品
• 3：卡券奖品或积分奖品
• 4：奖券奖品

DeliveryMethod

String

卡券奖品或积分奖品。取值如下：

• 1：卡券
• 2：积分

AwardItemNum

String

• 若奖品类型为卡券奖品，该字段表示关联的卡券 ID。您可通过该 ID，将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
• 若奖品类型为积分奖品，该字段表示积分奖品的批次号。您可根据该批次号识别企业积分，向观众发放积分。

AwardItemAmounts

String

每位中奖观众可获得的积分数额。您可根据该中奖金额，判断向中奖观众发放多少积分。取值范围：[1, 99999]。

UserInfos

Array of UserAwardInfo

中奖观众信息。

UserID

String

用户 ID。

ExternalID

String

关联用户 ID，即观众在第三方平台的唯一标识。
您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。
观众通过不同方式登录直播间，关联用户 ID 的取值如下所示。

• 微信：观众在企业直播微信服务号的 OpenID。
• 企业微信：绑定企业直播的企业内部成员 OpenID。
• 自定义：自定义登录时通过 UserId 传入的值。详见自定义登录。
• OAuth 2.0：您自有账号系统中用户 ID 对应的字段。
• 飞书：绑定企业直播的飞书企业成员 Open ID。
• 手机号：观众通过手机号注册企业直播后生成的 passport_id。
• 白名单：观众输入的白名单校验信息。

Extra

String

业务方扩展参数，对应观看页地址中的 extra 字段，例如：https://live.xxx.com/9854/1315744?extra=xxx。

NickName

String

昵称。

UserAccessIP

String

IP 地址。

UserAgent

String

终端类型。

Telephone

String

观众登录直播间时使用的手机号。

IsPriorityUser

String

是否为优先中奖用户。取值如下：

• 0：否
• 1：是