调用 ListActivityBonusTaskWinners 接口,在指定直播间内查询直播福利任务获奖名单。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListActivityBonusTaskWinners | 接口名称。当前 API 的名称为 ListActivityBonusTaskWinners。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
ActivityId | Long | 是 |
| 直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| Id | Long | 是 | 18123156153 | 直播福利任务 ID。您可以通过 ListActivityBonusTasks 接口查询 ID。 |
| PageNumber | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量。默认取值为 100。取值范围为 [1,1000]。 |
| SearchKeyWord | String | 否 | 1235454684 | 搜索的关键词,支持精确匹配用户 ID、昵称、关联用户 ID、邮箱或手机号。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Winners | Array of Winners | - | 获奖名单。 |
| Total | Integer | 32 | 获奖总数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| UserId | Long | 123451239 | 用户 ID,观众在企业直播的唯一标识。 |
ExternalUserId | String |
| 关联用户 ID。直播间的观看限制不同,关联用户 ID 的取值也有所不同:
|
| NickName | String | 观众 A | 用户昵称。 |
| FinishTime | Long | 1764672341 | 福利任务的完成时间。 |
| String | zhibo@xxx.com | 观众注册账号时,填写的邮箱地址。 | |
| AwardTel | String | +86188****1217 | 观众收到奖励时,填写的获奖手机号。 |
| AwardEmail | String | example2@example.com | 观众收到奖励时,填写的获奖邮箱。 |
| BonusIndex | Integer | 0 | 获得的奖励在直播福利任务中的下标序号。从 0 开始。如福利任务中第一个子任务对应的奖励,其对应的下标序号为 0。 |
| ReceiverName | String | 小明 | 观众收到奖品时,填写的收件人名称。 |
| Tel | String | 188****1456 | 观众注册账号时,填写的手机号。 |
| AwardAddress | String | 上海市xxxxx | 观众收到奖品时,填写的收货地址。 |
| BonusDetail | Object of BonusDetail | - | 福利任务的详细信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
SubTaskType | Integer |
| 子任务的类型。取值如下:
|
| SubTaskCondition | Integer | 10 | 完成该子任务的数量要求。示例:若 SubTaskType 取值为 1,SubTaskCondition 取值为 30,则表示获奖条件为“观看直播 30分钟”。 |
SubBonusType | Integer |
| 完成任务后,观众获得的奖励类型。取值如下:
|
| SubBonus | Object of SubBonus | - | 奖励的详细信息。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AwardSubBonus | Object of AwardSubBonus | - | 奖品奖励。 |
| CouponSubBonus | Object of CouponSubBonus | - | 卡券奖励。 |
| PointSubBonus | Object of PointSubBonus | - | 积分奖励。 |
| CashSubBonus | Object of CashSubBonus | - | 现金奖励。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 |
|
|
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
WinnerInfoType | Array of Integer |
| 获奖人需要填写的个人信息。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 |
| 该奖励可被领取的总份数。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AmountTenthsUnit | Long | 10 | 完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。 |
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| AmountTenthsUnit | Long | 10 | 完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。 |
LimitCount | Long |
| 该奖励可被领取的总份数。取值如下:
|
GET https://livesaas.volcengineapi.com/?Action=ListActivityBonusTaskWinners&Version=2023-08-01&ActivityId=181531561531&Id=181531561532&PageNumber=1&PageSize=10
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListActivityBonusTaskWinners", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Winners": [ { "UserId": 123451239, "ExternalUserId": "1437224142", "NickName": "观众 A", "FinishTime": 1764672341, "Email": "zhibo@xxx.com", "AwardTel": "+86188****1217", "AwardEmail": "example2@example.com", "BonusIndex": 0, "ReceiverName": "小明", "Tel": "188****1456", "AwardAddress": "上海市xxxxx", "BonusDetail": { "SubTaskType": 1, "SubTaskCondition": 10, "SubBonusType": 1, "SubBonus": { "AwardSubBonus": { "AwardItemId": 1715, "DeliveryMethod": 1, "AwardLotteryTicketAddr": "https://example.com", "AwardItemAmounts": 1, "AwardItemType": 1, "AwardItemName": "电子手表", "AwardItemIcon": "https://www.example.com/test.png", "AwardItemNum": "48151841", "LimitCount": -1, "WinnerInfoType": [ null ] }, "PointSubBonus": { "AmountTenthsUnit": 10, "LimitCount": -1 }, "CouponSubBonus": { "CouponId": 18156156151458, "CouponPic": "https://www.example.com/a.png", "CouponThirdPartyId": "45535343****444444", "CouponDescription": "满100减20", "CouponName": "鸡蛋优惠券", "LimitCount": -1 }, "CashSubBonus": { "AmountTenthsUnit": 10, "LimitCount": -1 } } } } ], "Total": 32 } }