You need to enable JavaScript to run this app.
企业直播

企业直播

复制全文
福利任务
ListActivityBonusTaskWinners - 查询直播福利获奖名单
复制全文
ListActivityBonusTaskWinners - 查询直播福利获奖名单

调用 ListActivityBonusTaskWinners 接口,在指定直播间内查询直播福利任务获奖名单。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的数据统计 > 可查看权限的子账号。有关如何添加子账号,详见子账号管理
  • 使用限制:仅支持查询 60 天内的直播福利任务的获奖名单。

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListActivityBonusTaskWinners&Version=2023-08-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListActivityBonusTaskWinners接口名称。当前 API 的名称为 ListActivityBonusTaskWinners
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

ActivityId

Long

1783****8443

直播间的 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

IdLong18123156153直播福利任务 ID。您可以通过 ListActivityBonusTasks 接口查询 ID。
PageNumberInteger1分页查询页码。默认值为 1。取值大于等于 1。
PageSizeInteger10分页查询数量。默认取值为 100。取值范围为 [1,1000]。
SearchKeyWordString1235454684搜索的关键词,支持精确匹配用户 ID、昵称、关联用户 ID、邮箱或手机号。

返回参数

参数类型示例值描述
WinnersArray of Winners-获奖名单。
TotalInteger32获奖总数。

Winners

参数类型示例值描述
UserIdLong123451239用户 ID,观众在企业直播的唯一标识。

ExternalUserId

String

1437224142

关联用户 ID。直播间的观看限制不同,关联用户 ID 的取值也有所不同:

  • 微信:观众在企业直播微信服务号的 OpenID。
  • 企业微信:绑定企业直播的企业内部成员 OpenID。
  • 自定义:自定义登录时通过 UserId 传入的值。详见自定义登录
  • OAuth2.0:您自有账号系统中用户 ID 对应的字段。
  • 飞书:绑定企业直播的飞书企业成员 Open ID。
  • 手机号:观众通过手机号注册企业直播后生成的 passport_id。
  • 白名单:白名单校验信息。
  • 如果您集成了观播 SDK,且 SDK 的鉴权模式为自定义模式,关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时、或调用 GetActivityLoginSecret 后生成 JWT 时,传入的 UserIdStr(观众 ID)。
NickNameString观众 A用户昵称。
FinishTimeLong1764672341福利任务的完成时间。
EmailStringzhibo@xxx.com观众注册账号时,填写的邮箱地址。
AwardTelString+86188****1217观众收到奖励时,填写的获奖手机号。
AwardEmailStringexample2@example.com观众收到奖励时,填写的获奖邮箱。
BonusIndexInteger0获得的奖励在直播福利任务中的下标序号。从 0 开始。如福利任务中第一个子任务对应的奖励,其对应的下标序号为 0。
ReceiverNameString小明观众收到奖品时,填写的收件人名称。
TelString188****1456观众注册账号时,填写的手机号。
AwardAddressString上海市xxxxx观众收到奖品时,填写的收货地址。
BonusDetailObject of BonusDetail-福利任务的详细信息。

BonusDetail

参数类型示例值描述

SubTaskType

Integer

1

子任务的类型。取值如下:

  • 1:观看直播分钟数
  • 2:聊天次数
  • 3:点赞次数
  • 4:邀请人数
  • 5:商品点击次数
  • 6:打赏次数
  • 7:投票次数
  • 8:完成问卷次数
  • 9:签到次数
  • 10:答题次数
  • 11:答对次数
SubTaskConditionInteger10完成该子任务的数量要求。示例:若 SubTaskType 取值为 1SubTaskCondition 取值为 30,则表示获奖条件为“观看直播 30分钟”。

SubBonusType

Integer

1

完成任务后,观众获得的奖励类型。取值如下:

  • 1:积分
  • 2:现金
  • 3:优惠券
  • 4:奖品
SubBonusObject of SubBonus-奖励的详细信息。

SubBonus

参数类型示例值描述
AwardSubBonusObject of AwardSubBonus-奖品奖励。
CouponSubBonusObject of CouponSubBonus-卡券奖励。
PointSubBonusObject of PointSubBonus-积分奖励。
CashSubBonusObject of CashSubBonus-现金奖励。

AwardSubBonus

参数类型示例值描述
AwardItemIdLong1715****1256奖品库中的奖品 ID。

DeliveryMethod

Integer

1

卡券奖品或积分奖品。取值如下:

  • 1:卡券
  • 2:积分
AwardLotteryTicketAddrStringhttps://example.com奖券奖品的领奖链接。
AwardItemAmountsLong1每位获奖观众可获得的积分数额。您可根据该金额,判断向观众发放多少积分。

AwardItemType

Integer

1

奖品类型。取值如下:

  • 1:实物奖品
  • 2:虚拟奖品
  • 3:卡券奖品或积分奖品
  • 4:奖券奖品
AwardItemNameString电子手表奖励的奖品名称。
AwardItemIconStringhttps://www.example.com/test.png奖品图片的 URL,有协议头。

AwardItemNum

String

48151841

  • 若奖品类型为卡券奖品,该字段表示关联的卡券 ID。您可通过该 ID,将当前卡券绑定您商城系统中的卡券,方便后续卡券的发放以及在商城内的核销。
  • 若奖品类型为积分奖品,该字段表示积分奖品的批次号。您可根据该批次号识别企业积分,向观众发放积分。

LimitCount

Long

-1

该奖励可被领取的总份数。取值如下:

  • -1:无限制
  • [1,100,000] 之间的整数:表示具体奖励份数

WinnerInfoType

Array of Integer

2,1,3

获奖人需要填写的个人信息。取值如下:

  • 1:收货地址
  • 2:手机号
  • 3:收件人
  • 4:邮箱

CouponSubBonus

参数类型示例值描述
CouponIdLong18156156151458卡券 ID。
CouponPicStringhttps://www.example.com/a.png优惠券的图片 URL 地址,用于展示优惠券的图片信息。

CouponThirdPartyId

String

45535343****444444

关联卡券 ID,即您自有商城系统中的卡券 ID。
通过该 ID,可将当前卡券绑定您商城系统中的卡券,方便后续卡券的发放以及在商城内的核销。

CouponDescriptionString满100减20卡券描述。
CouponNameString鸡蛋优惠券卡券名称。

LimitCount

Long

-1

该奖励可被领取的总份数。取值如下:

  • -1:无限制
  • [1,100,000] 之间的整数:表示具体奖励份数

PointSubBonus

参数类型示例值描述
AmountTenthsUnitLong10完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。

LimitCount

Long

-1

该奖励可被领取的总份数。取值如下:

  • -1:无限制
  • [1,100,000] 之间的整数:表示具体奖励份数

CashSubBonus

参数类型示例值描述
AmountTenthsUnitLong10完成任务后,单个观众可获得的现金值,单位为 0.1 元。若该值设为 10,则每位观众可获得 1 元。

LimitCount

Long

-1

该奖励可被领取的总份数。取值如下:

  • -1:无限制
  • [1,100,000] 之间的整数:表示具体奖励份数

请求示例

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
    }
}

错误码

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

最近更新时间:2026.01.22 10:57:03
这个页面对您有帮助吗?
有用
有用
无用
无用