GetTaskAwardItemListAPI - 获取直播间累计观看抽奖奖品列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

GetTaskAwardItemListAPI - 获取直播间累计观看抽奖奖品列表

最近更新时间：2025.04.16 19:06:49首次发布时间：2023.02.01 14:10:46

获取直播间已发送累计观看抽奖活动的奖品列表。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。
前提条件：确保您拥有火山引擎主账号或具备直播间的数据统计 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetTaskAwardItemListAPI`	接口名称。当前 API 的名称为 `GetTaskAwardItemListAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1231231231`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。说明使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。
PageNo	Integer	否	`1`	分页查询页码。默认值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量。默认值为 `10`。

返回参数

参数	类型	示例值	描述
TaskAwardItemList	Array of TaskAwardItemList	`无`	累计观看抽奖的奖品信息列表。
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`10`	分页查询数量。
PageTotalCount	Integer	`1`	查询结果总数。

TaskAwardItemList

参数	类型	示例值	描述
TaskAwardItemId	String	`8480`	累计观看抽奖的奖品 ID。
AwardItemType	Integer	`1`	奖品类型。取值如下： `1`：实物奖品 `2`：虚拟奖品 `3`：自定义奖品 `4`：奖券奖品
PeopleCount	Integer	`1`	参与人数。
AwardCount	Integer	`1`	中奖人数。
AwardItemName	String	`实物奖品`	奖品名称。
AwardLotteryTicketAddr	String	`https://xxx`	奖券奖品的领奖链接。说明仅当 `AwardItemType` 取值为 `4` 时，可以返回该参数值。
AwardStartTime	Long	`1689570360`	累计观看抽奖的开始时间。Unix 时间戳，单位为秒。
AwardEndTime	Long	`1689656640`	累计观看抽奖活动的结束时间。Unix 时间戳，单位为秒。
AwardItemNum	String	`1578457`	积分的奖品批次号。您可根据该批次号识别企业积分，向观众发放积分。
AwardItemAmounts	Integer	`1000`	每位中奖观众可获得的积分数额。您可根据该中奖金额，判断向中奖观众发放多少积分。
TaskAwardIcon	String	`//example-image.image`	奖品图标的 URL，无协议头。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetTaskAwardItemListAPI&Version=2020-06-01&ActivityId=1231231231&PageNo=1&PageItemCount=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetTaskAwardItemListAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TaskAwardItemList": [
            {
                "TaskAwardItemId": "8480",
                "AwardItemType": 1,
                "PeopleCount": 1,
                "AwardCount": 1,
                "AwardItemName": "实物奖品",
                "AwardLotteryTicketAddr": "https://xxx",
                "TaskAwardIcon": "//example-image.image",
                "AwardItemAmounts": 1000,
                "AwardItemNum": "1578457",
                "AwardStartTime": 1689570360,
                "AwardEndTime": 1689656640
            }
        ],
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1
    }
}

错误码

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