获取直播间实时抽奖奖品列表--企业直播-火山引擎

文档中心

立即注册

导航

获取直播间实时抽奖奖品列表

最近更新时间：2023.11.08 09:30:21首次发布时间：2023.02.01 14:10:46

获取直播间已发送实时抽奖活动的奖品列表。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetAwardConfigListAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetAwardConfigListAPI`	接口名称。当前 API 的名称为 `GetAwardConfigListAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`17544509338536`	直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。

返回参数

参数	类型	示例值	描述
Body	Array of BodyInfo	`-`	实时抽奖的奖品信息列表。

BodyInfo

参数	类型	示例值	描述
ID	Integer	`1621615132`	实时抽奖的奖品 ID。
Name	String	`奖券奖品`	奖品名称。
AwardType	Integer	`1`	开奖方式。 1：自动开奖 2：手动开奖
DeadLine	Integer	`1`	开奖倒计时，单位为分。
BarragePwd	String	`抽奖`	抽奖弹幕口令。
WinnerInfoType	String	`2`	中奖人需要填写的个人信息。 1：收货地址 2：手机号 3：收件人
Status	Integer	`4`	抽奖状态。 2：抽奖中 4：开奖完成 5：已删除 7：已撤回
ActivityId	Long	`17544509338536`	直播间 ID。
TotalCount	Integer	`5`	参与人数。
AwardCount	Integer	`1`	中奖人数。
SendTime	Integer	`1673199096`	抽奖的发送时间。Unix 时间戳，单位秒。
OpenAwardTime	Integer	`1673199158`	开奖时间。Unix 时间戳，单位秒。
AwardNum	Integer	`1`	奖品数量。
RangeStatus	Integer	`0`	抽奖规则。 0：所有人 1：未中奖观众优先
ShowPeopleNumber	Integer	`0`	是否显示参与抽奖人数。 0：显示 1：不显示
MsgIds	String	`155681`	通过控制台发送的该实时抽奖的图文消息 ID。
ShowWinnerComment	Integer	`0`	是否展示中奖者详情。 0：不展示 1：展示
AwardItemType	Integer	`4`	奖品类型。 1：实物奖品 2：虚拟奖品 3：自定义奖品 4：奖券奖品
TaskAwardIcon	String	`//p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image`	奖品图标的 URL，无协议头。
AwardItemNum	String		自定义奖品的奖品批号。说明仅当 `AwardItemType` 取值为 `3` 时，可以返回该参数。
AwardItemAmounts	Integer	`0`	自定义奖品的中奖金额。说明仅当 `AwardItemType` 取值为 `3` 时，可以返回该参数。
AwardLotteryTicketAddr	String	`https://livesaas/Configuration`	奖券奖品的领取链接。说明仅当 `AwardItemType` 取值为 `4` 时，可以返回该参数。
AwardTheme	String	`bigTurntable`	抽奖主题。 bigTurntable：大转盘 lotteryBox：开奖箱 slotMachine：拉霸机
AwardCondition	Object of AwardCondition	`-`	参与抽奖条件。
VIPUserList	String		VIP 名单。说明该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。
ConditionType	Integer	`0`	参与抽奖条件。 0：无参与条件 1：参与答题。即只有正确作答设置的题目数，才有资格参与抽奖说明该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。
ConditionVariable	Integer	`0`	正确作答的题目数。说明该字段仅用于兼容实时抽奖功能旧逻辑，未与控制台奖品库功能关联。

AwardCondition

参数	类型	示例值	描述
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=17544509338536

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2023011122285461C57537B04A4ABA73FC",
    "Action": "GetAwardConfigListAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673447334
  },
  "Result": {
    "Body": [
      {
        "ID": 1621615132,
        "Name": "奖券奖品",
        "AwardType": 1,
        "DeadLine": 1,
        "BarragePwd": "抽奖",
        "WinnerInfoType": "2",
        "Status": 4,
        "ActivityId": 17544509338536,
        "TotalCount": 5,
        "AwardCount": 1,
        "SendTime": 1673199096,
        "OpenAwardTime": 1673199158,
        "AwardNum": 1,
        "VIPUserList": "",
        "RangeStatus": 0,
        "ShowPeopleNumber": 0,
        "MsgIds": "155681",
        "ConditionType": 0,
        "ConditionVariable": 0,
        "ShowWinnerComment": 0,
        "AwardItemType": 4,
        "TaskAwardIcon": "//p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image",
        "AwardItemNum": "",
        "AwardItemAmounts": 0,
        "AwardLotteryTicketAddr": "https://livesaas/Configuration",
        "AwardCondition": {
          "Quiz": "2",
          "Questionnaire": "1",
          "CheckIn": "all",
          "Vote": "1",
          "RightQuiz": "1"
        },
        "AwardTheme": "bigTurntable"
      }
    ]
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.ActivityIDInvalid	The specified parameter ActivityID is invalid.	直播间 ID 不符合规范，请修改后重试。