文档白板 API

文档管理

创建文档

API 地址

api.vhallyun.com/api/v1/document/create

描述

通过接口上传文档

入参

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

参数 类型 是否必选 含义
document http multipart/form-data 上传文档文件 (类型请参见 HTTP RFC1867协议)

出参

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

错误码

错误码 类型 含义
10018 int 文档文件不能为空
50004 int 创建文档失败

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "document_id": "6e5692bb"
    }
}

删除文档

API 地址

api.vhallyun.com/api/v1/document/delete

描述

通过接口删除文档

入参

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

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

出参

参数 类型 是否必选 含义
delete_document_id string 删除的文档ID

错误码

错误码 类型 含义
10017 int 文档ID不能为空
20007 int 文档查询为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_document_id": "ead7e8e1"
    }
}

文档列表

API 地址

api.vhallyun.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
        },
    ]
}

获取文档信息

API 地址

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

描述

按文档ID,获取文档属性信息

入参

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

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

出参

参数 类型 是否必选 含义
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 转换失败

错误码

错误码 类型 含义
10017 int 文档ID不能为空
20007 int 文档查询为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "document_id": "8c7b09b3",
        "app_id": "e0871a28",
        "file_name": "512931b75eedd5cb35e4c4d32130ab1f.doc",
        "created_at": "2019-05-14 15:23:03",
        "ext": "doc",
        "hash": "512931b75eedd5cb35e4c4d32130ab1f",
        "status": 200,
        "size": 1157.12,
        "page": 11,
        "trans_status": 3
    }
}

获取转码成功的文档列表

API 地址

api.vhallyun.com/api/v1/document/get-trans-over-lists

描述

按当前公共参数传入app_id对应的应用,查询转码成功的文档列表

入参

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

参数 类型 是否必选 含义
pos int 当前获取条目节点,默认为 0。eg : 10 从第10条开始查询
limit int 获取条目数量 ,默认为 10 条,最大为1000条

出参

参数 类型 是否必选 含义
document_id string 文档ID
app_id string app_id
file_name string 文档名称
size int 文档大小 单位为 KB
created_at string 创建时间

错误码

错误码 类型 含义
40008 int 分页起始提条目不正确
40009 int 分页条目不正确
20007 int 文档查询为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "document_id": "59e67a7e",
            "app_id": "app_id_1",
            "file_name": "员工信息更新表.xlsx",
            "size": 9997,
            "created_at": "2017-12-09 20:07:22"
        }
    ]
}

数据统计

获取文档使用数据

API 地址

api.vhallyun.com/api/v1/document/get-document-use-info

描述

按文档ID,查询当前文档翻页次数(所有端的翻页次数)

入参

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

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

出参

参数 类型 是否必选 含义
use_time int 使用次数

错误码

错误码 类型 含义
10017 int 文档ID不能为空
20007 int 文档查询为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "use_time": 6
    }
}