Account Settings: Mute/Unmute Users

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

API Description

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

API URL

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

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 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
viewerIds	true	List	Chat room user IDs (not live account IDs), in JSON array format
banned	true	String	Y indicates mute, N indicates unmute

Example

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

Form parameters:

appId: "fso8gzbxlr"
timestamp: "1621826934000"
viewerIds: ["testBanned"]
banned: "N"
sign: "BCF2949518A6C7FF4D73FA7D8836CDF8"

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 code 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 packaging 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 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/user/chat/banned-user/update";
        List<String> viewerIds = Lists.newArrayList("test","test1");
        String banned = "Y";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("viewerIds",JSON.toJSONString(viewerIds));
        requestMap.put("banned",banned);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("账号设置禁言/解禁用户接口返回值：{}",response);

}

Response Example

For 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