Delete Account Banned Words

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

Interface Description

1、删除账号通用设置的严禁词，支持批量删除多个严禁词
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/user/badword/delete

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See details in Get Secret Key]
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. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` [See details in Signature Generation Rules]
words	true	String	Banned words to delete, separated by commas ",". Example: "bannedword1,bannedword2"

Example

http://api.polyv.net/live/v3/user/badword/delete

Form Parameters:

appId=frlr1zazn3&words=账号严禁词1&sign=7B4044084E8DBCE8A38AD1DC206556F1&timestamp=1616639778424

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure [See details in Global Error Description]
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides auxiliary error reason description
data	Array	Empty on request failure. On success, an array of remaining banned words after deletion

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 code project. 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 functionality 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 testDeleteUserBadword() 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/user/badword/delete";
        String words = "账号严禁词1";

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

}

Response Example

For system global error descriptions, see Global Error Description

Success Example

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

Error Example

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

Live Streaming Server API