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

文档中心

立即注册

导航

企业直播

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

最近更新时间：2024.05.10 16:33:25首次发布时间：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`	自定义奖品的批次号。说明仅当 `AwardItemType` 取值为 `3` 时，可以返回该参数值。
AwardItemAmounts	Integer	`1000`	自定义奖品的中奖金额。说明仅当 `AwardItemType` 取值为 `3` 时，可以返回该参数值。
TaskAwardIcon	String	`//p.byted.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image`	奖品图片 URL，无协议头。

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202301112319419CCB1169F45D1CD7A49F",
    "Action": "GetTaskAwardItemListAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673450381
  },
  "Result": {
    "PageNo": 1,
    "PageItemCount": 10,
    "PageTotalCount": 1,
    "TaskAwardItemList": [
      {
        "TaskAwardItemId": "8480",
        "AwardItemType": 1,
        "PeopleCount": 1,
        "AwardCount": 0,
        "AwardItemName": "奖品名称",
        "AwardLotteryTicketAddr": "",
        "AwardItemNum": "",
        "AwardItemAmounts": 0,
        "TaskAwardIcon": "//p.byted.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image",
        "AwardStartTime": 1689570360,
        "AwardEndTime": 1689656640
      }
    ]
  }
}

错误码

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