首页
产品
帮助文档
博客
控制台

文档服务接口

接口目录

创建文档

POST /doc/api/create

先调用存储微服务的上传文件接口,拿到 storage_id 上传的文档标题可以为空。若为空,取存储的文件名,去掉文件名的扩展名作为文档标题

JSON 参数

参数 描述 取值
storage_id 文件 ID string
access 文档访问权限(public/private) string
title (可选)文档标题 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
id 文档 ID string

返回示例:

{
	"errcode": 1000,
	"id": "17lok52y",
	"msg": "OK"
}

获取文档列表

GET /doc/api/list

文档状态表:

意义
0 初始状态
1 正常、可用(这是最终状态)
2 转码中
3 转码失败

URL 参数

参数 描述 取值
page 页数,默认 1 int
page_size 每页个数,默认 15 int
title 文档标题(可选,模糊搜索) string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
docs 文档列表 object array
docs.id 文档 ID string
docs.created_at 创建时间 string
docs.updated_at 更新时间 string
docs.storage_id 文件 ID string
docs.status 文档状态 int
docs.access 文档访问权限(public/private) string
docs.title 文档标题 string
docs.uploader_name 上传人名称 string
docs.page_count 文档页数(转码成功后获得) int
count 文档总个数 int

返回示例:

{
	"count": 33,
	"docs": [
		{
			"id": "17lok52y",
			"created_at": "2010-11-22T15:16:17+08:00",
			"updated_at": "2010-11-22T15:16:17+08:00",
			"storage_id": "1",
			"status": 1,
			"access": "1",
			"title": "1",
			"uploader_name": "1",
			"page_count": 1
		}
	],
	"errcode": 1000,
	"msg": "OK"
}

获取文档

GET /doc/api/get

URL 参数

参数 描述 取值
id 文档 ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
doc 文档 object
doc.id 文档 ID string
doc.created_at 创建时间 string
doc.updated_at 更新时间 string
doc.storage_id 文件 ID string
doc.status 文档状态 int
doc.access 文档访问权限(public/private) string
doc.title 文档标题 string
doc.uploader_name 上传人名称 string
doc.page_count 文档页数(转码成功后获得) int

返回示例:

{
	"doc": {
		"id": "17lok52y",
		"created_at": "2010-11-22T15:16:17+08:00",
		"updated_at": "2010-11-22T15:16:17+08:00",
		"storage_id": "1",
		"status": 1,
		"access": "1",
		"title": "1",
		"uploader_name": "1",
		"page_count": 1
	},
	"errcode": 1000,
	"msg": "OK"
}

获取文档图片列表

GET /doc/api/list_images

URL 参数

参数 描述 取值
id 文档 ID string
page 页数,默认 1 int
page_size 每页个数,默认 15 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string
images 文档图片列表 object array
images.index 图片编号,从 0 开始 int
images.url 图片 URL string

返回示例:

{
	"errcode": 1000,
	"images": [
		{
			"index": 1,
			"url": "http://storage.mudu.tv/123-124-124.png"
		}
	],
	"msg": "OK"
}

更新文档

POST /doc/api/update

URL 参数

参数 描述 取值
id 文档 ID string

JSON 参数

参数 描述 取值
access 文档访问权限(public/private) string
title 文档标题 string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": "OK"
}

删除文档

POST /doc/api/delete

URL 参数

参数 描述 取值
id 文档 ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": "OK"
}

批量删除文档

POST /doc/api/delete_docs

URL 参数

参数 描述 取值
ids 文档 ID(用 , 隔开) string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
msg "OK" 或错误信息 string

返回示例:

{
	"errcode": 1000,
	"msg": "OK"
}

错误码

错误代码 使用模块 错误描述 申请人
3201 文档 参数不合法 chengyiheng@mudu.tv
3202 文档 找不到该文件 chengyiheng@mudu.tv
3203 文档 文件未上传完成 chengyiheng@mudu.tv
3204 文档 不支持的文件格式 chengyiheng@mudu.tv
3221 文档 插入文档失败 chengyiheng@mudu.tv
3222 文档 查询单个文档失败 chengyiheng@mudu.tv
3223 文档 修改文档失败 chengyiheng@mudu.tv
3224 文档 删除文档失败 chengyiheng@mudu.tv
3225 文档 查询文档列表失败 chengyiheng@mudu.tv
3231 文档 查询图片列表失败 chengyiheng@mudu.tv

消息通知

文档转码成功

{"id":"17lok52y","status":"finished"}

文档转码失败

{"id":"17lok52y","status":"failed","err_msg":"document format does not match"}