Mute IP

Updated: 2022-09-02 18:08:07

Interface Description

1、修改聊天室禁言ip
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

Interface URL

http://api.polyv.net/live/v2/chat/{channelId}/addBannedIP

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls are subject to rate limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be stored directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See signature generation rules
ip	true	String	IP to mute

Example

http://api.polyv.net/live/v2/chat/2191569/addBannedIP

Form parameters:

appId=frlr1zazn3&ip=59.41.20.74&sign=5F1F25C7FF826D5BDEF51C277204D4D1&timestamp=1616639138641

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See global error description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Array	Empty on failure, array of currently muted IPs on success

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download source code. After downloading, add it to your own source code project. The HttpUtil.java and LiveSignUtil.java in the test cases are included in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private static final Logger log = LoggerFactory.getLogger(ChatBannedTest.class);
/**
 * 禁言IP
 * @throws IOException
 */
@Test
public void testAddBannedIP() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v2/chat/"+channelId+"/addBannedIP";
        String ip = "59.41.20.74";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("ip",ip);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试禁言IP接口返回值：{}",response);

}

Response Example

For global error descriptions, see Global Error Description

Success example

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

Error example

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

Live Streaming Server API