CreateActivityBonusTask - 新增直播福利任务--企业直播-火山引擎

文档中心

企业直播

福利任务

CreateActivityBonusTask - 新增直播福利任务

调用CreateActivityBonusTask 接口，在指定直播间内新增直播福利任务。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制或营销互动 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
使用限制：单个直播间内，最多可创建 100 个福利任务，单个福利任务中最多可添加 50 个子任务。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1783****8443`	直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
Name	String	是	`看直播，领好礼`	直播福利任务的名称，长度不超过 20 个字符，不能为空。
TaskRunningType	Integer	是	`2`	直播福利任务开启方式。取值如下： `1`：手动开启：任务创建后，您可以随时手动开启任务。 `2`：计划开启：设置一个具体的开始和结束时间，任务将按计划自动开启。
StartTime	Long	否	`1764657022`	福利任务的开始时间。Unix 时间戳，单位为秒。开始时间取值需大于当前时间。说明当 `TaskRunningType` 为 `2` 时，该参数生效且必填。
EndTime	Long	否	`1764657098`	福利任务的结束时间。Unix 时间戳，单位为秒。结束时间取值需大于 `StartTime` 的取值，且与 `StartTime` 的差值最大为 604,800，即 7 天。说明当 `TaskRunningType` 为 `2` 时，该参数生效且必填。
BonusList	Array of BonusList	是	`-`	福利任务中的子任务。最多支持添加 50 个子任务。
Icon	String	否	`https://p.example.org/***.png`	福利任务图标的 URL，需要包含协议头。不传则使用默认图标。支持传入 PNG、JPG、JPEG 格式的图片，尺寸不超过 160×160px，大小不超过 2 MB。

BonusList

参数	类型	是否必选	示例值	描述
SubTaskType	Integer	是	`1`	子任务的类型。取值如下： `1`：观看时长。您还可以通过 `WatchDurationStatusList` 参数指定统计范围，包括：直播中、预告和回放。默认仅统计直播中的观看时长。 `2`：聊天次数 `3`：点赞次数 `4`：邀请人数 `5`：商品点击次数 `6`：打赏次数 `7`：投票次数 `8`：完成问卷次数 `9`：签到次数 `10`：答题次数 `11`：答对次数
SubTaskCondition	Integer	是	`10`	完成该子任务的数量要求，取值范围为 [1,500]。示例：若 `SubTaskType` 取值为 `1`，`SubTaskCondition` 取值为 `30`，则表示获奖条件为“观看直播 `30` 分钟”。
SubBonusType	Integer	是	`1`	完成任务后，观众获得的奖励类型。取值如下： `1`：积分 `2`：现金 `3`：优惠券 `4`：奖品
SubBonus	Object of SubBonus	是	`-`	奖励的详细信息。
SubTask	Object of SubTask	否	`-`	子任务的详细信息。

SubBonus

参数	类型	是否必选	示例值	描述
PointSubBonus	Object of PointSubBonus	否	`-`	积分奖励。说明当且仅当 `SubBonusType` 参数取值为 `1` 时，该参数生效且必填。
CashSubBonus	Object of CashSubBonus	否	`-`	现金奖励。说明当且仅当 `SubBonusType` 参数取值为 `2` 时，该参数生效且必填。
CouponSubBonus	Object of CouponSubBonus	否	`-`	优惠券奖励。说明当且仅当 `SubBonusType` 参数取值为 `3` 时，该参数生效且必填。
AwardSubBonus	Object of AwardSubBonus	否	`-`	奖品奖励。说明当且仅当 `SubBonusType` 参数取值为 `4` 时，该参数生效且必填。

SubTask

参数	类型	是否必选	示例值	描述
WatchDurationTask	Object of WatchDurationTask	否	`-`	观看时长任务的详细信息。说明当且仅当 `SubBonusType` 参数取值为 `1` 时，该参数生效。

PointSubBonus

参数类型是否必选示例值描述

AmountTenthsUnit Long 是 10 完成任务后，单个观众可获得的积分值，单位为 0.1 积分。取值范围为 [1, 500,000]。若该值设为 10，则每位观众可获得 1 积分。

