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=GetTaskAwardItemListAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选示例值描述
ActionString是GetTaskAwardItemListAPI接口名称。当前 API 的名称为 GetTaskAwardItemListAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1231231231直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
PageNoInteger否1分页查询页码，默认取值为 1。
PageItemCountInteger否10分页查询数量，默认取值为 10。

返回参数

参数类型示例值描述
TaskAwardItemListArray of TaskAwardItemList无累计观看抽奖的奖品信息列表。
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
PageTotalCountInteger1查询结果总数。

TaskAwardItemList

参数类型示例值描述
TaskAwardItemIdString8480累计观看抽奖的奖品 ID。

AwardItemType

Integer

1

奖品类型。

  • 1：实物奖品
  • 2：虚拟奖品
  • 3：自定义奖品
  • 4：奖券奖品
PeopleCountInteger1参与人数。
AwardCountInteger1中奖人数。
AwardItemNameString实物奖品奖品名称。

AwardLotteryTicketAddr

String

https://xxx

奖券奖品的领取链接。

说明

仅当 AwardItemType 取值为 4 时，可以返回该参数值。

AwardStartTimeLong1689570360累计观看抽奖的开始时间。Unix 时间戳，单位秒。
AwardEndTimeLong1689656640累计观看抽奖活动的结束时间。Unix 时间戳，单位秒。

AwardItemNum

String

1578457

自定义奖品的批次号。

说明

仅当 AwardItemType 取值为 3 时，可以返回该参数值。

AwardItemAmounts

Integer

1000

自定义奖品的中奖金额。

说明

仅当 AwardItemType 取值为 3 时，可以返回该参数值。

TaskAwardIconString//p-boe.byted.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image奖品图标的 URL，无协议头。

示例

请求示例

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

返回示例

{
  "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-boe.byted.org/04ae0f42a3a04e7387e5f6fe7a18c4fb~tplv-6ed59yyum2-image.image",
        "AwardStartTime": 1689570360,
        "AwardEndTime": 1689656640
      }
    ]
  }
}

错误码

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

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