查詢優惠券領取列表

更新時間：2025-06-10 11:15:38

介面描述

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

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
pageNumber	false	Integer	頁數預設為1
pageSize	false	Integer	每頁顯示的資料筆數，預設每頁顯示10筆資料，最大值不能超過1000
couponId	true	String	優惠券ID
keyword	false	String	搜尋關鍵字，精準比對觀眾ID、模糊比對觀眾暱稱
receiveSource	false	String	領取管道: CHANNEL-頻道，AGGREGATE_PAGE-聚合頁

請求體參數描述

參數名	必選	類型	說明

範例

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

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
success	Boolean	回應結果，由業務決定，成功回傳true，失敗回傳false
data	Object	標籤資料【[Data欄位說明](#Data 參數描述)】
error	Object	狀態碼非200時的錯誤資訊【詳見Error欄位說明】
requestId	String	請求ID，每次請求產生的唯一 UUID，僅可用於排查、除錯，不應該和業務掛上鉤

Data參數描述

參數名	類型	說明
pageNumber	Integer	目前頁碼
pageSize	Integer	每頁資料量
totalPages	Long	頁面總數
totalItems	Long	總資料量
contents	Array	目前頁內容【詳見contents欄位說明】

Contents參數描述

參數名	類型	說明
viewerId	String	觀眾ID
nickname	String	觀眾暱稱
mobile	String	手機號碼
avatar	String	頭像
receiveSource	String	領取管道: CHANNEL-頻道，AGGREGATE_PAGE-聚合頁
receiveTime	Long	領取時間

Error參數描述

參數名	類型	說明
code	Integer	錯誤代碼，用於確定具體的錯誤原因
desc	String	錯誤描述，與 error.code 對應

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-viewer";
    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": [
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783281000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783276000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783249000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783245000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783186000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            },
            {
                "avatar": "https://thirdwx.qlogo.cn/mmopen/vi_32/PiajxSqBRaELlKKV0RvTkVhIjE0eyEKFQaq4gf4AhSCabAtRGTRQicldH2QsCaRO1ia4eyENTyy5lTAvMT860tAwCqmQMlmV7shxC6XzXY0enoSHlTNSxp7lQ/132",
                "mobile": "18726253553",
                "nickname": "深圳观众/31877",
                "receiveSource": "CHANNEL",
                "receiveTime": 1746783185000,
                "viewerId": "0_257yiy7m54enkijsu6p6vacmfg8qkiya"
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 6,
        "totalPages": 1
    },
    "requestId": "bbcbf92c-e5ca-487a-adc3-eb184f1b3b6c",
    "status": "success",
    "success": true
}

異常範例

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