主播列表

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
pageNumber	false	Integer	页数默认为1
pageSize	false	Integer	每页显示的数据条数，默认每页显示10条数据，最大值不能超过1000
status	false	Integer	状态: 0-禁用, 1-启用
sex	false	String	性别，M-男，W-女
nickname	false	String	昵称，支持模糊搜索
startTime	false	Long	场次开播起始时间，13位毫秒级时间戳，起始-结束时间范围最大365天
endTime	false	Long	场次开播结束时间，13位毫秒级时间戳，起始-结束时间范围最大365天

请求体参数描述

示例

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

请求体json参数：

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	响应结果，由业务决定，成功返回true，失败返回false
data	Object	标签数据 【[Data字段说明](#Data 参数描述)】
error	Object	状态码非200时的错误信息【详见Error字段说明】
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩

Data参数描述

参数名	类型	说明
pageNumber	Integer	当前页码
pageSize	Integer	每页数据量
totalPages	Long	页面总数
totalItems	Long	总数据量
contents	Array	当前页内容【详见contents字段说明】

Contents参数描述

参数名	类型	说明
anchorId	Long	主播ID
nickname	String	昵称
sex	String	性别: M-男，W-女
avatar	String	头像
status	Integer	0-禁用, 1-启用
channelCount	Integer	关联频道数
sessionCount	Integer	开播场次数
watchDuration	Integer	观看累计时长(分钟)

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

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
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "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
}

异常示例

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