Query Account Mute List

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

API Description

1、通过账号下的禁言列表
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId See Get Secret Key
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 saved or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server and retrieve response data.` See Signature Generation Rules
page	false	Integer	Page number, default is 1
size	false	Integer	Page size, default is 10, maximum is 1000

Example

http://api.polyv.net/live/v3/user/chat/banned-user/list?appId=fso8gzbxlr&timestamp=1621675923000&page=1&size=10&sign=88929522E99A082046519B7CF264D76C

Response Parameters

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	Mute data See data field description

data Field Description

Parameter	Type	Description
pageNumber	Integer	Current page number
pageSize	Integer	Records per page
totalItems	Integer	Total pages
contents	Array	List of muted user IDs

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

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

/**
 * 查询账号禁言列表
 * @throws IOException
 */
@Test
public void testUserBannedList() 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/chat/banned-user/list";
        String page = String.valueOf(1);
        String size = String.valueOf(10);
    
        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("page",page);
        requestMap.put("size",size);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("查询账号禁言列表接口返回值：{}",response);

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "pageSize": 10,
        "pageNumber": 2,
        "totalItems": 13,
        "contents": [
            "bannedVierId9",
            "bannedVierId12",
            "bannedViwerId11,bannedViwerId12"
        ]
    }
}

Error Example

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

Live Streaming Server API