获取直播间红包参与或中奖名单

获取直播间红包的参与观众名单或中奖观众名单。

请求说明

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

请求参数

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

Query

返回参数

JoinRedPacketData

中奖名单

参与名单

示例

请求示例

Get http://livesaas.volcengineapi.com/?Action=ListRedPacketRecordAPI&Version=2020-06-01&ActivityId=1231231231&RedPacketID=1754478641139760&SearchType=1

正常返回示例

{
    "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": "",
*                "Ip": "10.5.22.56",          
                "Extra": "abc",
                "UserAgent": "Intel Mac OS X 10_15_7",
                "UserTel": "152***364",
                "IsPriorityUser": 0
            }
        ]
    }
}

异常返回示例

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

错误码

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