You need to enable JavaScript to run this app.
导航
获取直播间累计观看抽奖参与或中奖名单
最近更新时间:2023.11.08 09:30:21首次发布时间:2023.02.01 14:10:46

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

注意事项

请求频率:单用户请求频率限制为 120 次/分钟

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetTaskAwardRecordStatisticsAPI接口名称。当前 API 的名称为 GetTaskAwardRecordStatisticsAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
ActivityIdLong17791682871582直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID
PageNoInteger1分页查询页码,默认取值为 1
PageItemCountInteger10分页查询数量,默认取值为 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
LoginTelString158xxxx66观众的登录手机号
ReceiverNameString张三收件人姓名
TaskAwardNameString幸运奖奖品名称
WinTimeString1437224456142中奖用户开奖时间,Unix 时间戳,单位为秒
IpString10.255.21.200观众的 IP 地址
ExtraStringabc业务方扩展字段
UserAgentStringIntel Mac OS X 10_15_7观众终端设备

示例

请求示例

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

返回示例

{
  "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"
      }
    ]
  }
}

错误码

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

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