Anchor List

Interface Description

1、查询主播列表
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v4/channel/anchor/list

Online API Call

Request Method

GET

Interface Constraints

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

Request Parameter Description

Request Body Parameter Description

Example

https://api.polyv.net/live/v4/channel/anchor/list?appId=frlr1zazn3&sign=012332FBD8DBCFC068AFCB484A2ADECB&timestamp=1670550787318&pageNumber=1&pageSize=10

Request body JSON parameters:

Response Parameter Description

Data Parameter Description

Contents Parameter Description

Error Parameter Description

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 code project. The 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 integration. The Live Java SDK provides unified packaging and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

private final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 查询主播列表
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void listChannelAnchorTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/channel/anchor/list";
    Integer pageNumber = 1;
    Integer pageSize = 10;
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("pageNumber", pageNumber);
    requestMap.put("pageSize", pageSize);
    
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.get(url, null);
    
    log.info("测试查询主播列表结果：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "data": {
        "contents": [
            {
                "anchorId": 1,
                "avatar": "https://liveimages.videocc.net/uploaded/images/2024/04/gvh9eybcbb.png",
                "channelCount": 1,
                "nickname": "1号主播",
                "sessionCount": 1,
                "sex": "W",
                "watchDuration": 1,
                "status":1
            }
        ],
        "pageNumber": 1,
        "pageSize": 10,
        "totalItems": 1,
        "totalPages": 1
    },
    "requestId": "78de516b69364aeabe7d080e7228cc5c.77.16705507903976231",
    "status": "success",
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}