UpdateAwardConfig - 新增、更新或删除实时抽奖--企业直播-火山引擎

文档中心

企业直播

互动工具

UpdateAwardConfig - 新增、更新或删除实时抽奖

调用 UpdateAwardConfig 接口，在直播间内新增、更新或删除实时抽奖。

注意

在更新实时抽奖时，为保证参数值不被替换为默认值，即便参数在该接口中为非必选，只要您有自定义的需求，就必须传入对应的参数值。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=UpdateAwardConfig&Version=2023-08-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateAwardConfig`	接口名称。当前 API 的名称为 `UpdateAwardConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`181****461451`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Id	Long	是	`36576`	实时抽奖 ID。取值情况如下：要创建实时抽奖，传入 `0` 要更新或删除实时抽奖配置，传入实时抽奖 ID。可通过 ListAwardConfigs 接口获取 ID
Status	Integer	是	`1`	选择操作实时抽奖的方式。取值如下： `1`: 创建或更新实时抽奖 `5`: 删除实时抽奖
Name	String	否	`抽奖活动`	抽奖名称。说明创建或更新实时抽奖时，该参数必填。
AwardType	Integer	否	`1`	开奖方式。取值如下： `1`：自动开奖 `2`：手动开奖说明创建或更新实时抽奖时，该参数必填。
DeadLineSecond	Long	否	`30`	开奖倒计时中的秒数。默认值为 `0`。说明仅当 `AwardType` 取值为 `1` 时，该参数生效。
BarragePwd	String	否	`弹幕口令`	抽奖弹幕口令。默认为空。
IsManualSendBarragePwd	Integer	否	`0`	是否需要观众手动发送弹幕口令。默认值为 `0`。取值如下： `0`：无需手动点击发送，弹幕口令将自动发送 `1`：需手动点击发送弹幕口令
RangeStatus	Integer	否	`0`	中奖条件。默认值为 `0`。取值如下： `0`：所有观众的中奖概率相同 `1`：未中奖观众优先，即加大在当前直播间 30 天未中奖观众的中奖概率 `2`：重复中奖限制。设置同一观众在当前直播间 30 天内允许中奖的次数上限。您可通过 `RepeatedAwardLimit` 设置。
ShowPeopleNumber	Integer	否	`0`	是否在观看页显示抽奖的实际参与人数。默认值为 `0`。取值如下： `0`：显示 `1`：不显示
AwardCondition	Object of AwardCondition	否	`-`	参与抽奖条件。
AwardTheme	String	否	`bigTurntable`	抽奖主题。取值如下： `bigTurntable`：大转盘 `lotteryBox`：开奖箱 `slotMachine`：拉霸机说明创建或更新实时抽奖时，该参数必填。
WinnerCount	Long	否	`1`	当前奖品的中奖人数。默认值为 `0`。
ShowWinnerComment	Integer	否	`0`	是否展示中奖者详情。默认值为 `0`。取值如下： `0`：不展示 `1`：展示
AwardItemConfigs	Array of AwardItemConfigs	否	`-`	奖品信息列表。说明创建或更新实时抽奖时，该参数必填。
IsHideAwardNum	Integer	否	`0`	是否在观看页显示奖品数量。默认值为 `0`。取值如下： `0`：显示 `1`：不显示
AwardSendType	Integer	否	`1`	抽奖发送方式。默认值为 `0`。取值如下： `0`：手动发送 `1`：定时发送
BlackUserInfoId	Long	否	`162****100`	中奖黑名单 ID。您可通过调用 CreateVipOrBlackListUserInfo 接口获取 ID。中奖黑名单，即无法中奖的人员名单。如果某观众被同时添加进优先中奖名单和中奖黑名单，则该观众无法中奖。
VipUserInfoId	Long	否	`162****099`	优先中奖名单 ID。您可通过调用 CreateVipOrBlackListUserInfo 接口获取 ID。
IsOnlineUser	Integer	否	`0`	观众是否必须在开奖前 3 分钟内在线观看直播，默认值为 `0`。取值如下： `0`：开奖时观众无需在直播间 `1`：开奖时观众必须在直播间说明优先中奖名单中的观众不受此限制影响。
RepeatedAwardLimit	Integer	否	`1`	同一观众在当前直播间 30 天内允许中奖（包括实时抽奖和红包）的次数。取值范围为 `[1,99]`。默认值为 `1`。说明当 `RangeStatus` 取值为 `2` 时，该参数生效。

AwardCondition

参数	类型	是否必选	示例值	描述
Quiz	String	否	`all`	答题或简答参与条件。默认为空值。取值如下：空值：不开启答题或简答参与条件 `all`：提交全部答题或简答。全部答题或简答指从本场直播开始至参与本次参与实时抽奖期间发送的全部答题或简答 `1-999`：至少提交参数值指定个数的答题或简答
RightQuiz	String	否	`1`	观众需要正确作答的题目数。
Questionnaire	String	否	`1`	观众需要提交的问卷数。
CheckIn	String	否	`all`	观众需要提交的签到数。
Vote	String	否	`1`	观众需要提交的投票数。
WatchLiveTime	String	否	`60`	观众需要观看直播的时长，取值范围 [1,500]，单位为分钟。默认为空值，即不开启观看直播参与条件。

AwardItemConfigs

参数	类型	是否必选	示例值	描述
AwardId	Long	否	`1621615169`	奖品 ID。您可通过调用 GetAwardItemList 接口获取 ID。说明创建或更新实时抽奖时，该参数必填。
AwardItemCount	Long	否	`1000`	奖品数量。所有奖品数量之和不可超过 20,000。说明创建或更新实时抽奖时，该参数必填。

返回参数

参数	类型	示例值	描述
Id	Long	`36576`	创建、更新或删除后的实时抽奖 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAwardConfig&Version=2023-08-01
{
    "Name": "抽奖活动",
    "AwardType": 1,
    "BarragePwd": "弹幕口令",
    "ActivityId": 181****461451,
    "RangeStatus": 0,
    "ShowPeopleNumber": 0,
    "AwardCondition": {
        "Quiz": "all",
        "RightQuiz": "1",
        "Questionnaire": "1",
        "CheckIn": "all",
        "Vote": "1",
        "WatchLiveTime": "60"
    },
    "AwardTheme": "bigTurntable",
    "WinnerCount": 1,
    "ShowWinnerComment": 0,
    "IsHideAwardNum": 0,
    "AwardSendType": 1,
    "DeadLineSecond": 30,
    "AwardItemConfigs": [
        {
            "AwardItemCount": 1000,
            "AwardId": 1621615169
        }
    ],
    "Id": 36576,
    "Status": 1,
    "BlackUserInfoId": 162****100,
    "VipUserInfoId": 162****099,
    "IsOnlineUser": 0,
    "IsManualSendBarragePwd": 0,
    "RepeatedAwardLimit": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateAwardConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Id": 36576
    }
}

错误码

访问公共错误码和错误码获取详细信息。

最近更新时间：2026.04.01 15:41:35

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

AwardCondition #

AwardItemConfigs #

返回参数 #

请求示例 #

返回示例 #

错误码 #