您可通过此接口获取当前账号及其子账号奖品库中的奖品列表，包括奖品名称、库存、图片等信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetAwardItemList | 接口名称。当前 API 的名称为 GetAwardItemList。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
Name | String | 否 |
| 奖品名称。支持模糊搜索，大小写不敏感。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 200 | 分页查询数量。默认值为 200。取值范围为 [1,1000]。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AwardItemList | Array of AwardItemList | - | 奖品库奖品列表。 |
| TotalCount | Long | 1 | 查询结果总数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AwardItemIcon | String | https://www.example.com/test.png | 奖品图片的 URL，有协议头。 |
AwardItemType | Integer |
| 奖品类型。取值如下：
|
| AwardItemName | String | 奖品 A | 奖品名称。 |
| Id | Long | 1715****1256 | 奖品 ID。获取到奖品 ID 后，您可调用 UpdateAwardItem 接口更新奖品信息，或调用 DeleteAwardItem 接口删除奖品。 |
| AwardItemStock | Long | 200 | 奖品库存。取值 -1 表示不限库存。 |
| AwardLotteryTicketAddr | String | https://example.com | 奖券奖品的领奖链接。 |
| AwardItemNum | String | 48151841 | 自定义奖品的奖品批次。 |
DeliveryMethod | Integer |
| 自定义奖品的发放方式。取值如下：
|
| AwardItemAmounts | Long | 1 | 自定义奖品积分发放方式的中奖金额。 |
WinnerInfoType | Array of Integer |
| 实物或虚拟奖品的中奖人填写信息类型。取值如下：
|
GET https://livesaas.volcengineapi.com/?Action=GetAwardItemList&Version=2023-08-01&Name=A&PageNumber=1&PageSize=200
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetAwardItemList", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1685969459 }, "Result": { "AwardItemList": [ { "AwardItemIcon": "https://www.example.com/test.png", "AwardItemType": 1, "AwardItemName": "奖品 A", "Id": 1715****1256, "AwardItemStock": 200, "AwardLotteryTicketAddr": "", "AwardItemNum": "", "DeliveryMethod": 0, "AwardItemAmounts": 0, "WinnerInfoType": [ 1, 2, 3 ] } ], "TotalCount": 1 } }