查询频道已上传文档列表

接口描述

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

接口URL

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

在线API调用

请求方式

GET

接口约束

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

2、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

响应参数描述

Data参数描述

Contents参数描述

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