查询文档列表

查询文档列表

API 地址

api.vhallyun.com/api/v2/document/lists

描述

根据当前公共参数传入app_id对应的应用,查询文档列表

场景描述:

通过该接口,将所有文档拉取,查询文档的列表信息,可用于后台管理页面,也可用于直播过程中获取文档列表的操作

入参

关于公共请求参数详细内容,请参考 公共请求参数。

参数 类型 是否必选 含义
curr_page int 否 当前页,默认为1
page_size int 否 每页大小,默认为10,最大值为1000

出参

参数 类型 是否必选 含义
total string 是 总条数
curr_page string 是 当前第几页
total_page string 是 总页数
detail string 是 列表详情,参数说明如下

detail 参数说明

参数 类型 是否必选 含义
document_id string 是 文档ID
uploader_id string 是 上传者ID
file_name string 是 文档名称
hash string 是 文档hash
ext string 是 文档扩展名
page int 是 文档总页数
size float 是 文档大小 单位为 KB
converted_page float 是 动态转换成功页数
status float 是 动态转换状态 0待转换 100转换中 200完成 500失败
converted_page_jpeg float 是 静态转换成功页数
status_jpeg float 是 静态转换状态 0待转换 100转换中 200完成 500失败
created_at string 是 文档创建时间
width int 是 文档宽度 单位 px
height int 是 文档高度 单位 px
trans_status int 是 文档转换结果 1 待转码 2 转换中 3 转换成功 4 转换失败
converted_page_swf string 是 swf转换成功页数
status_swf string 是 swf转换状态 0待转换 100转换中 200完成 500失败
conversion_type string 是 文档转换类型,only_static只转静态,only_h5只转h5,only_all全转
download_url string 是 文档下载地址
app_id string 是 应用ID

错误码

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "total": 569,
        "detail": [
            {
                "document_id": "675d3e8e",
                "uploader_id": "",
                "file_name": "1.jpg",
                "hash": "c4fba77b1be5a4cf6a18df58c22eed9e",
                "ext": "jpg",
                "page": 1,
                "size": 12542,
                "converted_page": 0,
                "status": 0,
                "converted_page_jpeg": 1,
                "status_jpeg": 200,
                "created_at": "2019-06-13 14:04:29",
                "width": 477,
                "height": 339,
                "trans_status": 3,
                "converted_page_swf": 0,
                "status_swf": "0",
				"conversion_type":"only_all",
				"app_id":"675d3e8e",
				"download_url":""
            },
        ],
        "curr_page": 1,
        "total_page": 68
    }
}
}