Query Account Banned Words

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

API Description

1、查询账号下通用设置的严禁词列表
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

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

Example

http://api.polyv.net/live/v3/user/badword/list?appId=frlr1zazn3&sign=F45FC551E30F37BC4E191FF0E7FA9730&timestamp=1616639418877

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 banned words on success

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 pooling.

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

/**
 * 查询账号严禁词
 * @throws IOException
 */
@Test
public void testGetUserBadWordList() 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/list";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(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": [
        "账号严禁词1", 
        "账号严禁词2", 
        "账号严禁词3"
    ]
}

Error Example

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

Live Streaming Server API