You need to enable JavaScript to run this app.
导航

实时抽奖结果回调

最近更新时间2024.04.23 17:22:02

首次发布时间2022.11.22 11:12:49

作用

配合实时抽奖功能使用,实时抽奖活动开奖时回调中奖观众结果。

配置方式

将接收回调通知的接口地址提供给企业直播技术支持。

详情

设置回调的接口地址后,当该账号下的直播间实时抽奖活动开奖时,企业直播会将直播间的 ID 以及中奖观众信息以 POST 方式提交给您自定义的回调接口。如果配置了多个奖品,则每种奖品的回调信息将分别返回。单次回调最多返回 2,000 条中奖观众信息,若某奖品的中奖观众数量超过该上限,则拆分为多条回调消息进行返回。

超时重试

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

参数

注意

请联系技术支持获取鉴权 AccountSecret。

参数

类型

说明

AccountID

String

用户账号的 ID。

ActivityID

String

抽奖直播间的 ID。

EventType

String

ActivityAwardInfoCallBack

Timestamp

String

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

Sign

String

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

  1. 按照 AccountSecretAccountIDActivityIDEventTypeTimestamp 的顺序,拼接对应的参数值。
  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

卡券或积分的批次号。您可根据该批次号识别企业的卡券或积分,向观众发放奖品。最多支持输入 256 个字符。

AwardItemAmounts

String

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

UserInfos

Array of UserAwardInfo

中奖用户信息。

UserAwardInfo

参数

类型

描述

UserID

String

用户 ID。

ExternalID

String

观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 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:是