保利威文档中心

帮助中心

直播服务端 API

分页查询频道抽奖统计记录

更新时间：2026-03-12 18:04:00

接口描述

1、分页查询频道抽奖统计记录
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/lottery/activity-record/list

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥】
timestamp true Long 当前13位毫秒级时间戳，3分钟内有效
sign true String 签名，为32位大写的MD5值,<code style="color:red">生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据</code>【详见签名生成规则】
channelId true Integer 频道号
sessionId false String 场次ID
startTimeBegin false Long 开始时间-起始范围，13位毫秒级时间戳
startTimeEnd false Long 开始时间-结束范围，13位毫秒级时间戳
lotteryId false String 抽奖活动ID
pageNumber false Integer 分页页码
pageSize false Integer 分页大小

示例

http://api.polyv.net/live/v4/channel/lottery/activity-record/list?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&channelId=5765904&pageNumber=1

响应描述

参数名 类型 说明
code Integer 状态码，与 http 状态码相同，用于确定基本的响应状态
status String 响应结果，由业务决定，成功返回success，失败返回error
success Boolean 是否成功响应
requestId String 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error Object 状态码非200时的错误信息【详见Error字段描述】
data Object 响应详细信息【详见data字段说明】

Error响应描述

参数名 类型 说明
code Integer 错误代码，用于确定具体的错误原因
desc String 错误描述，与 error.code 对应

data响应描述

参数名 类型 说明
pageNumber Integer 分页页码
pageSize Integer 分页大小
totalPages Integer 总页数
totalItems Long 总记录数
contents Array 抽奖活动统计列表信息【详见contents字段说明】

Contents响应描述

参数名 类型 说明
lotteryId String 抽奖ID
userId String 用户ID
channelId Integer 频道ID
lotteryCondition String 参与条件，none:无条件, invite:邀请好友, duration:观看时长, question:答题, questionnaire:问卷
inviteType String 邀请方式，poster:邀请海报，external:外部邀请
status String 抽奖状态，wait:未开始，start:进行中，finish:已结束，cancel:已取消，lottery:抽奖中
createTime Long 创建时间，13位毫秒级时间戳
updateTime Long 修改时间，13位毫秒级时间戳
startTime Long 开始抽奖时间，13位毫秒级时间戳
endTime Long 结束抽奖时间，13位毫秒级时间戳
lotteryMode String 抽奖模式，wait:定时，immediate:即时，task:任务
sessionId String 场次id
activityName String 活动名称
subLotteryList Array 子抽奖统计列表【详见SubLotteryList字段说明】

SubLotteryList响应描述

参数名 类型 说明
lotteryId String 子抽奖ID
masterLotteryId String 主抽奖ID
sort Integer 排序
status String 子抽奖状态，wait:未开始，lottery:抽奖中
channelId Integer 频道号
userId String 账号userId
sessionId String 抽奖时的直播场次ID
lotteryRange String 抽奖候选人范围，notWinning:未中奖
actor String 按头衔抽奖时的头衔名称
prize String 奖品名称
amount Integer 中奖人数（预设）
preset String 预设中奖者，以英文逗号隔开
ext String json 格式的字符串，表示抽奖的额外拓展信息
winnerCount Integer 实际中奖人数
totalUsers Integer 参与抽奖的人数
createdTime Long 抽奖时间，13位毫秒级时间戳
lotteryExt Object 抽奖的额外拓展信息【详见LotteryExt字段说明】

LotteryExt响应描述

参数名 类型 说明
collectInfo Array 中奖用户领奖收集信息列表【详见CollectInfo字段说明】

CollectInfo响应描述

参数名 类型 说明
type String 类型，userName:姓名、userPhone:手机号、custom:自定义
field String 字段名
tips String 提示语
required Boolean 是否必填，true/false

Java请求示例

