Query Channel Muted User ID/IP

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

API Description

1、通过频道号，查询禁言的用户列表或者ip列表
2、接口支持https协议

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameters

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 your own server to relay requests to the POLYV server for response data.` See signature generation rules
channelId	true	String	Channel ID
type	true	String	Mute type ip : Query muted IPs userId : Query muted user IDs
toGetSubRooms	false	Integer	Whether to retrieve sub-channels 0: Do not retrieve 1: Retrieve

Example

http://api.polyv.net/live/v3/channel/chat/get-banned-list?appId=frlr1zazn3&sign=7B8623E1350809B9C57E337C846B5608&type=userId&channelId=2191569&timestamp=1616640271103&toGetSubRooms=1

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	Empty on failure; on success, an array of IPs or user IDs

Java Request Example

For quick integration of basic code, 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);

/**
 * 查询频道禁言用户Userid/IP
 * @throws IOException
 */
@Test
public void testGetChannelBannedUserList() 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/channel/chat/get-banned-list";
        String channelId = "2191569";
        String type = "userId";//ip,userId
        String toGetSubRooms = "1";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("channelId",channelId);
        requestMap.put("type",type);
        requestMap.put("toGetSubRooms",toGetSubRooms);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.get(url, requestMap);
        log.info("测试查询频道禁言用户Userid/IP接口返回值：{}",response);

}

Response Example

For global error descriptions, see Global Error Description

Success Example

When type is "userId", returns an array of muted user IDs

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    "ovtl9t_RxnrTdqkXqkT5Q5lnxp2A"
  ]
}

When type is "ip", returns an array of muted IPs

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": [
    "59.41.20.74"
  ]
}

Error Example

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

Live Streaming Server API