参数	类型	是否必选	示例值	描述
AmountTenthsUnit	Long	是	`10`	完成任务后，单个观众可获得的积分值，单位为 0.1 积分。取值范围为 [1, 500,000]。若该值设为 10，则每位观众可获得 1 积分。
LimitCount	Long	是	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100,000] 之间的整数：表示具体奖励份数

LimitCount

Long

是

-1

该奖励可被领取的总份数。可取值：

-1：无限制
[1，100,000] 之间的整数：表示具体奖励份数

CashSubBonus

参数类型是否必选示例值描述

AmountTenthsUnit Long 是 10 完成任务后，单个观众可获得的现金值，单位为 0.1 元。取值范围为 [1, 50,000]。若该值设为 10，则每位观众可获得 1 元。

参数	类型	是否必选	示例值	描述
AmountTenthsUnit	Long	是	`10`	完成任务后，单个观众可获得的现金值，单位为 0.1 元。取值范围为 [1, 50,000]。若该值设为 10，则每位观众可获得 1 元。
LimitCount	Long	是	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100,000] 之间的整数：表示具体奖励份数
WithdrawConfig	Object of WithdrawConfig	否	`-`	现金提现配置。

LimitCount

Long

是

-1

该奖励可被领取的总份数。可取值：

-1：无限制
[1，100,000] 之间的整数：表示具体奖励份数

WithdrawConfig Object of WithdrawConfig 否 - 现金提现配置。

CouponSubBonus

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
CouponId	Long	是	`1872****32312`	卡券库中的卡券 ID。您可调用 ListCoupons 接口获取 ID。说明使用子账号调用接口时，确保卡券对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
LimitCount	Long	是	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100000] 之间的整数：表示具体奖励份数

CouponId

Long

是

1872****32312

卡券库中的卡券 ID。您可调用 ListCoupons 接口获取 ID。

说明

使用子账号调用接口时，确保卡券对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

LimitCount

Long

是

-1

该奖励可被领取的总份数。可取值：

-1：无限制
[1，100000] 之间的整数：表示具体奖励份数

AwardSubBonus

参数类型是否必选示例值描述

AwardItemId Long 是 1715****1256 奖品库中的奖品 ID。您可调用 GetAwardItemList 接口获取 ID。

参数	类型	是否必选	示例值	描述
AwardItemId	Long	是	`1715****1256`	奖品库中的奖品 ID。您可调用 GetAwardItemList 接口获取 ID。
LimitCount	Long	是	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100,000] 之间的整数：表示具体奖励份数

LimitCount

Long

是

-1

该奖励可被领取的总份数。可取值：

-1：无限制
[1，100,000] 之间的整数：表示具体奖励份数

WatchDurationTask

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
WatchDurationStatusList	Array of Integer	否	`[1,2,3]`	当任务类型为观看时长时，指定的直播状态。默认为 `[1]`，即仅统计观看直播的时长，不包括预告和回放视频。支持填入以下取值： `1`：直播中 `2`：预告视频 `3`：回放视频说明当且仅当 `SubBonusType` 参数取值为 `1` 时，该参数生效。

WatchDurationStatusList

Array of Integer

否

[1,2,3]

当任务类型为观看时长时，指定的直播状态。默认为 [1]，即仅统计观看直播的时长，不包括预告和回放视频。支持填入以下取值：

1：直播中
2：预告视频
3：回放视频

说明

当且仅当 SubBonusType 参数取值为 1 时，该参数生效。

WithdrawConfig

