Batch Import Forbidden Words

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

API Description

1、批量导入频道或者通用的严禁词
2、接口支持https协议
3、接口URL中的{userId}为"直播账号ID"

API URL

http://api.polyv.net/live/v2/chat/{userId}/addBadWords

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details

Request Parameters 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 never be saved 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 and obtain response data.` See signature generation rules
words	true	String[]	Forbidden words in JSON array format, e.g., ["forbiddenWords1","forbiddenWords2"] If forbidden words contain special characters, they need to be encoded first. Example: ["&#@"] should be encoded as ["%26%23%40"]
channelId	false	String	Channel ID, optional. If not submitted or set to -1, the forbidden words apply at the account level and take effect for all channels under that account.

Example

http://api.polyv.net/live/v2/chat/1b448be323/addBadWords

Form Parameters:

appId=frlr1zazn3&words=["严禁词1","严禁词2"]&sign=8B10AC4F3379994635A0188730049A9C&channelId=2191569&timestamp=1616638938499

Response Parameters 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 auxiliary error description.
data	Object	Response result. See data field description

Data Field Description

Parameter	Type	Description
userId	String	Live streaming account ID
count	String	Number of forbidden words for this channel. If modifying all channels, count is the total number of forbidden words for the account.

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the 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);
/**
 * 批量导入严禁词
 * @throws IOException
 */
@Test
public void testAddBadWords() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "http://api.polyv.net/live/v2/chat/"+userId+"/addBadWords";
        String words = "[\"严禁词1\",\"严禁词2\"]";
        String channelId = "2191569";

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

}

Response Example

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

Success Example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "userId": "1b448be323",
    "count": 2
  }
}

Error Example

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

Live Streaming Server API