You need to enable JavaScript to run this app.
导航
获取直播间实时抽奖配置信息
最近更新时间:2024.04.16 13:53:26首次发布时间:2024.04.16 13:53:26

通过本接口,获取指定直播间已发送实时抽奖的配置信息。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListAwardConfigs&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringListAwardConfigs接口名称。当前 API 的名称为 ListAwardConfigs
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
ActivityIdLong17544509338536直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

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

BodyInfo

参数类型示例值描述
NameString抽奖活动抽奖名称。

AwardType

Integer

1

开奖方式。支持以下取值:

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

Status

Integer

4

抽奖状态。支持以下取值:

  • 2:抽奖中
  • 4:开奖完成
  • 5:已删除
  • 7:已撤回
ActivityIdLong17544509338536直播间 ID。
SendTimeInteger1673199096抽奖的发送时间。Unix 时间戳,单位为秒。
OpenAwardTimeInteger1673199158开奖时间。Unix 时间戳,单位为秒。

RangeStatus

Integer

0

抽奖规则。支持以下取值:

  • 0:所有观众的中奖概率相同
  • 1:未中奖观众优先

ShowPeopleNumber

Integer

0

是否在观看页显示抽奖的实际参与人数。支持以下取值:

  • 0:显示
  • 1:不显示
MsgIdsString155681通过控制台发送该抽奖的图文消息 ID。
AwardConditionObject of AwardCondition-参与抽奖条件。

AwardTheme

String

bigTurntable

抽奖主题。支持以下取值:

  • bigTurntable:大转盘
  • lotteryBox:开奖箱
  • slotMachine:拉霸机
IdLong36576抽奖 ID。
WinnerCountInteger1中奖总人数。
ParticipantCountInteger5参与抽奖总人数。
AwardNumInteger1所有奖品的总数量。

ShowWinnerComment

Integer

0

是否展示中奖者详情。支持以下取值:

  • 0:不展示
  • 1:展示
AwardItemInfoArray of AwardItemInfo-奖品信息。

IsHideAwardNum

Integer

0

是否在观看页显示奖品数量。支持以下取值:

  • 0:显示
  • 1:不显示

AwardCondition

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

AwardItemInfo

参数类型示例值描述
AwardItemIdLong908奖品 ID。
AwardItemNameString奖券奖品名称。
AwardItemCountLong1000奖品数量。

AwardItemType

Integer

4

奖品类型。支持以下取值:

  • 1:实物奖品
  • 2:虚拟奖品
  • 3:自定义奖品
  • 4:奖券奖品
WinnerCountLong1当前奖品的中奖人数。
AwardItemIconString//p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image奖品图标的 URL,无协议头。

AwardLotteryTicketAddr

String

http://livesaas.example.com/***

奖券奖品的领奖链接。

说明

仅当 AwardItemType 取值为 4 时,返回领奖链接,否则为空。

WinnerInfoType

String

2,1,3

中奖人需要填写的个人信息。支持以下取值:

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

AwardItemNum

String

48151841

自定义奖品的奖品批次号。

说明

仅当 AwardItemType 取值为 3 时,返回奖品批次号,否则为空。

AwardItemAmounts

Long

0

自定义奖品的中奖金额。

说明

仅当 AwardItemType 取值为 3 时,返回中奖金额,否则取值为 0

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListAwardConfigs&Version=2023-08-01&ActivityId=17544509338536

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListAwardConfigs",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673199988
    },
    "Result": {
        "Body": [
            {
                "Name": "抽奖活动",
                "AwardType": 1,
                "DeadLine": 1,
                "BarragePwd": "弹幕口令",
                "Status": 4,
                "ActivityId": 17544509338536,
                "SendTime": 1673199096,
                "OpenAwardTime": 1673199158,
                "RangeStatus": 0,
                "ShowPeopleNumber": 0,
                "MsgIds": "155681",
                "AwardCondition": {
                    "Quiz": "2",
                    "RightQuiz": "1",
                    "Questionnaire": "1",
                    "CheckIn": "all",
                    "Vote": "1"
                },
                "AwardTheme": "bigTurntable",
                "Id": 36576,
                "WinnerCount": 1,
                "ParticipantCount": 5,
                "AwardNum": 1,
                "ShowWinnerComment": 0,
                "AwardItemInfo": [
                    {
                        "AwardItemId": 908,
                        "AwardItemName": "奖券",
                        "AwardItemCount": 1000,
                        "AwardItemType": 4,
                        "WinnerCount": 1,
                        "AwardItemIcon": "//p.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image",
                        "AwardLotteryTicketAddr": "http://livesaas.example.com/***",
                        "WinnerInfoType": "2,1,3",
                        "AwardItemNum": "",
                        "AwardItemAmounts": 0
                    }
                ],
                "IsHideAwardNum": 0
            }
        ]
    }
}

错误码

访问公共错误码错误码获取详细信息。