保利威文档中心

幫助中心

分頁查詢頻道抽獎統計記錄

更新時間: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
}
联系客服,在线咨询