You need to enable JavaScript to run this app.
企业直播

企业直播

请输入
  • 文档首页
    • 企业直播福利任务UpdateActivityBonusTask - 更新直播福利任务
复制全文
我的收藏
福利任务
UpdateActivityBonusTask - 更新直播福利任务
复制全文
我的收藏
UpdateActivityBonusTask - 更新直播福利任务

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

注意事项

  • 请求频率：单用户请求频率限制为 10 次/秒。
  • 前提条件：确保您拥有火山引擎主账号或具备直播间的营销互动 > 可编辑权限的子账号。有关如何添加子账号，详见子账号管理。
  • 使用限制：仅未开始状态的直播福利任务可以被更新。

请求说明

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

调试

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是UpdateActivityBonusTask接口名称。当前 API 的名称为 UpdateActivityBonusTask。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。

Body

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

ActivityId

Long

是

1783****8443

直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

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

IdLong是18123156153直播福利任务 ID。您可以通过 ListActivityBonusTasks 接口查询 ID。

Name

String

否

看直播，领好礼

直播福利任务的名称，长度不超过 20 个字符，不能为空。

说明

若不传入该值，则不更新任务名称。

TaskRunningType

Integer

否

2

直播福利任务开启方式。取值如下：

  • 1：手动开启：任务创建后，您可以随时手动开启任务。
  • 2：计划开启：设置一个具体的开始和结束时间，任务将按计划自动开启。

说明

若不传入该值，则不更新开启方式。

BonusList

Array of BonusList

否

-

福利任务中的子任务。最多支持添加 50 个子任务。

说明

若不传入该值，则不更新子任务。

StartTime

Long

否

1764657022

福利任务的开始时间。Unix 时间戳，单位为秒。开始时间取值需大于当前时间。

说明

若不传入该值，则不更新开始时间。

EndTime

Long

否

1764657098

福利任务的结束时间。Unix 时间戳，单位为秒。结束时间取值需大于 StartTime 的取值，且与 StartTime 的差值最大为 604,800，即 7 天。

说明

若不传入该值，则不更新结束时间。

BonusList

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

SubTaskType

Integer

是

1

子任务的类型。取值如下：

  • 1：观看直播分钟数
  • 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：奖品
SubBonusObject of SubBonus是-奖励的详细信息。

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 时，该参数生效且必填。

PointSubBonus

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

LimitCount

Long

是

-1

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

  • -1：无限制
  • [1，100,000] 之间的整数：表示具体奖励份数
AmountTenthsUnitLong是10完成任务后，单个观众可获得的现金值，单位为 0.1 元。取值范围为 [1, 50,000]。若该值设为 10，则每位观众可获得 1 元。

CashSubBonus

参数类型是否必选示例值描述
AmountTenthsUnitLong是10完成任务后，单个观众可获得的现金值，单位为 0.1 元。取值范围为 [1, 50,000]。若该值设为 10，则每位观众可获得 1 元。

LimitCount

Long

是

-1

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

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

CouponSubBonus

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

CouponId

Long

是

18156156151458

卡券 ID。您可通过调用 ListCoupons 接口获取 ID。

说明

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

LimitCount

Long

是

-1

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

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

AwardSubBonus

参数类型是否必选示例值描述
AwardItemIdLong是1715****1256奖品库中的奖品 ID。您可调用 GetAwardItemList接口获取 ID。

LimitCount

Long

是

-1

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

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

返回参数

参数类型示例值描述
StatusInteger1更新结果。更新成功则返回 1。

请求示例 

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityBonusTask&Version=2023-08-01
{
    "ActivityId": 18123156156,
    "Id": 18123156153,
    "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
                }
            }
        },
        {
            "SubTaskType": 5,
            "SubTaskCondition": 10,
            "SubBonusType": 3,
            "SubBonus": {
                "CouponSubBonus": {
                    "CouponId": 18156165158,
                    "LimitCount": -1
                }
            }
        },
        {
            "SubTaskType": 7,
            "SubTaskCondition": 10,
            "SubBonusType": 4,
            "SubBonus": {
                "AwardSubBonus": {
                    "AwardItemId": 18156165159,
                    "LimitCount": -1
                }
            }
        }
    ]
}

返回示例 

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

错误码

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

最近更新时间：2026.01.22 10:57:03
这个页面对您有帮助吗？
有用
有用
无用
无用