查詢帳號禁言列表

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

介面描述

1、通过账号下的禁言列表
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/user/chat/banned-user/list

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值,`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
page	false	Integer	分頁頁碼，預設1
size	false	Integer	分頁大小，預設10，最大1000

範例

http://api.polyv.net/live/v3/user/chat/banned-user/list?appId=fso8gzbxlr&timestamp=1621675923000&page=1&size=10&sign=88929522E99A082046519B7CF264D76C

回應參數描述

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

data欄位說明

參數名	類型	說明
pageNumber	Integer	當前頁碼
pageSize	Integer	分頁記錄數
totalItems	Integer	總頁數
contents	Array	禁言使用者ID列表

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(ChatBannedTest.class);

/**
 * 查询账号禁言列表
 * @throws IOException
 */
@Test
public void testUserBannedList() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v3/user/chat/banned-user/list";
        String page = String.valueOf(1);
        String size = String.valueOf(10);
    
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("page",page);
        requestMap.put("size",size);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("查询账号禁言列表接口返回值：{}",response);

}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 2,
        "totalItems": 13,
        "contents": [
            "bannedVierId9",
            "bannedVierId12",
            "bannedViwerId11,bannedViwerId12"
        ]
    }
}

異常範例

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