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=ListRedPacketRecordAPI&Version=2020-06-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringListRedPacketRecordAPI接口名称。当前 API 的名称为 ListRedPacketRecordAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
ActivityIdLong1231231231直播间 ID。您可以通过调用 ListActivityAPI 接口查询 ID。
PageNoInteger1分页查询页码,默认取值为 1
PageItemCountInteger10分页查询数量,默认取值为 10

SearchType

Integer

2

查询的名单类型。

  • 1:中奖名单
  • 2:参与名单
RedPacketIDInteger1779513713712199红包 ID。您可以通过调用 ListRedPacketDataAPI 接口查询 ID。

返回参数

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

JoinRedPacketList

参数类型示例值描述
UserIDLong1738686737584142观众 ID。
ExternalIdString1605756488530014观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计
UserNameStringaa1观众昵称。
EmailStringzhibo@xxx.com观众邮箱。
UserTelString152***364观众登录手机号。

Amount

Integer

100

观众抢中的现金红包或积分红包金额。

  • 若为现金红包,该参数值的单位为分。
  • 若为积分红包,该参数值的单位为设置的积分单位。

IsPriorityUser

Integer

0

观众是否为优先中奖用户。

  • 0:否
  • 1:是

WithdrawalStatus

String

0

提现状态。

  • 0:未提现
  • 1:提现中
  • 2:提现成功
  • 3:提现失败
  • 4:未绑定微信账号

说明

该参数仅在查询中奖名单时返回。

WechatName

String

小张

观众授权提现至微信零钱的微信昵称。

说明

该参数仅在查询中奖名单时返回。

PhoneNumberString158xxxx88观众提现手机号。

WechatOpenID

String

HFTOM545

观众授权提现至微信零钱的微信用户 OpenID。

说明

该参数仅在查询中奖名单时返回。

Status

Integer

1

观众的中奖状态。

  • 1:中奖
  • 2:未中奖
IpString10.5.22.56观众的 IP 地址。
ExtraStringabc业务方扩展字段。
UserAgentStringIntel Mac OS X 10_15_7观众终端设备。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListRedPacketRecordAPI&Version=2020-06-01&ActivityId=1231231231&PageItemCount=10&PageNo=1&RedPacketID=1779513713712199&SearchType=2

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202301131353233BE8AB68A85AE0CB0316",
    "Action": "ListRedPacketRecordAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673589203
  },
  "Result": {
    "PageNo": 1,
    "PageItemCount": 10,
    "TotalCount": 1,
    "JoinRedPacketList": [
      {
        "UserID": 1738686737584142,
        "UserName": "aa1",
        "Email": "zhibo@xxx.com",
        "PhoneNumber": "158xxxx88",
        "Status": 1,
        "ExternalId": "1605756488530014",
        "Amount": 100,
        "WithdrawalStatus": 0,
        "WechatName": "小张",
        "WechatOpenID": "HFTOM545",
        "Ip": "10.5.22.56",
        "Extra": "abc",
        "UserAgent": "Intel Mac OS X 10_15_7",
        "UserTel": "152***364",
        "IsPriorityUser": 0
      }
    ]
  }
}

错误码

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

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