Delete Channel Prohibited Words/Muted IPs

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

API Description

1、取消被禁言的ip或者删除严禁词
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

API URL

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

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency 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 within 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 not be stored or used directly on the client side. 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
type	true	String	Request type ip: Unmute an IP badword: Delete prohibited words
content	true	String	The IP or prohibited word to be removed. Supports multiple IPs or prohibited words separated by commas ","

Example

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

Form Parameters:

appId=frlr1zazn3&sign=74E4B93F60CB2C1E281D24DDA2BCEC18&type=ip&content=59.41.20.74&timestamp=1616640170043

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	String	Returns "success" on success, empty string on error

Java Request Example

For quick integration of the base code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the download 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 pools.

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

/**
 * 删除频道严禁词/禁言ip
 * @throws IOException
 */
@Test
public void testDeleteChannelBanned() 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+"/delBanned";
        String type = "ip";
        String content = "59.41.20.74";

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

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API