您可通过此接口获取指定直播间已发送实时抽奖的抽奖名称、开奖方式、抽奖规则等配置信息。
说明
本接口已升级至 2023-08-01 版本，推荐您调用新版本的 ListAwardConfigs 接口获取直播间实时抽奖配置信息。
请求频率：单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetAwardConfigListAPI | 接口名称。当前 API 的名称为 GetAwardConfigListAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| ActivityId | Long | 是 | 17544****38536 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Body | Array of BodyInfo | - | 实时抽奖配置信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ID | Integer | 36576 | 实时抽奖 ID。 |
| Name | String | 抽奖活动 | 抽奖名称。 |
AwardType | Integer |
| 开奖方式。支持以下取值：
|
| DeadLine | Integer | 1 | 开奖倒计时，单位为分。 |
| BarragePwd | String | 抽奖 | 抽奖弹幕口令。 |
WinnerInfoType | String |
| 中奖人需要填写的个人信息。支持以下取值：
|
Status | Integer |
| 抽奖状态。支持以下取值：
|
| ActivityId | Long | 17544****38536 | 直播间 ID。 |
| TotalCount | Integer | 5 | 参与人数。 |
| AwardCount | Integer | 1 | 中奖人数。 |
| SendTime | Integer | 1673199096 | 抽奖的发送时间。Unix 时间戳，单位秒。 |
| OpenAwardTime | Integer | 1673199158 | 开奖时间。Unix 时间戳，单位秒。 |
| AwardNum | Integer | 1 | 奖品数量。 |
RangeStatus | Integer |
| 抽奖规则。支持以下取值：
|
ShowPeopleNumber | Integer |
| 是否显示参与抽奖人数。支持以下取值：
|
| MsgIds | String | 155681 | 通过控制台发送的该实时抽奖的图文消息 ID。 |
ShowWinnerComment | Integer |
| 是否展示中奖者详情。支持以下取值：
|
AwardItemType | Integer |
| 奖品类型。支持以下取值：
|
| TaskAwardIcon | String | //p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image | 奖品图标的 URL，无协议头。 |
AwardItemNum | String |
| 自定义奖品的奖品批号。 说明 仅当 |
AwardItemAmounts | Integer |
| 自定义奖品的中奖金额。 说明 仅当 |
AwardLotteryTicketAddr | String |
| 奖券奖品的领取链接。 说明 仅当 |
AwardTheme | String |
| 抽奖主题。支持以下取值：
|
| AwardCondition | Object of AwardCondition | - | 参与抽奖条件。 |
VIPUserList | String |
| VIP 名单。 说明 该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。 |
ConditionType | Integer |
| 参与抽奖条件。支持以下取值：
说明 该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。 |
ConditionVariable | Integer |
| 正确作答的题目数。 说明 该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Quiz | String | 2 | 观众需要提交的答题或简答数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有答题或简答。 |
| RightQuiz | String | 1 | 观众需要正确作答的题目数。返回值为 all 表示需要正确作答直播开始后至观众参与抽奖前，直播间发布的所有题目。 |
| Questionnaire | String | 1 | 观众需要提交的问卷数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有问卷。 |
| CheckIn | String | all | 观众需要提交的签到数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有签到。 |
| Vote | String | 1 | 观众需要提交的投票数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有投票。 |
GET https://livesaas.volcengineapi.com/?Action=GetAwardConfigListAPI&Version=2020-06-01&ActivityId=17544****38536
{ "ResponseMetadata": { "RequestId": "2023011122285461C57537B04A4ABA73FC", "Action": "GetAwardConfigListAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1673447334 }, "Result": { "Body": [ { "ID": 36576, "Name": "抽奖活动", "AwardType": 1, "DeadLine": 1, "BarragePwd": "抽奖", "WinnerInfoType": "2", "Status": 4, "ActivityId": 17544****38536, "TotalCount": 5, "AwardCount": 1, "SendTime": 1673199096, "OpenAwardTime": 1673199158, "AwardNum": 1, "VIPUserList": "zhangsan", "RangeStatus": 0, "ShowPeopleNumber": 0, "MsgIds": "155681", "ConditionType": 0, "ConditionVariable": 0, "ShowWinnerComment": 0, "AwardItemType": 4, "TaskAwardIcon": "//p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image", "AwardItemNum": "1498158", "AwardItemAmounts": 0, "AwardLotteryTicketAddr": "https://livesaas/Configuration", "AwardCondition": { "Quiz": "2", "Questionnaire": "1", "CheckIn": "all", "Vote": "1", "RightQuiz": "1" }, "AwardTheme": "bigTurntable" } ] } }