调用 SendActivityRedPacket 接口,在指定直播间中发送一个已创建的红包。发送后,观众端将在观看页看到红包弹窗,并可以参与抢红包活动。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SendActivityRedPacket | 接口名称。当前 API 的名称为 SendActivityRedPacket。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityID | Long | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
RedPacketID | Long | 是 |
| 红包 ID。您可通过调用 ListActivityRedPacket 或 CreateActivityRedPacket 接口获取 ID。 说明 发送红包时,请确保红包为未发送状态。即调用 ListActivityRedPacket 接口获取红包 ID 时, |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否成功发送红包。成功返回 true。 |
| ActivityID | Long | 1824921187234844 | 当前直播间 ID。 |
| RedPacketID | Long | 1825091238702096 | 发送的红包 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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.RedPacketStatusInvalid | Red packet status is not in initialization. | 当前红包的状态不是未发送的状态。请确保调用 ListActivityRedPacket 接口获取红包 ID 时,RedPacketStatus 的取值为 0。 |