文档列表
API 地址
api.yun.vhall.com/api/v1/document/lists
描述
按当前公共参数传入app_id对应的应用,查询文档列表
入参
关于公共请求参数详细内容,请参考 公共请求参数。
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
pos | int | 否 | 获取条目节点,默认为 0。eg : 10 从第10条开始查询 |
limit | int | 否 | 获取条目数量,默认为10条,最大为1000条 |
出参
参数 | 类型 | 是否必选 | 含义 |
---|---|---|---|
document_id | string | 是 | 文档ID |
app_id | string | 是 | 文档所属应用ID |
file_name | string | 是 | 文档名称 |
created_at | string | 是 | 文档创建时间 |
ext | string | 是 | 文档扩展名 |
hash | string | 是 | 文档hash |
status | int | 是 | 文档转图片状态,0待转换,100转换中,200完成,500失败 |
size | float | 是 | 文档大小 单位为 KB |
app_id | string | 是 | 文档所属应用ID |
page | int | 是 | 文档含有页码 |
trans_status | int | 是 | 文档转换结果 1 待转码 2 转换中 3 转换成功 4 转换失败 |
错误码
错误码 | 类型 | 含义 |
---|---|---|
40008 | int | 分页起始提条目不正确 |
40009 | int | 分页条目不正确 |
20007 | int | 文档查询为空 |
响应格式
{
"code": 200,
"msg": "",
"data": [
{
"document_id": "0ae549ab",
"app_id": "e0871a28",
"file_name": "基数词(1).pptx",
"created_at": "2019-03-28 18:34:21",
"ext": "pptx",
"hash": "7bc4618c7d564cb92bb458cdf0b42208",
"status": 0,
"size": 15031.8,
"page": 1,
"trans_status": 1
},
]
}