You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

获取直播间累计观看抽奖参与或中奖名单

最近更新时间2023.02.09 16:20:22

首次发布时间2023.02.01 14:10:46

获取直播间累计观看抽奖的参与观众名单或中奖观众名单。

请求说明

  • 接口名称:GetTaskAwardRecordStatisticsAPI
  • 请求方式:GET
  • 接口地址:http://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01
  • 请求频率:单用户请求频率限制为 120 次/分钟

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNoInt分页查询页码,默认取值为 1
PageItemCountInt分页查询数量,默认取值为 10
TaskAwardItemIdString累计观看抽奖的奖品 ID。您可以通过调用 GetTaskAwardItemListAPI 接口查询 ID

SearchType

Int

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

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

返回参数

参数类型描述
TaskAwardRecoudListArray of TaskAwardRecord累计观看抽奖的观众信息列表
PageNoInt分页查询页码
PageItemCountInt分页查询数量
PageTotalCountInt查询结果总数

TaskAwardRecord

参数类型描述
UserIdInt观众 ID
PhoneString观众手机号
EmailString观众邮箱
NicknameString观众昵称
AddressString收货地址

Status

Int

中奖状态

  • 1:中奖
  • 2:未中奖
ExternalIdString关联用户 ID
LoginTelString观众的登录手机号
ReceiverNameString收件人姓名
TaskAwardNameString奖品名称
WinTimeString中奖用户开奖时间,Unix 时间戳,单位为秒
IpString观众的 IP 地址
ExtraString业务方扩展字段
UserAgentString观众终端设备

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetTaskAwardRecordStatisticsAPI&Version=2020-06-01&ActivityId=175472177775307&TaskAwardItemId=8480

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202301151445086753F5AA91AA70249144",
        "Action": "GetTaskAwardRecordStatisticsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673765108
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1,
        "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"
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "GetTaskAwardRecordStatisticsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InvalidParameter.ActivityIdNotFound",
            "Message": "The specified parameter ActivityId is invalid."
        },
        "SystemTime": 1673198148
    },
    "Result": null
}

错误码

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

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