查詢福袋中獎者分頁列表

介面描述

1、查询指定福袋活动的中奖者分页列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v4/channel/lucky-bag/winner-page

線上API呼叫

請求方式

GET

介面限制

1、介面同時支援HTTP、HTTPS，建議使用HTTPS確保介面安全，介面呼叫有頻率限制，詳細請查看

2、若活動ID不存在或未發起則會回應400異常

請求參數描述

範例

http://api.polyv.net/live/v4/channel/lucky-bag/winner-page?appId=frlr1zazn3&timestamp=1665629374000&sign=6CFA3141718E1AF0155889EEA2988206&activityId=100001&sessionId=abc123&currentPage=1&pageSize=10

回應參數描述

Error參數描述

data參數描述

contents參數描述

prizeInfo參數描述

prizeInfo 為 JSON 字串，根據獎品類型（prizeType）不同，包含以下欄位：

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼， 點擊下載原始碼 ，下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播Java SDK完成API的功能對接，直播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(ChannelLuckyBagTest.class);
/**
 * 查询福袋中奖者分页列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetWinnerPage() 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/lucky-bag/winner-page";
    String activityId = "100001";
    String sessionId = "abc123";
    String currentPage = "1";
    String pageSize = "10";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("activityId", activityId);
    requestMap.put("sessionId", sessionId);
    requestMap.put("currentPage", currentPage);
    requestMap.put("pageSize", pageSize);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    String response = HttpUtil.get(url, requestMap);

    log.info("测试查询福袋中奖者分页列表，返回值：{}", response);
    // do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "requestId": "fc0894ce-08df-4376-92e2-fd0531cbe8ba",
    "data": {
        "contents": [
            {
                "id": 1001,
                "viewerId": "viewer001",
                "viewerNickName": "张三",
                "prizeType": "cash",
                "prizeInfo": "{\"type\":\"cash\",\"amount\":1.00}",
                "issueStatus": 0,
                "outTradeErrCode": null,
                "outTradeErrDesc": null,
                "createTime": "2026-06-01T10:30:00"
            },
            {
                "id": 1002,
                "viewerId": "viewer002",
                "viewerNickName": "李四",
                "prizeType": "custom",
                "prizeInfo": "{\"type\":\"custom\",\"name\":\"精美礼品\",\"image\":\"https://example.com/gift.png\"}",
                "issueStatus": 0,
                "outTradeErrCode": null,
                "outTradeErrDesc": null,
                "createTime": "2026-06-01T10:30:00"
            }
        ],
        "totalItems": 2,
        "totalPages": 1,
        "pageNumber": 1,
        "pageSize": 10
    },
    "success": true
}

異常範例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}