DeleteActivityRedPacket - 直播间内删除红包--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

DeleteActivityRedPacket - 直播间内删除红包

最近更新时间：2025.03.24 16:50:59首次发布时间：2025.03.06 11:42:49

调用 DeleteActivityRedPacket，在指定直播间内删除指定红包。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ActivityID	Long	是	`182492****234844`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
RedPacketID	Long	是	`182497****712784`	待删除的红包的 ID。您可通过调用 ListActivityRedPacket 接口获取 ID。

返回参数

参数	类型	示例值	描述
Status	Boolean	`true`	是否成功删除红包。成功返回 `true`。

请求示例

POST https://livesaas.volcengineapi.com/?Action=DeleteActivityRedPacket&Version=2023-08-01
{
    "ActivityID": 182492****234844,
    "RedPacketID": 182497****712784
}

返回示例

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

错误码

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