快速接入基础代码请<span style="color:red">下载相关依赖源码</span>， <a href="/third_res/util.zip" target="_blank">点击下载源代码</a> ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。 > 强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelLotteryTest.class);
/**
 * 分页查询频道抽奖活动统计记录
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testPageLotteryActivityRecord() throws IOException, NoSuchAlgorithmException {
    // 公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());

    // 业务参数
    String url = "http://api.polyv.net/live/v4/channel/lottery/activity-record/list";
    Integer channelId = 5765904;
    Integer pageNumber = 1;

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", String.valueOf(channelId));
    requestMap.put("pageNumber", String.valueOf(pageNumber));
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);
    log.info("测试分页查询频道抽奖活动统计记录，返回值：{}", response);
    // do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "48978442-c4a8-4e6d-a08e-cf3fdf6f2c1b",
    "data": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalPages": 2,
        "totalItems": 11,
        "contents": [
            {
                "lotteryId": "h6udiwy1nj",
                "userId": "2b3ccac944",
                "channelId": 5765904,
                "lotteryCondition": "questionnaire",
                "inviteType": null,
                "status": "cancel",
                "createTime": 1745826290000,
                "updateTime": 1745828914000,
                "startTime": 1745996400000,
                "endTime": 1745996460000,
                "lotteryMode": "wait",
                "sessionId": "",
                "activityName": "问卷抽奖",
                "subLotteryList": [
                    {
                        "lotteryId": "h6udixblav",
                        "masterLotteryId": "h6udiwy1nj",
                        "sort": 0,
                        "status": "wait",
                        "channelId": 5765904,
                        "userId": "2b3ccac944",
                        "sessionId": "",
                        "lotteryRange": "notWinning",
                        "actor": null,
                        "prize": "团购券100元",
                        "amount": 1,
                        "preset": "",
                        "ext": "{\"collectInfo\":[{\"type\":\"userName\",\"field\":\"姓名\",\"tips\":\"请输入您的名称\",\"required\":true},{\"type\":\"userPhone\",\"field\":\"手机\",\"tips\":\"请输入您的手机号码\",\"required\":true}]}",
                        "winnerCount": 0,
                        "totalUsers": 0,
                        "createdTime": 1745826290000,
                        "lotteryExt": {
                            "collectInfo": [
                                {
                                    "field": "姓名",
                                    "tips": "请输入您的名称",
                                    "type": "userName",
                                    "required": true
                                },
                                {
                                    "field": "手机",
                                    "tips": "请输入您的手机号码",
                                    "type": "userPhone",
                                    "required": true
                                }
                            ]
                        }
                    },
                    {
                        "lotteryId": "h6udixerdd",
                        "masterLotteryId": "h6udiwy1nj",
                        "sort": 1,
                        "status": "wait",
                        "channelId": 5765904,
                        "userId": "2b3ccac944",
                        "sessionId": "",
                        "lotteryRange": "notWinning",
                        "actor": null,
                        "prize": "团购券50元",
                        "amount": 2,
                        "preset": "",
                        "ext": "{\"collectInfo\":[{\"type\":\"userName\",\"field\":\"姓名\",\"tips\":\"请输入您的名称\",\"required\":true},{\"type\":\"userPhone\",\"field\":\"手机\",\"tips\":\"请输入您的手机号码\",\"required\":true}]}",
                        "winnerCount": 0,
                        "totalUsers": 0,
                        "createdTime": 1745826290000,
                        "lotteryExt": {
                            "collectInfo": [
                                {
                                    "field": "姓名",
                                    "tips": "请输入您的名称",
                                    "type": "userName",
                                    "required": true
                                },
                                {
                                    "field": "手机",
                                    "tips": "请输入您的手机号码",
                                    "type": "userPhone",
                                    "required": true
                                }
                            ]
                        }
                    }
                ]
            },
            {
                "lotteryId": "h6qw06qmx8",
                "userId": "2b3ccac944",
                "channelId": 5765904,
                "lotteryCondition": "none",
                "inviteType": null,
                "status": "finish",
                "createTime": 1745553059000,
                "updateTime": 1745553640000,
                "startTime": 1745553600000,
                "endTime": 1745553630000,
                "lotteryMode": "task",
                "sessionId": "",
                "activityName": "抽奖",
                "subLotteryList": [
                    {
                        "lotteryId": "h6qw06qmx8",
                        "masterLotteryId": "h6qw06qmx8",
                        "sort": 0,
                        "status": "wait",
                        "channelId": 5765904,
                        "userId": "2b3ccac944",
                        "sessionId": "h6que674kh",
                        "lotteryRange": "notWinning",
                        "actor": null,
                        "prize": "苹果",
                        "amount": 1,
                        "preset": "",
                        "ext": "{\"collectInfo\":[{\"field\":\"姓名\",\"tips\":\"请输入您的名称\",\"type\":\"userName\",\"required\":true},{\"field\":\"手机\",\"tips\":\"请输入您的手机号码\",\"type\":\"userPhone\",\"required\":true}]}",
                        "winnerCount": 0,
                        "totalUsers": 0,
                        "createdTime": 1745553600000,
                        "lotteryExt": {
                            "collectInfo": [
                                {
                                    "field": "姓名",
                                    "tips": "请输入您的名称",
                                    "type": "userName",
                                    "required": true
                                },
                                {
                                    "field": "手机",
                                    "tips": "请输入您的手机号码",
                                    "type": "userPhone",
                                    "required": true
                                }
                            ]
                        }
                    }
                ]
            }
        ]
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
联系客服，在线咨询