调用GetActivityBonusTask接口,在指定直播间内查询指定直播福利任务详情。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | GetActivityBonusTask | 接口名称。当前 API 的名称为 GetActivityBonusTask。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
ActivityId | Long | 是 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Id | Long | 是 | 18123156153 | 直播福利任务 ID。您可以通过 ListActivityBonusTasks 接口查询 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| ActivityBonusTasks | Object of ActivityBonusTasks | - | 直播福利任务详情。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 183738221212 | 直播福利任务 ID。 |
TaskRunningType | Integer |
| 直播福利任务开启方式。取值如下:
|
| EndTime | Long | 1764657098 | 福利任务的计划结束时间。Unix 时间戳,单位为秒。 |
| StartTime | Long | 1764657022 | 福利任务的计划开始时间。Unix 时间戳,单位为秒。 |
| Name | String | 看直播,领好礼 | 直播福利任务的名称。 |
| ActualEndTime | Long | 1764657098 | 福利任务的实际结束时间。若值为 0 则表示还未结束。 |
| ActualStartTime | Long | 1764657022 | 福利任务的实际开始时间。若值为 0 则表示还未开始。 |
Status | Integer |
| 福利任务的状态,取值如下:
|
| BonusList | Array of BonusList | - | 福利任务中的子任务。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
SubTaskType | Integer |
| 子任务的类型。取值如下:
|
| SubTaskCondition | Integer | 10 | 完成该子任务的数量要求。示例:若 SubTaskType 取值为 1,SubTaskCondition 取值为 30,则表示获奖条件为“观看直播 30分钟”。 |
SubBonusType | Integer |
| 完成任务后,观众获得的奖励类型。取值如下:
|
| SubBonus | Object of SubBonus | - | 奖励的详细信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PointSubBonus | Object of PointSubBonus | - | 积分奖励。 |
| CashSubBonus | Object of CashSubBonus | - | 现金奖励。 |
| CouponSubBonus | Object of CouponSubBonus | - | 卡券奖励。 |
| AwardSubBonus | Object of AwardSubBonus | - | 奖品奖励。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AmountTenthsUnit | Long | 10 | 完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。 |
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AmountTenthsUnit | Long | 10 | 完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。 |
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| CouponId | Long | 18156156151458 | 卡券 ID。 |
| CouponPic | String | https://www.example.com/a.png | 优惠券的图片 URL 地址,用于展示优惠券的图片信息。 |
CouponThirdPartyId | String |
| 关联卡券 ID,即您自有商城系统中的卡券 ID。 |
| CouponDescription | String | 满100减20 | 卡券描述。 |
| CouponName | String | 鸡蛋优惠券 | 卡券名称。 |
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AwardItemId | Long | 1715****1256 | 奖品库中的奖品 ID。 |
DeliveryMethod | Integer |
| 卡券奖品或积分奖品。取值如下:
|
| AwardLotteryTicketAddr | String | https://example.com | 奖券奖品的领奖链接。 |
| AwardItemAmounts | Long | 1 | 每位获奖观众可获得的积分数额。您可根据该金额,判断向观众发放多少积分。 |
AwardItemType | Integer |
| 奖品类型。取值如下:
|
| AwardItemName | String | 电子手表 | 奖励的奖品名称。 |
| AwardItemIcon | String | https://www.example.com/test.png | 奖品图片的 URL,有协议头。 |
AwardItemNum | String |
|
|
WinnerInfoType | Array of Integer |
| 获奖人需要填写的个人信息。取值如下:
|
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
GET https://livesaas.volcengineapi.com/?Action=GetActivityBonusTask&Version=2023-08-01&ActivityId=181561561564&Id=181761651458
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetActivityBonusTask", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "ActivityBonusTasks": { "Id": 183738221212, "BonusList": [ { "SubTaskType": 1, "SubTaskCondition": 10, "SubBonusType": 1, "SubBonus": { "CouponSubBonus": { "CouponId": 18156156151458, "CouponPic": "https://www.example.com/a.png", "CouponThirdPartyId": "45535343****444444", "CouponDescription": "满100减20", "CouponName": "鸡蛋优惠券", "LimitCount": -1 }, "PointSubBonus": { "AmountTenthsUnit": 10, "LimitCount": -1 }, "CashSubBonus": { "AmountTenthsUnit": 10, "LimitCount": -1 }, "AwardSubBonus": { "AwardItemId": 1715, "DeliveryMethod": 1, "AwardLotteryTicketAddr": "https://example.com", "AwardItemAmounts": 1, "AwardItemType": 1, "AwardItemName": "电子手表", "AwardItemIcon": "https://www.example.com/test.png", "AwardItemNum": "48151841", "WinnerInfoType": [ null ], "LimitCount": -1 } } } ], "Status": 1, "ActualStartTime": 1764657022, "TaskRunningType": 2, "EndTime": 1764657098, "Name": "看直播,领好礼", "StartTime": 1764657022, "ActualEndTime": 1764657098 } } }