API 文档
搜索文档…
文档翻页

接口

获取文档列表信息
1
PUT /api/v2/activity/:id/doc/:docId
Copied!
查询默认文档时请将 docId 参数替换为 default

授权

请求 header
1
Authorization: Bearer <accessToken>
2
Content-Type: application/json
Copied!
注:请将上方的 <accessToken> 替换为分配给您的秘钥串。关于如何获取 accessToken ,请咨询杨经理(18968187008)。

参数

请求样例

1
PUT /api/v2/activity/:id/doc/:docId
Copied!

响应

参数
参数类型
参数说明
id
integer
文档 Id
name
string
文档原始文件名
url
string
文档原始文件地址
activityId
string
活动 Id
index
integer
当前文档页面索引
status
string
转码状态
taskId
string
转码任务 Id
url
string
文档原始地址
pages
array
文档转码后的输出文件,即文档单页
pageCount
integer
文档总页数

响应样例 200

1
{
2
"id":2276, // 文档 Id
3
"activityId":"12345678", // 活动 Id
4
"index":3, // 当前文档页面索引
5
"status":"finished", // 转码状态
6
"taskId":"8a783a29-0a63-4b11-aa47-7bb906692a50", // 转码任务 Id
7
"name":"raft.pdf", // 文档名称
8
"url":"https://office.shangzhibo.tv/105131/12345678/1561700366504/176afec0-9967-11e9-901e-b90909ae0323.pdf", // 文档原始地址
9
"pages":[ // 文档转码后的输出文件,即文档单页
10
"https://office.shangzhibo.tv/105131/12345678/1561700366504/176afec0-9967-11e9-901e-b90909ae0323-1.jpg",
11
...,
12
"https://office.shangzhibo.tv/105131/12345678/1561700366504/176afec0-9967-11e9-901e-b90909ae0323-18.jpg"
13
],
14
"pageCount":18 // 文档总页数
15
}
Copied!

响应 400

1
// 文档未转码完成时
2
{
3
"name":"BadRequest",
4
"message":"当前文档正在转码或转码失败,暂时无法操作",
5
"status":400
6
}
7
8
// 当前页数不能超过总页数
9
{
10
"name":"BadRequest",
11
"message":"当前页数不能超过总页数",
12
"status":400
13
}
Copied!

响应 404

1
{
2
"name":"NotFound",
3
"message":"Doc Not Found",
4
"status":404
5
}
Copied!

响应 429

1
{
2
"name":"TooManyRequests",
3
"message":"请求速度太频繁了, 请于xxx后重试",
4
"status":429
5
}
Copied!
最近更新 1yr ago