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

企业直播

复制全文
互动工具
SendActivityRedPacket - 发送红包
复制全文
SendActivityRedPacket - 发送红包

调用 SendActivityRedPacket 接口,在指定直播间中发送一个已创建的红包。发送后,观众端将在观看页看到红包弹窗,并可以参与抢红包活动。

注意事项

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

请求说明

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

调试

请求参数

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

Query

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

Body

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

ActivityID

Long

1824921187234844

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

说明

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

RedPacketID

Long

1825091238702096

红包 ID。您可通过调用 ListActivityRedPacketCreateActivityRedPacket 接口获取 ID。

说明

发送红包时,请确保红包为未发送状态。即调用 ListActivityRedPacket 接口获取红包 ID 时,RedPacketStatus 的取值为 0

返回参数

参数类型示例值描述
StatusBooleantrue是否成功发送红包。成功返回 true
ActivityIDLong1824921187234844当前直播间 ID。
RedPacketIDLong1825091238702096发送的红包 ID。

请求示例

POST https://livesaas.volcengineapi.com/?Action=SendActivityRedPacket&Version=2023-08-01
{
    "ActivityID": 1824921187234844,
    "RedPacketID": 1825091238702096
}

返回示例

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

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
400InvalidParameter.RedPacketStatusInvalidRed packet status is not in initialization.当前红包的状态不是未发送的状态。请确保调用 ListActivityRedPacket 接口获取红包 ID 时,RedPacketStatus 的取值为 0。
最近更新时间:2026.04.01 13:47:02
这个页面对您有帮助吗?
有用
有用
无用
无用