查询文档信息

查询文档信息

API 地址

api.vhallyun.com/api/v2/document/get-info

描述

根据文档ID,获取文档信息

场景描述:

指定文档去查询文档的详细信息,用户可用来做详细的数据统计,例如文档存储总量、文档转化状态分布等

入参

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

参数 类型 是否必选 含义
document_id string 是 文档ID

出参

参数 类型 是否必选 含义
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),不传转全部,only_h5传递时文档必须为ppt或pptx类型
app_id string 是 应用ID

错误码

响应格式

{
    "code": 200,
    "msg": null,
    "data": {
        "document_id": "39af4fe6",
        "uploader_id": "",
        "file_name": "20180926_174956_001.jpg",
        "hash": "6a95e328abb38b5f92c27153c6d16484",
        "ext": "jpg",
        "page": 1,
        "size": 1413714,
        "converted_page": null,
        "status": 0,
        "converted_page_jpeg": 1,
        "status_jpeg": 200,
        "created_at": "2019-05-23 10:41:35",
        "width": 2592,
        "height": 1728,
        "trans_status": 3,
        "converted_page_swf": 0,
        "status_swf": "0",
		"conversion_type":"only_all",
		"app_id":"d317f559"
    }
}