ListActivityBonusTasks - 获取直播福利任务列表--企业直播-火山引擎

文档中心

立即注册

企业直播

福利任务

ListActivityBonusTasks - 获取直播福利任务列表

调用 ListActivityBonusTasks 接口，在指定直播间内获取直播福利任务列表。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1783****8443`	直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PageNumber	Integer	否	`1`	分页查询页码。默认值为 `1`。取值大于等于 1。
PageSize	Integer	否	`10`	分页查询数量。默认取值为 `10`。取值范围为 [1,100]。
StatusList	Array of Integer	否	`[1]`	需要查询的任务状态列表。不传默认查询全部状态的任务。任务状态对应的值如下： `1`：待开始 `2`：进行中 `3`：已结束

返回参数

参数	类型	示例值	描述
ActivityBonusTasks	Array of ActivityBonusTasks	`-`	直播福利任务列表。
Total	Integer	`10`	任务总数。

ActivityBonusTasks

参数	类型	示例值	描述
Id	Long	`183738221212`	直播福利任务 ID。
TaskRunningType	Integer	`2`	直播福利任务开启方式。取值如下： `1`：手动开启：任务创建后，您可以随时手动开启任务。 `2`：计划开启：设置一个具体的开始和结束时间，任务将按计划自动开启。
EndTime	Long	`1764657098`	福利任务的计划结束时间。Unix 时间戳，单位为秒。
StartTime	Long	`1764657022`	福利任务的计划开始时间。Unix 时间戳，单位为秒。
Name	String	`看直播，领好礼`	直播福利任务的名称。
ActualEndTime	Long	`1764657098`	福利任务的实际结束时间。若值为 `0`则表示还未结束。
ActualStartTime	Long	`1764657022`	福利任务的实际开始时间。若值为 `0`则表示还未开始。
Status	Integer	`1`	福利任务的状态，取值如下： `1`：待开始 `2`：进行中 `3`：已结束
BonusList	Array of BonusList	`-`	福利任务中的子任务。

BonusList

参数	类型	示例值	描述
SubTaskType	Integer	`1`	子任务的类型。取值如下： `1`：观看直播分钟数 `2`：聊天次数 `3`：点赞次数 `4`：邀请人数 `5`：商品点击次数 `6`：打赏次数 `7`：投票次数 `8`：完成问卷次数 `9`：签到次数 `10`：答题次数 `11`：答对次数
SubTaskCondition	Integer	`10`	完成该子任务的数量要求。示例：若 `SubTaskType` 取值为 `1`，`SubTaskCondition` 取值为 `30`，则表示获奖条件为“观看直播 `30`分钟”。
SubBonusType	Integer	`1`	完成任务后，观众获得的奖励类型。取值如下： `1`：积分 `2`：现金 `3`：优惠券 `4`：奖品
SubBonus	Object of SubBonus	`-`	奖励的详细信息。

SubBonus

参数	类型	示例值	描述
PointSubBonus	Object of PointSubBonus	`-`	积分奖励。
CashSubBonus	Object of CashSubBonus	`-`	现金奖励。
CouponSubBonus	Object of CouponSubBonus	`-`	卡券奖励。
AwardSubBonus	Object of AwardSubBonus	`-`	奖品奖励。

PointSubBonus

参数类型示例值描述

AmountTenthsUnit Long 10 完成任务后，单个观众可获得的积分值，单位为 0.1 积分。若该值设为 10，则每位观众可获得 1 积分。

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

LimitCount

Long

-1

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

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

CashSubBonus

参数类型示例值描述

AmountTenthsUnit Long 10 完成任务后，单个观众可获得的现金值，单位为 0.1 元。若该值设为 10，则每位观众可获得 1 元。

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

LimitCount

Long

-1

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

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

CouponSubBonus

参数	类型	示例值	描述
CouponId	Long	`18156156151458`	卡券 ID。
CouponPic	String	`https://www.example.com/a.png`	优惠券的图片 URL 地址，用于展示优惠券的图片信息。
CouponThirdPartyId	String	`45535343****444444`	关联卡券 ID，即您自有商城系统中的卡券 ID。通过该 ID，可将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。
CouponDescription	String	`满100减20`	卡券描述。
CouponName	String	`鸡蛋优惠券`	卡券名称。
LimitCount	Long	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100,000] 之间的整数：表示具体奖励份数

