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

企业直播

复制全文
福利任务
ChangeActivityBonusTaskStatus - 修改直播福利任务状态
复制全文
ChangeActivityBonusTaskStatus - 修改直播福利任务状态

调用 ChangeActivityBonusTaskStatus 接口,在指定直播间内修改指定直播福利任务状态,如开启任务或结束任务。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的营销互动 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理
  • 使用限制:只有“待开始”的福利任务才能开启,“进行中”的任务才能结束。

请求说明

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

调试

请求参数

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

Query

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

Body

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

ActivityId

Long

1783****8443

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

说明

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

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

Start

Boolean

true

开启或结束福利任务。取值如下:

  • true:开启任务
  • false:结束任务

说明

  • 福利任务为一次性任务,任务结束后,状态将变为“已结束”,不再支持二次开启。
  • 只有“待开始”的福利任务才能开启,“进行中”的任务才能结束。

返回参数

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

请求示例

POST https://livesaas.volcengineapi.com/?Action=ChangeActivityBonusTaskStatus&Version=2023-08-01
{
    "ActivityId": 1783****8443,
    "Id": 1815615461562,
    "Start": false
}

返回示例

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

错误码

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

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