查詢頻道禁言使用者Userid/IP

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

介面描述

1、通过频道号，查询禁言的用户列表或者ip列表
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`生成簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
channelId	true	String	頻道號
type	true	String	禁言類型 ip ：查詢禁言IP userId ：查詢禁言使用者Id
toGetSubRooms	false	Integer	是否取得子頻道 0：不取得 1：取得

範例

http://api.polyv.net/live/v3/channel/chat/get-banned-list?appId=frlr1zazn3&sign=7B8623E1350809B9C57E337C846B5608&type=userId&channelId=2191569&timestamp=1616640271103&toGetSubRooms=1

回應參數描述

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

Java請求範例

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

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

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

/**
 * 查询频道禁言用户Userid/IP
 * @throws IOException
 */
@Test
public void testGetChannelBannedUserList() 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/channel/chat/get-banned-list";
        String channelId = "2191569";
        String type = "userId";//ip,userId
        String toGetSubRooms = "1";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("type",type);
        requestMap.put("toGetSubRooms",toGetSubRooms);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道禁言用户Userid/IP接口返回值：{}",response);

}

回應範例

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

成功範例

1、當type為"userId"時，返回禁言userId陣列

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A"
  ]
}

2、當type為"ip"時，返回禁言ip陣列

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    "59.41.20.74"
  ]
}

異常範例

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