调用 DrawActivityRedPacket 接口,可以手动为红包开奖。开奖后,已参与活动的观众可以查看自己领取的红包金额。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DrawActivityRedPacket | 接口名称。当前 API 的名称为 DrawActivityRedPacket。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityID | Long | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
RedPacketID | Long | 是 |
| 红包 ID。您可通过调用 ListActivityRedPacket 或 CreateActivityRedPacket 接口获取 ID。 说明 红包开奖时,请确保:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 红包是否成功开奖。成功返回 true。 |
| ActivityID | Long | 1824921187234844 | 当前直播间 ID。您可以继续调用 ListRedPacketDataAPI 接口获取红包数据,包括参与人数、中奖人数、观众的中奖金额等。 |
| RedPacketID | Long | 1825091238702096 | 开奖的红包 ID。 |
POST https://livesaas.volcengineapi.com/?Action=DrawActivityRedPacket&Version=2023-08-01 { "ActivityID": 1824921187234844, "RedPacketID": 1825091238702096 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DrawActivityRedPacket", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true, "ActivityID": 1824921187234844, "RedPacketID": 1825091238702096 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | InvalidParameter.RedPacketStatusInvalid | The specified parameter RedPacketStatus is invalid. | 当前红包正在开奖或已经开奖结束,无法再次开奖。请确保调用 ListActivityRedPacket 接口获取红包 ID 时,RedPacketStatus 的取值为 1。 |
| 400 | InvalidParameter.RedPacketConfigInvalid | Cannot manually draw the red packet with auto send time. | 配置了自动开奖的红包,无法手动开奖。请确保红包的开奖方式为手动开奖,即调用 ListActivityRedPacket 接口获取红包 ID 时,OpenRedPacketType 的取值为 1。 |