查询频道已上传文档列表

接口描述

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

接口URL

http://api.polyv.net/live/v3/channel/document/doc-list

在线API调用

请求方式

GET

接口约束

1、接口调用有频率限制，详细请查看

2、channelId和teacherId不能同时为空，若同时传入且开启了“讲义库”功能，则优先用teacherId

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值【详见签名生成规则】
channelId	false	String	频道号，若开启了“讲义库”功能，则查询该频道对应的讲师所关联的讲义库文档
status	false	String	文档状态，默认不传查询所有 normal：正常 waitUpload：等待上传 failUpload：上传失败 waitConvert：转换PPT中 failConvert：转换PPT失败
page	false	Integer	第几页，默认不传显示第一页
limit	false	Integer	每页显示几条数据，默认不传显示10条
isShowUrl	false	String	是否展示文档原文件地址，默认不传不展示 Y：是 N：否
teacherId	false	String	讲师ID，若开启了“讲义库”功能，则查询讲师关联的讲义库文档，channelId和teacherId不能同时为空，若同时传入且开启了“讲义库”功能，则优先用teacherId

示例

http://api.polyv.net/live/v3/channel/document/doc-list?isShowUrl=Y&appId=frlr1zazn3&limit=10&sign=8C73385047B8BADAE8DEB52318220A7E&page=1&channelId=1965681&timestamp=1621842982462&status=normal

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
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：转动画效果
type	String	类型，区分旧版PPT还是新版PPT 新版值为：new 旧版值为：old
previewImage	String	ppt预览小图地址
previewBigImage	String	ppt预览大图地址
autoId	Integer	文档ID
teacherId	String	讲师ID

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(ChannelDocTest.class);
/**
 * 查询频道已上传文档列表
 * @throws IOException
 */
@Test
public void testGetDocList() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/document/doc-list";
    String channelId = "1965681";
    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("channelId",channelId);
    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);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "pageSize":10,
        "pageNumber":1,
        "totalItems":4,
        "contents":[
            {
                "autoId":1597852,
                "fileId":"5e74996c4f248ef2faa2f8fde168f1bf1965681common",
                "fileName":"直播指南1",
                "fileUrl":"http://doc-2.polyv.net/sources/20210114/5e74996c4f248ef2faa2f8fde168f1bf1965681common.pptx",
                "fileType":".pptx",
                "totalPage":19,
                "channelId":"1965681",
                "status":"normal",
                "createTime":1610616141000,
                "convertType":"common",
                "type":"new",
                "previewImage":"http://doc-2.polyv.net/images/2021/01/5e74996c4f248ef2faa2f8fde168f1bf1965681common/5e74996c4f248ef2faa2f8fde168f1bf1965681common_0000_s.jpeg",
                "previewBigImage":"http://doc-2.polyv.net/images/2021/01/5e74996c4f248ef2faa2f8fde168f1bf1965681common/5e74996c4f248ef2faa2f8fde168f1bf1965681common_0000.jpeg"
            },
            {
                "autoId":1504367,
                "fileId":"471bee13c7555deb16f44aad783a2aeb1965681common",
                "fileName":"直播指南2",
                "fileUrl":"http://doc-2.polyv.net/sources/20201106/471bee13c7555deb16f44aad783a2aeb1965681common.pptx",
                "fileType":".pptx",
                "totalPage":18,
                "channelId":"1965681",
                "status":"normal",
                "createTime":1604633378000,
                "convertType":"common",
                "type":"new",
                "previewImage":"http://doc-2.polyv.net/images/2020/11/471bee13c7555deb16f44aad783a2aeb1965681common/471bee13c7555deb16f44aad783a2aeb1965681common_0000_s.jpeg",
                "previewBigImage":"http://doc-2.polyv.net/images/2020/11/471bee13c7555deb16f44aad783a2aeb1965681common/471bee13c7555deb16f44aad783a2aeb1965681common_0000.jpeg"
            },
            {
                "autoId":1485063,
                "fileId":"6e0603f6c8ec6113b87f69a7191d22021965681common",
                "fileName":"培训课程表.docx",
                "fileUrl":"http://doc-2.polyv.net/sources/20201020/6e0603f6c8ec6113b87f69a7191d22021965681common.docx",
                "fileType":".docx",
                "totalPage":1,
                "channelId":"1965681",
                "status":"normal",
                "createTime":1603182016000,
                "convertType":"common",
                "type":"new",
                "previewImage":"http://doc-2.polyv.net/images/2020/10/6e0603f6c8ec6113b87f69a7191d22021965681common/6e0603f6c8ec6113b87f69a7191d22021965681common_0000_s.jpeg",
                "previewBigImage":"http://doc-2.polyv.net/images/2020/10/6e0603f6c8ec6113b87f69a7191d22021965681common/6e0603f6c8ec6113b87f69a7191d22021965681common_0000.jpeg"
            },
            {
                "autoId":1484687,
                "fileId":"c2d585857870f4eff024976e3a265c0b1965681common",
                "fileName":"课程表.docx",
                "fileUrl":"http://doc-2.polyv.net/sources/20201020/c2d585857870f4eff024976e3a265c0b1965681common.docx",
                "fileType":".docx",
                "totalPage":1,
                "channelId":"1965681",
                "status":"normal",
                "createTime":1603163842000,
                "convertType":"common",
                "type":"new",
                "previewImage":"http://doc-2.polyv.net/images/2020/10/c2d585857870f4eff024976e3a265c0b1965681common/c2d585857870f4eff024976e3a265c0b1965681common_0000_s.jpeg",
                "previewBigImage":"http://doc-2.polyv.net/images/2020/10/c2d585857870f4eff024976e3a265c0b1965681common/c2d585857870f4eff024976e3a265c0b1965681common_0000.jpeg"
            }
        ],
        "startRow":1,
        "firstPage":true,
        "lastPage":true,
        "prePageNumber":1,
        "limit":4,
        "offset":0,
        "totalPages":1,
        "endRow":4,
        "nextPageNumber":1
    }
}

异常示例

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