You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

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

最近更新时间：2024.04.16 13:53:26

首次发布时间：2024.04.16 13:53:26

我的收藏

通过本接口，获取指定直播间实时抽奖的参与观众名单或中奖观众名单。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListAwardRecordStatistics接口名称。当前 API 的名称为 ListAwardRecordStatistics。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
ActivityIdLong是1754721774775307直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

SearchType

Integer

否

1

观众名单类型。支持以下取值，默认取值为 0。

  • 0：参与观众名单
  • 1：中奖观众名单
AwardIdLong是1621615169抽奖 ID。您可以通过 ListAwardConfigs 接口查询 ID（即返回参数 Id）。
PageNoInteger否1分页查询页码，默认取值为 1。
PageItemCountInteger否10分页查询数量。取值范围为 [1,500]，默认取值为 10。

返回参数

参数类型示例值描述
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
PageTotalCountInteger1查询结果总数。
AwardRecordsArray of AwardRecords-观众信息列表。

AwardRecords

参数类型示例值描述
ActivityIdInteger1754721774775307直播间 ID。
UserNameString观众 A观众昵称。
LoginTelString157xxxx66观众的登录手机号。
AwardAddressString北京收件人地址。

AwardResult

Integer

4

抽奖结果。支持以下取值：

  • 4：中奖
  • 5：未中奖

NotifyResult

Integer

1

观众填写中奖信息后，是否通知抽奖结果，支持以下取值：

  • 1：未通知
  • 2：已通知
ExternalIdString1437224142观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份，以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时，关联用户 ID 取值不同，具体取值情况详见数据统计。
AwardNameString抽奖活动抽奖名称。
ReceiverNameString李收件人姓名。
ReceiverTelString157xxxx66收件人手机号。
EmailStringzhibo@xxx.com收件人邮箱。
OpenAwardTimeInteger1673535761开奖时间。Unix 时间戳，单位为秒。
ExtraStringabc业务方扩展字段。
UserAgentStringIntel Mac OS X 10_15_7观众进入直播间使用的终端机型。
IpStringfdbd:dc00:5ea1:2c6::a4:adb7观众的 IP 地址。

IsPriorityUser

Integer

1

是否为优先中奖人员。支持以下取值：

  • 0：否
  • 1：是
AwardIdLong1621615169抽奖 ID。
UserIdString1753988749721692观众 ID，即观众在企业直播的唯一标识。
AwardItemNameString奖券奖品中奖的奖品名称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListAwardRecordStatistics&Version=2023-08-01&ActivityId=1754721774775307&SearchType=1&AwardID=1621615169&PageNo=1&PageItemCount=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListAwardRecordStatistics",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1679035761
    },
    "Result": {
        "AwardStatisticsList": [
            {
                "ActivityId": 1754721774775307,
                "UserName": "观众 A",
                "LoginTel": "157xxxx66",
                "AwardAddress": "北京",
                "AwardResult": 4,
                "NotifyResult": 1,
                "ExternalId": "1437224142",
                "AwardName": "抽奖活动",
                "ReceiverName": "李",
                "ReceiverTel": "157xxxx66",
                "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,
                "AwardId": 1621615169,
                "UserId": "1753988749721692",
                "AwardItemName": "奖券奖品"
            }
        ],
        "PageNo": 1,
        "PageItemCount": 10,
        "PageTotalCount": 1
    }
}

错误码

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