当红包开奖时,企业直播会对所设置的接口地址进行回调通知。
将接收回调通知的接口地址提供给企业直播技术支持。
设置回调的接口地址后,当红包开奖时,企业直播会将直播间 ID、红包信息、中奖观众信息等数据以 POST 方式提交给您自定义的回调接口地址。单次回调最多包含 2000 条中奖观众信息,若中奖观众信息超过该上限,企业直播将分多次发送回调消息。
请求示例如下所示:
POST /xxxxx HTTP/1.1 Header1: ... Header2: ... ... { "AccountId": "200000****", "ActivityId": "182565784636****", "ActivityName": "直播间 A", "EventType": "ActivityRedPacketInfoCallBack", "IsOpenSmsNotification": "1", "RedPacketNumber": "1", "RedPacketType": "0", "RedPacketUnit": "分", "RequestUuid": "ActivityRedPacketInfoCallBack-182574727556****", "RewardsPointsBatch": "", "Sign": "bca104f96eb3d5e37bbc07365862****", "SubAccountName": "admin@bytedance.com", "Timestamp": "1741176382", "TotalAmount": "100", "UserInfos": [ { "Amount": "100", "ExternalId": "7898982769****", "Extra": "", "IsPriorityUser": "0", "NickName": "观众 A", "Telephone": "1803****955", "UserAccessIP": "fdbd:dc00:5ea1:10********", "UserAgent": "Windows 10", "UserId": "182137188140****" } ] }
回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
说明
请联系技术支持获取鉴权 AccountSecret
。
参数 | 类型 | 描述 |
---|---|---|
AccountId | String | 账号 ID。 |
ActivityId | String | 直播间 ID。 |
SubAccountName | String | 创建直播间的账号。参数值 |
EventType | String | 回调通知的事件类型,固定取值为 |
Timestamp | String | 发送回调请求的时间。Unix 时间戳,单位为秒。 |
Sign | String | 校验签名。
|
ActivityName | String | 直播间标题。 |
RedPacketType | String | 红包类型。取值如下:
|
RedPacketUnit | String | 红包的单位。
|
TotalAmount | String | 红包总金额或总积分。 |
RedPacketNumber | String | 红包个数。 |
RewardsPointsBatch | String | 积分批次号。 说明 仅当积分红包( |
UserInfos | Array of UserRedPacketInfo | 中奖观众信息列表。 |
RequestUuid | String | 请求回调的唯一标识。 |
IsOpenSmsNotification | String | 是否开启短信提醒功能。取值如下:
|
参数 | 类型 | 描述 |
---|---|---|
UserId | String | 用户 ID。 |
ExternalId | String | 关联用户 ID,即观众在第三方平台的唯一标识。
说明 如果您集成了观播 SDK,且 SDK 的鉴权模式为自定义模式,关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 |
Extra | String | 业务方扩展参数,对应观看页地址中的 |
NickName | String | 昵称。 |
UserAccessIP | String | IP 地址。 |
UserAgent | String | 终端类型。 |
Telephone | String | 观众登录直播间时使用的手机号。 |
IsPriorityUser | String | 是否为优先中奖用户。取值如下:
|
Amount | String | 中奖金额。
|