AwardSubBonus

参数	类型	示例值	描述
AwardItemId	Long	`1715****1256`	奖品库中的奖品 ID。
LimitCount	Long	`-1`	该奖励可被领取的总份数。可取值： `-1`：无限制 [1，100,000] 之间的整数：表示具体奖励份数
AwardItemIcon	String	`https://www.example.com/test.png`	奖品图片的 URL，有协议头。
AwardItemName	String	`电子手表`	奖励的奖品名称。
AwardItemType	Integer	`1`	奖品类型。取值如下： `1`：实物奖品 `2`：虚拟奖品 `3`：卡券奖品或积分奖品 `4`：奖券奖品
AwardItemAmounts	Long	`1`	每位获奖观众可获得的积分数额。您可根据该金额，判断向观众发放多少积分。
AwardLotteryTicketAddr	String	`https://example.com`	奖券奖品的领奖链接。
DeliveryMethod	Integer	`1`	卡券奖品或积分奖品。取值如下： `1`：卡券 `2`：积分
WinnerInfoType	Array of Integer	`2,1,3`	获奖人需要填写的个人信息。取值如下： `1`：收货地址 `2`：手机号 `3`：收件人 `4`：邮箱
AwardItemNum	String	`48151841`	若奖品类型为卡券奖品，该字段表示关联的卡券 ID。您可通过该 ID，将当前卡券绑定您商城系统中的卡券，方便后续卡券的发放以及在商城内的核销。若奖品类型为积分奖品，该字段表示积分奖品的批次号。您可根据该批次号识别企业积分，向观众发放积分。

请求示例

POST https://livesaas.volcengineapi.com/?Action=ListActivityBonusTasks&Version=2023-08-01
{
    "ActivityId": 1783,
    "PageNumber": 1,
    "StatusList": [
        1
    ],
    "PageSize": 10
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListActivityBonusTasks",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "ActivityBonusTasks": [
            {
                "Id": 183738221212,
                "BonusList": [
                    {
                        "SubTaskType": 1,
                        "SubTaskCondition": 10,
                        "SubBonusType": 1,
                        "SubBonus": {
                            "PointSubBonus": {
                                "AmountTenthsUnit": 10,
                                "LimitCount": -1
                            },
                            "CashSubBonus": {
                                "AmountTenthsUnit": 10,
                                "LimitCount": -1
                            },
                            "AwardSubBonus": {
                                "AwardItemId": 1715,
                                "DeliveryMethod": 1,
                                "AwardLotteryTicketAddr": "https://example.com",
                                "AwardItemAmounts": 1,
                                "AwardItemType": 1,
                                "AwardItemName": "电子手表",
                                "AwardItemIcon": "https://www.example.com/test.png",
                                "AwardItemNum": "48151841",
                                "LimitCount": -1,
                                "WinnerInfoType": [
                                    null
                                ]
                            },
                            "CouponSubBonus": {
                                "CouponId": 18156156151458,
                                "CouponPic": "https://www.example.com/a.png",
                                "CouponThirdPartyId": "45535343****444444",
                                "CouponDescription": "满100减20",
                                "CouponName": "鸡蛋优惠券",
                                "LimitCount": -1
                            }
                        }
                    }
                ],
                "TaskRunningType": 2,
                "EndTime": 1764657098,
                "StartTime": 1764657022,
                "Name": "看直播，领好礼",
                "ActualEndTime": 1764657098,
                "ActualStartTime": 1764657022,
                "Status": 1
            }
        ],
        "Total": 10
    }
}

错误码

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

最近更新时间：2026.01.22 10:57:03

这个页面对您有帮助吗？

有用

无用

企业直播

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

Body #

返回参数 #

ActivityBonusTasks #

BonusList #

SubBonus #

PointSubBonus #

CashSubBonus #

CouponSubBonus #

AwardSubBonus #

请求示例 #

返回示例 #

错误码 #