查询课节已上传文档列表

接口描述

1、获取课节文档列表
2、接口支持https协议

接口URL

http://api.polyv.net/hi-class-api/open/file/v1/doc-list

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
lessonId	true	Long	课节号
status	false	String	文档状态，默认不传查询所有 normal：正常 waitUpload：等待上传 failUpload：上传失败 waitConvert：转换PPT中 failConvert：转换PPT失败
page	false	Integer	第几页，默认不传显示第一页
limit	false	Integer	每页显示几条数据，默认不传显示10条
isShowUrl	false	String	是否展示文档原文件地址，默认不传不展示 Y：是 N：否

示例

http://api.polyv.net/hi-class-api/open/file/v1/doc-list?isShowUrl=Y&appId=z2gw5icesv&limit=10&sign=935F4C0CF3EB84A3EFB2BC691DB714A5&page=1&lessonId=6707&timestamp=1631780657591&status=normal

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
error	Error	错误对象【详见全局错误说明】
data	Object	请求成功时为已上传文档的有关信息【详见Data参数描述】，请求失败时为空

Data参数描述

参数名	类型	说明
pageSize	Integer	每页数据大小，默认10，最大值1000
pageNumber	Integer	当前的页数
totalItems	Integer	总的条数
contents	Array	查询的结果列表【详见Contents参数描述】
startRow	Integer	当前页第一条记录在总结果集中的位置
firstPage	Boolean	是否为第一页，值为：true/false
lastPage	Boolean	是否为最后一页，值为：true/false
prePageNumber	Integer	上一页编号
nextPageNumber	Integer	下一页编号
limit	Integer	每页数量大小
totalPages	Integer	总页数
endRow	Integer	当前页最后一条记录在总结果集中的位置
offset	Integer	分页起始记录

Contents参数描述

参数名	类型	说明
fileId	String	文件ID
fileName	String	文件名
fileUrl	String	文件url
fileType	String	文件类型
totalPage	Integer	上传文档的内容的总页数
channelId	String	频道号
status	String	文档状态，不传默认查询所有 normal：正常 waitUpload：等待上传 failUpload：上传失败 waitConvert：转换PPT中 failConvert：转换PPT失败
createTime	Long	创建时间，13位毫秒级时间戳
convertType	String	转换类型，默认不传转普通，因为只有ppt，pptx可以转动画，其他类型文件会自动转成普通；文件转动画转失败会直接把类型转为普通 common：转普通图片 animate：转动画效果
previewImage	String	ppt预览小图地址
previewBigImage	String	ppt预览大图地址
autoId	Integer	文档ID

Java请求示例

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

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

/**
 * 查询课节已上传文档列表
 * @throws IOException
 */
@Test
public void testGetDocList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = this.appId;
    String appSecret = this.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/file/v1/doc-list";
    String lessonId = "7190";
    String status = "normal";
    String limit = "5";
    String page = "1";
    String isShowUrl = "Y";

    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("lessonId", lessonId);
    requestMap.put("status", status);
    requestMap.put("limit", limit);
    requestMap.put("page", page);
    requestMap.put("isShowUrl", isShowUrl);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询课节已上传文档列表：{}", response);
}

响应示例

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

成功示例

{
    "code": 200,
    "status": "success",
    "data": {
        "pageSize": 10,
        "pageNumber": 1,
        "totalItems": 1,
        "contents": [{
            "autoId": 2369343,
            "fileId": "42ba92e56017f4de261e692630447b662561988animate",
            "fileName": "test3.ppt",
            "fileUrl": "http://doc-2.polyv.net/sources/20210916/42ba92e56017f4de261e692630447b662561988animate.ppt",
            "fileType": ".ppt",
            "totalPage": 1,
            "channelId": "2561988",
            "status": "normal",
            "createTime": 1631950890000,
            "convertType": "common",
            "previewImage": "http://doc-2.polyv.net/images/2021/09/42ba92e56017f4de261e692630447b662561988animate/42ba92e56017f4de261e692630447b662561988animate_0000_s.jpeg",
            "previewBigImage": "http://doc-2.polyv.net/images/2021/09/42ba92e56017f4de261e692630447b662561988animate/42ba92e56017f4de261e692630447b662561988animate_0000.jpeg"
        }],
        "limit": 1,
        "totalPages": 1,
        "startRow": 1,
        "endRow": 1,
        "firstPage": true,
        "lastPage": true,
        "nextPageNumber": 1,
        "prePageNumber": 1,
        "offset": 0
    },
    "success": true
}

异常示例

{
  "code": 400,
  "status": "error",
  "data": "",
  "error": {
    "code": xx,
    "desc": "错误描述"
  }
}