获取直播间实时抽奖配置信息--企业直播-火山引擎

文档中心

立即注册

导航

获取直播间实时抽奖配置信息

最近更新时间：2024.11.13 11:05:57首次发布时间：2024.04.16 13:53:26

您可通过此接口获取指定直播间已发送实时抽奖的抽奖名称、开奖方式、抽奖规则等配置信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListAwardConfigs`	接口名称。当前 API 的名称为 `ListAwardConfigs`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`17544****38536`	直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。

返回参数

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

AwardConfigs

参数	类型	示例值	描述
Id	Long	`36576`	实时抽奖 ID。
Name	String	`抽奖活动`	抽奖名称。
AwardType	Integer	`1`	开奖方式。取值如下： `1`：自动开奖 `2`：手动开奖
DeadLine	Long	`1`	开奖倒计时中的分钟数。说明仅当 `AwardType` 取值为 `1` 时，该参数生效。
DeadLineSecond	Long	`30`	开奖倒计时中的秒数。说明仅当 `AwardType` 取值为 `1` 时，该参数生效。
BarragePwd	String	`弹幕口令`	抽奖弹幕口令。
Status	Integer	`4`	抽奖状态。取值如下： `2`：抽奖中 `4`：开奖完成 `5`：已删除 `7`：已撤回
ActivityId	Long	`17544****38536`	直播间 ID。
ParticipantCount	Integer	`5`	参与人数。
WinnerCount	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`：展示
AwardCondition	Object of AwardCondition	`-`	参与抽奖条件。
AwardTheme	String	`bigTurntable`	抽奖主题。取值如下： `bigTurntable`：大转盘 `lotteryBox`：开奖箱 `slotMachine`：拉霸机
AwardItemInfo	Array of AwardItemInfo	`-`	奖品信息。
IsHideAwardNum	Integer	`0`	是否在观看页显示奖品数量。取值如下： `0`：显示 `1`：不显示
AwardSendType	Integer	`1`	抽奖发送方式。取值如下： `0`：手动发送 `1`：定时发送
AwardSendTime	Long	`1726734970`	抽奖定时发送的时间。Unix 时间戳，单位为秒。说明仅当 `AwardSendType` 取值为 `1` 时，该参数生效。

AwardCondition

参数	类型	示例值	描述
Quiz	String	`2`	观众需要提交的答题或简答数。返回值为 `all` 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有答题或简答。
Questionnaire	String	`1`	观众需要提交的问卷数。返回值为 `all` 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有问卷。
CheckIn	String	`all`	观众需要提交的签到数。返回值为 `all` 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有签到。
Vote	String	`1`	观众需要提交的投票数。返回值为 `all` 表示需要提交直播开始后至观众参与抽奖前，直播间发布的所有投票。
RightQuiz	String	`1`	观众需要正确作答的题目数。返回值为 `all` 表示需要正确作答直播开始后至观众参与抽奖前，直播间发布的所有题目。

AwardItemInfo

参数	类型	示例值	描述
AwardItemId	Long	`908`	奖品 ID。
AwardItemName	String	`奖券`	奖品名称。
AwardItemCount	Long	`1000`	奖品数量。
AwardItemType	Integer	`4`	奖品类型。取值如下： `1`：实物奖品 `2`：虚拟奖品 `3`：自定义奖品 `4`：奖券奖品
WinnerCount	Long	`1`	当前奖品的中奖人数。
AwardItemIcon	String	`//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=17544****38536

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListAwardConfigs",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673199988
    },
    "Result": {
        "AwardConfigs": [
            {
                "Id": 36576,
                "Name": "抽奖活动",
                "AwardType": 1,
                "DeadLine": 1,
                "DeadLineSecond": 30,
                "BarragePwd": "弹幕口令",
                "Status": 4,
                "ActivityId": 17544****38536,
                "ParticipantCount": 5,
                "WinnerCount": 1,
                "SendTime": 1673199096,
                "OpenAwardTime": 1673199158,
                "AwardNum": 1,
                "RangeStatus": 0,
                "ShowPeopleNumber": 0,
                "MsgIds": "155681",
                "ShowWinnerComment": 0,
                "AwardCondition": {
                    "Quiz": "2",
                    "Questionnaire": "1",
                    "CheckIn": "all",
                    "Vote": "1",
                    "RightQuiz": "1"                 
                },
                "AwardTheme": "bigTurntable",
                "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,
                "AwardSendType": 1,
                "AwardSendTime": 1726734970
            }
        ]
    }
}

错误码

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