Kick Users Across All Platforms

Updated: 2024-01-09 11:09:20

API Description

1、通过登录聊天室的userId，踢出用户
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/chat/forbid/kick-users

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 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 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]

Request Body Parameter Description

Parameter	Required	Type	Description
viewerIds	true	Array	List of user IDs to kick
nickNames	true	Array	List of nicknames corresponding to the user IDs to kick, must match viewerIds one-to-one

Example

http://api.polyv.net/live/v4/chat/forbid/kick-users

Form Parameters:

appId=frlr1zazn3&sign=19E2B706E637BDDD0AC6865DA8E1FF8E&timestamp=1621843261592

Request Body JSON Parameters:

{
  "viewerIds":["20230907_2","20230907_1"],
  "nickNames":["22","11"]
}

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 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 testForbidKickUsers() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/live/v4/chat/forbid/kick-users";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp", timestamp);

        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

        String body = "{ \"viewerIds\":[\"20230907_2\",\"20230907_1\"],\"nickNames\":[\"22\",\"11\"]}";
        url = HttpUtil.appendUrl(url, requestMap);
        String response = HttpUtil.postJsonBody(url,body,null);

        log.info("测试聊天室全平台踢人接口，返回值：{}", response);
        //do somethings

}

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