获取直播间红包列表

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

请求说明

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

请求参数

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

Query

返回参数

RedPacketData

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListRedPacketDataAPI&Version=2020-06-01&ActivityId=1231231231

正常返回示例

{
    "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":""
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023010901154861C57537B04A4A16B7C1",
        "Action": "ListRedPacketDataAPI",
        "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
}

错误码

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