You need to enable JavaScript to run this app.
导航

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

最近更新时间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

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

返回参数

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

BodyInfo

参数类型示例值描述
IDInteger1621615132实时抽奖的奖品 ID。
NameString奖券奖品奖品名称。

AwardType

Integer

1

开奖方式。

  • 1:自动开奖
  • 2:手动开奖
DeadLineInteger1开奖倒计时,单位为分。
BarragePwdString抽奖抽奖弹幕口令。

WinnerInfoType

String

2

中奖人需要填写的个人信息。

  • 1:收货地址
  • 2:手机号
  • 3:收件人

Status

Integer

4

抽奖状态。

  • 2:抽奖中
  • 4:开奖完成
  • 5:已删除
  • 7:已撤回
ActivityIdLong17544509338536直播间 ID。
TotalCountInteger5参与人数。
AwardCountInteger1中奖人数。
SendTimeInteger1673199096抽奖的发送时间。Unix 时间戳,单位秒。
OpenAwardTimeInteger1673199158开奖时间。Unix 时间戳,单位秒。
AwardNumInteger1奖品数量。

RangeStatus

Integer

0

抽奖规则。

  • 0:所有人
  • 1:未中奖观众优先

ShowPeopleNumber

Integer

0

是否显示参与抽奖人数。

  • 0:显示
  • 1:不显示
MsgIdsString155681通过控制台发送的该实时抽奖的图文消息 ID。

ShowWinnerComment

Integer

0

是否展示中奖者详情。

  • 0:不展示
  • 1:展示

AwardItemType

Integer

4

奖品类型。

  • 1:实物奖品
  • 2:虚拟奖品
  • 3:自定义奖品
  • 4:奖券奖品
TaskAwardIconString//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:拉霸机
AwardConditionObject of AwardCondition-参与抽奖条件。

VIPUserList

String

VIP 名单。

说明

该字段仅用于兼容实时抽奖功能旧逻辑,未与控制台奖品库功能关联。

ConditionType

Integer

0

参与抽奖条件。

  • 0:无参与条件
  • 1:参与答题。即只有正确作答设置的题目数,才有资格参与抽奖

说明

该字段仅用于兼容实时抽奖功能旧逻辑,未与控制台奖品库功能关联。

ConditionVariable

Integer

0

正确作答的题目数。

说明

该字段仅用于兼容实时抽奖功能旧逻辑,未与控制台奖品库功能关联。

AwardCondition

参数类型示例值描述
QuizString2观众需要提交的答题数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前,直播间发布的所有答题。
RightQuizString1观众需要正确作答的题目数。返回值为 all 表示需要正确作答直播开始后至观众参与抽奖前,直播间发布的所有题目。
QuestionnaireString1观众需要提交的问卷数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前,直播间发布的所有问卷。
CheckInStringall观众需要提交的签到数。返回值为 all 表示需要提交直播开始后至观众参与抽奖前,直播间发布的所有签到。
VoteString1观众需要提交的投票数。返回值为 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"
      }
    ]
  }
}

错误码

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

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