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

获取直播间实时抽奖参与或中奖名单

最近更新时间2023.04.04 16:28:42

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

获取直播间实时抽奖的参与观众名单或中奖观众名单。

请求说明

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

请求参数

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

Query

参数类型是否必选描述
ActionString接口名称
VersionString接口版本。直播当前 API 的版本为 2020-06-01
ActivityIdInt直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID

SearchType

Byte

搜索类型,默认搜索参与观众名单

  • 0:参与观众名单
  • 1:中奖观众名单
AwardIDInt实时抽奖的奖品 ID。您可以通过调用 GetAwardConfigListAPI 接口查询 ID
PageNoInt分页查询页码,默认取值为 1
PageItemCountInt分页查询数量,默认取值为 10

返回参数

参数类型描述
AwardStatisticsListArray of AwardStatistic实时抽奖的观众信息列表
PageNoInt分页查询页码
PageItemCountInt分页查询数量
PageTotalCountInt查询结果总数

AwardStatistic

参数类型描述
ActivityIdInt直播间 ID
AwardIDInt实时抽奖的奖品 ID
UserIDString观众 ID
UserNameString观众昵称
LoginTelString观众登录手机号
AwardAddressString收件人地址

AwardResult

Int

抽奖结果

  • 4:中奖
  • 5:未中奖

NotifyResult

Int

用户填写中奖信息后是否通知抽奖结果

  • 1:未通知
  • 2:已通知
ExternalIdString观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
AwardNameString奖品名称
ReceiverNameString收件人姓名
ReceiverTelString收件人手机号
EmailString邮箱
OpenAwardTimeInt开奖时间
ExtraString业务方扩展字段
UserAgentString观众终端设备
IpString观众的 IP 地址

IsPriorityUser

Int

是否为优先中奖人员

  • 0:否
  • 1:是

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=GetAwardRecordStatisticsAPI&Version=2020-06-01&ActivityId=1754721774775307&SearchType=2&AwardID=1621615132

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202301151458266019F697FC78EBED82BB",
        "Action": "GetAwardRecordStatisticsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1673765906
    },
    "Result": {
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1,
        "AwardStatisticsList": [
            {
                "ActivityId": 1754721774775307,
                "AwardID": 1621615169,
                "UserID": "1753988749721692",
                "UserName": "cjr",
                "LoginTel": "157xxxx66",
                "AwardAddress": "",
                "AwardResult": 4,
                "NotifyResult": 1,
                "ExternalId": "1437224142",
                "AwardName": "333",
                "ReceiverName": "",
                "ReceiverTel": "",
                "Email": "zhibo@xxx.com",
                "OpenAwardTime": 1673535761,
                "Extra": "abc",
                "UserAgent": "Intel Mac OS X 10_15_7",
                "Ip": "fdbd:dc00:5ea1:2c6::a4:adb7",
                "IsPriorityUser": 1
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "GetAwardRecordStatisticsAPI",
        "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.请求处理过程中出现了未知错误,请联系技术支持获取帮助