查詢優惠券列表

介面描述

1、查询优惠券列表
2、接口支持https协议

介面URL

https://api.polyv.net/live/v4/user/coupon/search

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

請求體參數描述

範例

https://api.polyv.net/live/v4/user/coupon/search?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&pageNumber=1&pageSize=10

回應參數描述

Data參數描述

Contents參數描述

UserCouponRule

Unconditional

FullReduce

Error參數描述

Java請求範例

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

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

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询优惠券列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void listCouponTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/coupon/search";
    Integer pageNumber = 1;
    Integer pageSize = 10;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, null);
    
    log.info("测试查询主播列表结果：{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "data": {
        "contents": [
            {
                "availableAmount": 999,
                "couponId": "caqfi6rqutunvofor5jrqbinswh14p2g",
                "dayOfUse": 30,
                "name": "优惠券2号",
                "receiveEndTime": 1756102919000,
                "receiveStartTime": 1748326919000,
                "receivedAmount": 0,
                "rule": {
                    "condition": "UNCONDITIONAL",
                    "limitPerPerson": -1,
                    "unconditional": {
                        "enable": true,
                        "unit": "MONEY",
                        "value": 1.0
                    }
                },
                "status": "GOING",
                "useEndTime": 1756102919000,
                "useStartTime": 1748326919000,
                "useTimeType": "RANGE"
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 1,
        "totalPages": 1
    },
    "requestId": "d7567a16-86f0-4a7c-a8bd-6f140a2a46f4",
    "status": "success",
    "success": true
}

異常範例

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