帳號設定禁言/解除禁言用戶

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

介面描述

1、通过登录聊天室的userId，禁言或者解禁用户
2、接口支持https协议

介面URL

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

線上API呼叫

請求方式

POST

介面限制

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

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	目前13位毫秒級時間戳記，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
viewerIds	true	List	聊天室用戶ID（非直播帳號ID），json陣列格式
banned	true	String	Y表示禁言，N表示解除禁言

範例

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

表單參數：

appId: "fso8gzbxlr"
timestamp: "1621826934000"
viewerIds: ["testBanned"]
banned: "N"
sign: "BCF2949518A6C7FF4D73FA7D8836CDF8"

回應參數描述

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

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 testUpdateBannedUser() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "https://api.polyv.net/live/v3/user/chat/banned-user/update";
        List<String> viewerIds = Lists.newArrayList("test","test1");
        String banned = "Y";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("viewerIds",JSON.toJSONString(viewerIds));
        requestMap.put("banned",banned);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("账号设置禁言/解禁用户接口返回值：{}",response);

}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "SUCCESS"
}

異常範例

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