参数	类型	是否必选	示例值	描述
IsCustomRedirectUrlEnable	Boolean	否	`true`	是否开启自定义地址提现跳转功能。默认值为 `false`。取值如下： `true`：开启。开启后，观众点击立即提现时，即可跳转至 `CustomRedirectUrl` 配置的自定义地址页面。您需自行在页面发放中奖金额并实现红包提现逻辑 `false`：关闭说明当 `IsCustomRedirectUrlEnable` 和 `IsWeChatMiniAppEnable` 的取值均为 `true` 时，则：在移动端微信环境下，观众会跳转至微信小程序页面在其他环境下，观众会跳转至自定义地址页面
CustomRedirectUrl	String	否	`https://www.example.com`	自定义地址。长度为 1 到 500 个字符。说明当 `IsCustomRedirectUrlEnable` 取值为 `true` 时，该参数必选且生效。
IsWeChatMiniAppEnable	Boolean	否	`true`	是否开启微信小程序提现跳转功能。默认值为 `false`。取值如下： `true`：开启。开启后，移动端观众在微信环境下点击立即提现时，即可跳转至指定微信小程序页面。您需自行在页面发放中奖金额并实现红包提现逻辑 `false`：关闭
WeChatMiniAppId	String	否	`1234****91011`	微信小程序的 App ID，跳转后的页面属于该微信小程序。长度为 1 到 100 个字符。完成以下步骤，获取 App ID。使用微信小程序账号登录微信公众平台。在左侧导航栏，选择设置。在基本设置页签下查看 App ID。说明当 `IsWeChatMiniAppEnable` 取值为 `true` 时，该参数必选且生效。
WeChatMiniAppRedirectParam	String	否	`/pages/goods/index?goodsld=1`	跳转后的页面在微信小程序中的相对路径。长度为 1 到 500 个字符。

返回参数

参数	类型	示例值	描述
ActivityBonusTaskId	Long	`183738221212`	创建的直播福利任务 ID。可用于后续查询、更新或删除福利任务。

请求示例

POST https://livesaas.volcengineapi.com/?Action=CreateActivityBonusTask&Version=2023-08-01
{
    "ActivityId": 1783****8443,
    "Name": "看直播，领好礼。",
    "TaskRunningType": 2,
    "StartTime": 1764657022,
    "EndTime": 1764657098,
    "BonusList": [
        {
            "SubTaskType": 1,
            "SubTaskCondition": 10,
            "SubBonusType": 1,
            "SubBonus": {
                "PointSubBonus": {
                    "AmountTenthsUnit": 10,
                    "LimitCount": -1
                }
            }
        },
        {
            "SubTaskType": 3,
            "SubTaskCondition": 10,
            "SubBonusType": 2,
            "SubBonus": {
                        "CashSubBonus": {
                            "AmountTenthsUnit": 20,
                            "LimitCount": -1,
                            "WithdrawConfig": {
                                "IsCustomRedirectUrlEnable": true,
                                "CustomRedirectUrl": "https://www.example.com",
                                "IsWeChatMiniAppEnable": true,
                                "WeChatMiniAppId": "1234****91011",
                                "WeChatMiniAppRedirectParam": "/pages/goods/index?goodsld=1"
                            }
                        }
                    }
                },
                {
                    "SubTaskType": 5,
                    "SubTaskCondition": 10,
                    "SubBonusType": 3,
                    "SubBonus": {
                        "CouponSubBonus": {
                            "CouponId": 1872****32312,
                            "LimitCount": -1
                        }
                    }
                },
                {
                    "SubTaskType": 7,
                    "SubTaskCondition": 10,
                    "SubBonusType": 4,
                    "SubBonus": {
                        "AwardSubBonus": {
                            "AwardItemId": 1715****1256,
                            "LimitCount": -1
                        }
                    },
                    "SubTask": {
                        "WatchDurationTask": {
                            "WatchDurationStatusList": [
                                1,
                                2,
                                3
                            ]
                        }
                    }
                }
            ],
            "Icon": "https://p.example.org/***.png"
        }

返回示例

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

错误码

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

最近更新时间：2026.04.16 14:12:29

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

BonusList #

SubBonus #

SubTask #

PointSubBonus #

CashSubBonus #

CouponSubBonus #

AwardSubBonus #

WatchDurationTask #

WithdrawConfig #

返回参数 #

请求示例 #

返回示例 #

错误码 #

注意事项

请求说明

调试

请求参数

Query

Body

BonusList

SubBonus

SubTask

PointSubBonus

CashSubBonus

CouponSubBonus

AwardSubBonus

WatchDurationTask

WithdrawConfig

返回参数

请求示例

返回示例

错误码