Query Channel Banned Words/Muted IPs

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

API Description

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

API URL

http://api.polyv.net/live/v3/channel/badword/list

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for 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 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 not be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID
type	false	String	Query type. Default is badword if not specified: banned words ip: muted IPs badword: banned words

Example

http://api.polyv.net/live/v3/channel/badword/list?appId=frlr1zazn3&sign=EB43DCB1C399BF954428310947EC1E56&type=badword&channelId=2191569&timestamp=1616639557043

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	Array	Empty on failure. On success, an array of banned words or muted IPs

Java Request Example

For quick integration of basic 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 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 pools.

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

/**
 * 查询频道严禁词/禁言ip
 * @throws IOException
 */
@Test
public void testGetChannelBannedList() 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/badword/list";
        String channelId = "2191569";
        String type = "badword";

        //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("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道严禁词/禁言ip接口返回值：{}",response);

}

Response Example

For global error descriptions, see Global Error Description

Success Example

When type is "badword", returns an array of banned words

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": [
        "严禁词1", 
        "严禁词2"
    ]
}

When type is "ip", returns an array of muted IPs

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

Error Example

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

Live Streaming Server API