获取直播间红包列表--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播间红包列表

最近更新时间：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

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRedPacketDataAPI`	接口名称。当前 API 的名称为 `ListRedPacketDataAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1231231231`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNo	Integer	否	`1`	分页查询页码。默认取值为 `1`。
PageItemCount	Integer	否	`10`	分页查询数量。默认取值为 `10`。

返回参数

参数	类型	示例值	描述
RedPacketList	Array of RedPacketList	`-`	红包列表信息。
PageNo	Integer	`1`	分页查询页码。
PageItemCount	Integer	`10`	分页查询数量。
TotalCount	Integer	`1`	查询结果总数。

RedPacketList

参数	类型	示例值	描述
RedPacketType	Integer	`0`	红包类型。支持以下取值： `0`：现金红包 `1`：积分红包
RewardsPointsUnit	String	`积分`	积分的单位。
TotalAmount	Integer	`100`	红包的总金额。当 `RedPacketType` 取值为 `0` 时，该参数值的单位为分。当 `RedPacketType` 取值为 `1` 时，该参数值的单位为 `RewardsPointsUnit` 的取值。
ReceivedAmount	Integer	`100`	观众的中奖金额。当 `RedPacketType` 取值为 `0` 时，该参数值的单位为分。当 `RedPacketType` 取值为 `1` 时，该参数值的单位为 `RewardsPointsUnit` 的取值。
SendTime	Integer	`1673202413`	红包的发送时间。Unix 时间戳，单位为秒。
JoinUserNumber	Integer	`1`	参与人数。
WinUserNumber	Integer	`1`	中奖人数。
WithdrawalAmount	Integer	`100`	观众的提现金额，单位为分。说明仅当 `RedPacketType` 取值为 `0` 时，可以进行红包提现。
RedPacketNumber	String	`1`	红包的个数。
RedPacketId	Integer	`1754478641139760`	红包 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
      }
    ]
  }
}

错误码

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

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