Mute/Unmute User

Updated: 2023-01-12 15:50:24

Interface Description

1、通过登录聊天室的userId，禁言或者解禁用户
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v3/channel/chat/banned-user

Online API Call

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls are subject to 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 never be stored on the client side for direct use. All APIs must be relayed through the customer's own server to call the POLYV server for response data.` See details on signature generation rules
channelId	true	String	Channel ID
userIds	true	String	Chat room user IDs (not live account IDs). Separate multiple users with half-width commas ",".
toBanned	false	String	Y indicates mute, N indicates unmute

Example

http://api.polyv.net/live/v3/channel/chat/banned-user

Form Parameters:

appId=frlr1zazn3&userIds=ovtl9t_RxnrTdqkXqkT5Q5lnxp2A&sign=19E2B706E637BDDD0AC6865DA8E1FF8E&channelId=2191569&timestamp=1621843261592&toBanned=Y

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See details on global error descriptions
status	String	Response status text
message	String	Response description message, assists in describing error reasons when code is 400 or 500
data	String	Returns "SUCCESS" on success, returns empty string on error

Java Request Example

For quick integration of basic code, 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 testUpdateBannedUser() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String url = "https://api.polyv.net/live/v3/channel/chat/banned-user";
        String channelId = "2191569";
        String userIds = "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A";
        String toBanned = "Y";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("userIds",userIds);
        requestMap.put("toBanned",toBanned);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试禁言/解禁用户接口返回值：{}",response);

}

Response Example

See Global Error Descriptions for system-wide error descriptions.

Success Example

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": "SUCCESS"
}

Error Example

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

Live Streaming Server API