查詢頻道踢人列表

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

介面描述

1、通过频道号，查询踢人列表
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

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

範例

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

表單參數：

appId=frlr1zazn3&sign=815A35BC0A4666E4BC14FB04A8C55D82&channelId=2191569&timestamp=1616640471944

回應參數描述

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

data欄位說明

參數名	類型	說明
banned	Boolean	是否禁言
channelId	String	頻道號
clientIp	String	使用者IP
nick	String	暱稱
param4	String	自訂參數param4
pic	String	頭像圖片位址
roomId	String	房間號
uid	String	聊天室socketid
userId	String	使用者userId
userType	String	使用者身份 manager：管理員 teacher：講師 assistant：助教 guest：嘉賓 viewer：參與者 slice/student：觀看者

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 testGetChannelKickedUserList() 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/list-kicked";
        String channelId = "2191569";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试查询频道踢人列表接口返回值：{}",response);

}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    {
      "banned": true,
      "channelId": "2191569",
      "clientIp": "59.41.20.74",
      "nick": "卉",
      "param4": "oi_ubswUnFt8QQFAAEJbKmd8W9BE",
      "pic": "https://thirdwx.qlogo.cn/mmopen/vi_32/3lMXVJoLMLJibnkFuA23lyqj5MOQufhW5ATvHuB8byssutficHKU0u7OMx5OQgg9WNVuHf44AXfbAMMAZejuYFTg/132",
      "roomId": "2191569",
      "uid": "xw5hNBg77lGOcx5fADoX",
      "userId": "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A",
      "userType": "slice"
    }
  ]
}

異常範例

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