配合红包功能使用，用户参与红包活动时回调中奖观众结果。
将接收回调通知的接口地址提供给企业直播技术支持。
设置回调的接口地址后，当该账号下的直播间红包活动开奖时，企业直播会将直播间的 ID 以及中奖观众信息以 POST 方式提交给您自定义的回调接口。单次回调最多返回 2000 条中奖观众信息，若超出该上限则返回多条回调消息。
回调服务器在发送消息通知后，5 秒内没有收到您的服务器的响应，即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
注意
请联系技术支持获取鉴权 AccountSecret。
参数 | 类型 | 描述 |
|---|---|---|
AccountId | String | 用户账号的 ID。 |
ActivityId | String | 红包直播间的 ID。 |
EventType | String | ActivityRedPacketInfoCallBack |
Timestamp | String | 发送回调请求的时间。Unix 时间戳，单位为秒。 |
Sign | String | 校验的加密字符串，生成的规则 md5(AccountSecret + AccountId + ActivityId + EventType + Timestamp)。 |
ActivityName | String | 直播间标题。 |
RedPacketType | String | 红包类型。
|
RedPacketUnit | String | 红包的单位。
|
TotalAmount | String | 现金红包的总金额或积分红包的总积分。 |
RedPacketNumber | String | 红包总个数。 |
RewardsPointsBatch | String | 积分批次号。 说明 仅当 |
UserInfos | Array of UserRedPacketInfo | 中奖用户信息列表。 |
RequestUuid | String | 请求回调的唯一标识。 |
IsOpenWeChatWithdraw | String | 是否开启微信提现功能。
|
IsOpenSmsNotification | String | 是否开启短信提醒功能。
|
参数 | 类型 | 描述 |
|---|---|---|
UserId | String | 用户 ID。 |
ExternalId | String | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。 |
Extra | String | 业务方扩展参数。 |
NickName | String | 用户昵称。 |
UserAccessIP | String | 用户 IP 地址。 |
UserAgent | String | 用户终端类型。 |
Telephone | String | 用户通过手机号登录直播间时填写的手机号。 |
IsPriorityUser | String | 是否为优先中奖用户。
|
Amount | String | 中奖金额。
|