You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
互动工具
WithdrawAward - 直播间内撤回实时抽奖
复制全文
下载 pdf
WithdrawAward - 直播间内撤回实时抽奖

调用 WithdrawAward 接口,在直播间内撤回已发送的实时抽奖。已撤回的抽奖不支持再次发送或更新。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒。
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的直播控制 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理。

请求说明

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

调试

请求参数

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

Query

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

Body

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

ActivityId

Integer

是

1815615461451

直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

说明

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

Id

Integer

是

36576

要撤回的实时抽奖 ID。您可通过调用 ListAwardConfigs 接口获取 ID。

说明

撤回实时抽奖时,请确保抽奖状态为“抽奖中”或“开奖完成”。即 ListAwardConfigs 接口中返回参数 Status 的取值为 2 或 4 时,可调用当前接口撤回实时抽奖。

返回参数

参数类型示例值描述
StatusBooleantrue是否成功撤回抽奖。成功返回 true。

请求示例

POST https://livesaas.volcengineapi.com/?Action=WithdrawAward&Version=2023-08-01
{
    "ActivityId": 1815615461451,
    "Id": 36576
}

返回示例

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

错误码

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

最近更新时间:2025.11.05 11:53:01
这个页面对您有帮助吗?
有用
有用
无用
无用