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

获取直播间红包列表

最近更新时间：2024.01.16 11:54:39

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

我的收藏

获取直播间的红包列表信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListRedPacketDataAPI接口名称。当前 API 的名称为 ListRedPacketDataAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。
ActivityIdLong是1231231231直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNoInteger否1分页查询页码。默认取值为 1。
PageItemCountInteger否10分页查询数量。默认取值为 10。

返回参数

参数类型示例值描述
RedPacketListArray of RedPacketList-红包列表信息。
PageNoInteger1分页查询页码。
PageItemCountInteger10分页查询数量。
TotalCountInteger1查询结果总数。

RedPacketList

参数类型示例值描述

RedPacketType

Integer

0

红包类型。支持以下取值：

  • 0：现金红包
  • 1：积分红包
RewardsPointsUnitString积分积分的单位。

TotalAmount

Integer

100

红包的总金额。

  • 当 RedPacketType 取值为 0 时，该参数值的单位为分。
  • 当 RedPacketType 取值为 1 时，该参数值的单位为 RewardsPointsUnit 的取值。

ReceivedAmount

Integer

100

观众的中奖金额。

  • 当 RedPacketType 取值为 0 时，该参数值的单位为分。
  • 当 RedPacketType 取值为 1 时，该参数值的单位为 RewardsPointsUnit 的取值。
SendTimeInteger1673202413红包的发送时间。Unix 时间戳，单位为秒。
JoinUserNumberInteger1参与人数。
WinUserNumberInteger1中奖人数。

WithdrawalAmount

Integer

100

观众的提现金额，单位为分。

说明

仅当 RedPacketType 取值为 0 时，可以进行红包提现。

RedPacketNumberString1红包的个数。
RedPacketIdInteger1754478641139760红包 ID。

IsDelete

Boolean

false

红包是否已删除。支持以下取值：

  • false：否
  • true：是

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListRedPacketDataAPI&Version=2020-06-01&ActivityId=1231231231&PageNo=1&PageItemCount=10

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202301120024099CCB1169F45D1CE9F3AD",
    "Action": "ListRedPacketDataAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1673454249
  },
  "Result": {
    "PageNo": 1,
    "PageItemCount": 10,
    "TotalCount": 1,
    "RedPacketList": [
      {
        "SendTime": 1673202413,
        "TotalAmount": 100,
        "ReceivedAmount": 100,
        "JoinUserNumber": 1,
        "WinUserNumber": 1,
        "WithdrawalAmount": 100,
        "RedPacketNumber": 1,
        "RedPacketId": 1754478641139760,
        "RedPacketType": 0,
        "RewardsPointsUnit": "积分",
        "IsDelete": false
      }
    ]
  }
}

错误码

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

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