You need to enable JavaScript to run this app.
导航
GetTaskAwardRecordStatisticsAPI - 获取直播间累计观看抽奖参与或中奖名单
最近更新时间:2025.09.11 11:02:25首次发布时间:2023.02.01 14:10:46
复制全文
我的收藏
有用
有用
无用
无用

调用 GetTaskAwardRecordStatisticsAPI 接口,获取指定直播间指定累计观看抽奖的参与观众名单或中奖观众名单。

注意事项

  • 请求频率:单用户请求频率限制为 120 次/分钟
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的数据统计 > 仅查看可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetTaskAwardRecordStatisticsAPI接口名称。当前 API 的名称为 GetTaskAwardRecordStatisticsAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01

ActivityId

Long

17791682871582

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

说明

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

PageNoInteger1分页查询页码,默认取值为 1
PageItemCountInteger10分页查询数量。取值范围为 [1,500],默认取值为 10
TaskAwardItemIdString6188累计观看抽奖的奖品 ID。您可以通过调用 GetTaskAwardItemListAPI接口查询 ID

SearchType

Integer

2

查询的观众名单类型,默认取值为 1

  • 1:中奖观众名单
  • 2:参与观众名单

返回参数

参数类型示例值描述
TaskAwardRecordListArray of TaskAwardRecordList-累计观看抽奖的观众信息列表。
PageNoInteger1分页查询页码.。
PageItemCountInteger10分页查询数量。
PageTotalCountInteger1查询结果总数。

TaskAwardRecordList

参数类型示例值描述
UserIdLong1753988749721692观众 ID。
PhoneString158xxxx66观众的登录手机号。
EmailStringzhibo@xxx.com观众注册账号时,填写的邮箱地址。
NicknameStringcjr观众昵称。
AddressString北京收货地址。

Status

Integer

2

中奖状态。支持以下取值:

  • 1:中奖
  • 2:未中奖
ExternalIdString1437224142观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
LoginTelString158xxxx66观众的登录手机号。
ReceiverNameString张三收件人姓名。
TaskAwardNameString幸运奖奖品名称。
WinTimeString1437224456142开奖时间,Unix 时间戳,单位为秒。
IpString10.255.21.200观众的 IP 地址。
ExtraStringabc业务方扩展字段。
UserAgentStringIntel Mac OS X 10_15_7观众进入直播间使用的终端机型。
AwardEmailStringwinner@example.com观众中奖后,填写的邮箱地址。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01&ActivityId=17791682871582&PageNo=1&PageItemCount=10&TaskAwardItemId=6188&SearchType=2

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetTaskAwardRecordStatisticsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TaskAwardRecordList": [
            {
                "UserId": 1753988749721692,
                "Phone": "158xxxx66",
                "Email": "zhibo@xxx.com",
                "Nickname": "cjr",
                "Address": "北京",
                "Status": 2,
                "ExternalId": "1437224142",
                "LoginTel": "158xxxx66",
                "ReceiverName": "张三",
                "TaskAwardName": "幸运奖",
                "WinTime": "1437224456142",
                "Ip": "10.255.21.200",
                "Extra": "abc",
                "UserAgent": "Intel Mac OS X 10_15_7",
                "AwardEmail": "winner@example.com"
            }
        ],
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.ActivityIDInvalidThe specified parameter ActivityID is invalid.直播间 ID 不符合规范,请修改后重试
500InternalErrorThe request has failed due to an unknown error.请求处理过程中出现了未知错误,请联系技术支持获取帮助