调用 ChangeActivityBonusTaskStatus 接口,在指定直播间内修改指定直播福利任务状态,如开启任务或结束任务。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ChangeActivityBonusTaskStatus | 接口名称。当前 API 的名称为 ChangeActivityBonusTaskStatus。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Id | Long | 是 | 18123156153 | 直播福利任务 ID。您可以通过 ListActivityBonusTasks 接口查询 ID。 |
Start | Boolean | 是 |
| 开启或结束福利任务。取值如下:
说明
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Integer | 1 | 更新结果。更新成功则返回 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 } }