当观众在直播间点击立即参与并成功参与实时抽奖时,企业直播会对所设置的接口地址进行回调通知。
完成回调配置。详见回调配置。
设置回调的接口地址后,当观众成功参与实时抽奖时,企业直播会将参与抽奖的观众信息、直播间 ID、抽奖 ID 等数据以 POST 方式提交给您设置的回调地址。
请求示例如下所示:
POST /xxxxx HTTP/1.1 Header1: ... Header2: ... ... { "AccountID": "200000****", "ActivityID": "182573526550****", "ActivityName": "直播间 A", "AwardId": "162209****", "EventType": "UserJoinAwardCallBack", "RequestUuid": "ActivityAwardInfoCallBack-182572318444****", "Sign": "c7594afe578431086bf1c56eff54****", "SubAccountName": "+861803738****", "Timestamp": "1741158904", "UserInfos": [ { "ExternalID": "78989827691****", "Extra": "", "IsPriorityUser": "0", "NickName": "观众 A", "Telephone": "1803738****", "UserAccessIP": "fdbd:dc0********", "UserAgent": "Windows 10", "UserID": "182137188********" } ] }
回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
参数 | 类型 | 说明 |
|---|---|---|
AccountID | String | 账号 ID。 |
ActivityID | String | 直播间 ID。 |
SubAccountName | String | 创建直播间的账号。参数值 |
EventType | String | 回调通知的事件类型,固定取值为 |
Timestamp | String | 发送回调请求的时间。Unix 时间戳,单位为秒。 |
Sign | String | 校验签名。
|
ActivityName | String | 直播间标题。 |
AwardId | String | 抽奖 ID。 |
RequestUuid | String | 请求回调的唯一标识。 |
UserInfos | Array of UserAwardInfo | 中奖观众信息。 |
参数 | 类型 | 描述 |
|---|---|---|
UserID | String | 用户 ID。 |
ExternalID | String | 关联用户 ID,即观众在第三方平台的唯一标识。
说明 如果您集成了观播 SDK,且 SDK 的鉴权模式为自定义模式,关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时、或调用 GetActivityLoginSecret 后生成 JWT 时,传入的 |
Extra | String | 业务方扩展参数,对应观看页地址中的 |
NickName | String | 昵称。 |
UserAccessIP | String | IP 地址。 |
UserAgent | String | 终端类型。 |
Telephone | String | 观众登录直播间时使用的手机号。 |
IsPriorityUser | String | 是否为优先中奖用户。取值如下:
|