查詢頻道白名單

更新時間：2022-09-02 18:08:07

介面描述

1、获取全局或频道的观看条件白名单列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/auth/get-white-list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
rank	true	Integer	1為首要條件，2為次要條件
channelId	false	String	頻道號，不傳為取得全域設定
page	false	Integer	要取得的頁碼，預設為1
pageSize	false	Integer	每頁資料量，預設為10
keyword	false	String	關鍵詞，可根據會員碼和名稱查詢

範例

https://api.polyv.net/live/v3/channel/auth/get-white-list?appId=frlr1zazn3&sign=5935F7E2423B2AF9E0E8FE59D54D5ACC&rank=1&channelId=1965681&timestamp=1621843843501

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	分頁的白名單列表資料【詳見data欄位說明】

data欄位說明

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

contents欄位說明

參數名	類型	說明
name	String	暱稱(或備註)
phone	String	會員碼

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 查询频道白名单
 * @throws IOException
 */
@Test
public void testGetWhiteList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "1965681";
    String url = "https://api.polyv.net/live/v3/channel/auth/get-white-list";
    String rank = "1";
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("rank",rank);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询频道白名单接口返回值：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageNumber": 1,
        "totalPages": 1,
        "pageSize": 10,
        "contents": [{
            "phone": "123rock",
            "name": "rock"
        }, {
            "phone": "会员码123",
            "name": "昵称123"
        }, {
            "phone": "a1",
            "name": "sadboy1"
        }, {
            "phone": "a2",
            "name": "sadboy2"
        }, {
            "phone": "a3",
            "name": "sadboy3"
        }, {
            "phone": "a4",
            "name": "sadboy4"
        }, {
            "phone": "a5",
            "name": "sadboy5"
        }, {
            "phone": "a6",
            "name": "sadboy6"
        }, {
            "phone": "a7",
            "name": "sadboy7"
        }]
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}