RedPacketStatus

Integer

0

红包状态。取值如下：

• 0：初始化
• 1：已发送
• 2：开奖中
• 3：开奖成功
• 4：开奖失败

RedPacketType

Integer

0

红包类型。取值如下：

• 0：现金红包
• 1：积分红包

TotalAmount

Integer

10000

红包总金额或总积分。

• 现金红包（RedPacketType 取值为 0）时，单位为分
• 积分红包（RedPacketType 取值为 1）时，单位可通过 RewardsPointsUnit 参数获取

RewardsPointsConfig

Object of RewardsPointsConfig

-

积分红包配置。

RedPacketNumber

Integer

10

红包个数。

OpenRedPacketType

Integer

0

开奖方式。取值如下：

• 0：自动开奖
• 1：手动开奖

DeadLine

Integer

5

开奖倒计时。单位为分钟。

IsOpenSmsNotification

Integer

0

是否开启短信提醒。取值如下：

• 0：关闭
• 1：开启。开启后，通过手机号登录直播间的观众，在中奖时会收到企业直播发送的红包中奖提醒短信

RedPacketCoverImage

String

https://www.example.com/a.png

观看页展示的红包图标的 URL。
如果图标是通过控制台配置的，则 URL 无协议头，如果图标是通过 API 调用配置的，则 URL 有协议头。

AwardCondition

Object of AwardCondition

-

参与条件配置。
观众只有在同时满足开启的参与条件后，才能参与抢红包。
如果开启问卷、投票、签到、答题或简答参与条件，观众必须在本场直播期间完成相关活动，才能被视为有效参与。也就是说，直播间必须处于直播中状态，且活动必须在本场直播期间完成。

BarragePwd

String

新年快乐

弹幕口令。
该参数有值，则表示开启弹幕参与条件，观众必须发送该弹幕口令，才能参与抢红包。

RangeStatus

Integer

0

中奖条件。取值如下：

• 0：所有观众的中奖概率相同
• 1：未中奖观众优先，即加大在当前直播间 30 天未中奖观众的中奖概率
• 2：重复中奖限制

RepeatedAwardLimit

Integer

1

同一观众在当前直播间 30 天内允许中奖（包括实时抽奖和红包）的次数。

VipUserInfoId

Long

162****099

优先中奖名单 ID。您可调用 GetVipOrBlackListUserInfo 接口，通过传入直播间 ID 和优先中奖名单 ID，获取名单中的用户信息。
当优先中奖名单中的人数大于红包数量，则在优先中奖名单中随机抽奖。当红包数量大于优先中奖名单中的人数时，则优先中奖名单中的观众全部中奖且优先获得较大金额的红包，多出的红包在普通观众中随机抽奖。优先中奖名单中，已登录的观众（仅输入昵称的观众除外）无需手动参与抢红包，如果开奖时正在观看直播，即可收到中奖弹窗通知。

BlackUserInfoId

Long

162****100

中奖黑名单 ID。您可调用 GetVipOrBlackListUserInfo 接口，通过传入直播间 ID 和中奖黑名单 ID，获取名单中的用户信息。
中奖黑名单，即无法中奖的人员名单。如果某观众被同时添加进优先中奖名单和中奖黑名单，则该观众无法中奖。

EnableCustomRedirect

Boolean

false

是否开启自定义地址提现跳转功能。取值如下：

• true：开启。开启后，观众点击立即提现时，即可跳转至 CustomRedirectUrl 配置的自定义地址页面。您需自行在页面发放中奖金额并实现红包提现逻辑
• false：关闭

CustomRedirectUrl

String

https://www.example.com

自定义地址。

EnableMiniApp

Boolean

false

是否开启微信小程序提现跳转功能。取值如下：

• true：开启。开启后，移动端观众在微信环境下点击立即提现时，即可跳转至指定微信小程序页面。您需自行在页面发放中奖金额并实现红包提现逻辑
• false：关闭

MiniAppId

String

1234****91011

微信小程序的 App ID，跳转后的页面属于该微信小程序。

MiniAppRedirectUrl

String

test=1

跳转后的页面在微信小程序中的相对路径。

AmountCalculationType

Integer

0

金额计算方式。取值如下：

• 0：随机金额
• 1：指定金额

FixedRewardPointConfigs

Array of FixedRewardPointConfigs

-

指定金额的积分红包配置。

Questionnaire

String

all

问卷参与条件。取值如下：

• 空值：不开启问卷参与条件
• all：提交全部问卷。全部问卷指从本场直播开始至参与本次抢红包期间发送的全部问卷
• 1-999：至少提交参数值指定个数的问卷

Vote

String

1

投票参与条件。取值如下：

• 空值：不开启投票参与条件
• all：提交全部投票。全部投票指从本场直播开始至参与本次抢红包期间发送的全部投票
• 1-999：至少提交参数值指定个数的投票

CheckIn

String

all

签到参与条件。取值如下：

• 空值：不开启签到参与条件
• all：提交全部签到。全部签到指从本场直播开始至参与本次抢红包期间发送的全部签到
• 1-999：至少提交参数值指定个数的签到

Quiz

String

all

答题或简答参与条件。取值如下：

• 空值：不开启答题或简答参与条件
• all：提交全部答题或简答。全部答题或简答指从本场直播开始至参与本次抢红包期间发送的全部答题或简答
• 1-999：至少提交参数值指定个数的答题或简答

RightQuiz

String

all

答题或简答参与条件。取值如下：

• 空值：不开启答题或简答参与条件
• all：答对全部答题或简答。全部答题或简答指从本场直播开始至参与本次抢红包期间发送的全部答题或简答
• 1-999：至少答对参数值指定个数的答题或简答