文档翻页

接口

获取文档列表信息

PUT /api/v2/activity/:id/doc/:docId

查询默认文档时请将 docId 参数替换为 default

授权

请求 header

Authorization: Bearer <accessToken>
Content-Type: application/json

注:请将上方的 <accessToken> 替换为分配给您的秘钥串。关于如何获取 accessToken ,请咨询杨经理(18968187008)。

参数

请求样例

PUT /api/v2/activity/:id/doc/:docId

响应

参数

参数类型

参数说明

id

integer

文档 Id

name

string

文档原始文件名

url

string

文档原始文件地址

activityId

string

活动 Id

index

integer

当前文档页面索引

status

string

转码状态

taskId

string

转码任务 Id

url

string

文档原始地址

pages

array

文档转码后的输出文件,即文档单页

pageCount

integer

文档总页数

响应样例 200

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

响应 400

// 文档未转码完成时
{
    "name":"BadRequest",
    "message":"当前文档正在转码或转码失败,暂时无法操作",
    "status":400
}

// 当前页数不能超过总页数
{
    "name":"BadRequest",
    "message":"当前页数不能超过总页数",
    "status":400
}

响应 404

{
    "name":"NotFound",
    "message":"Doc Not Found",
    "status":404
}

响应 429

{
    "name":"TooManyRequests",
    "message":"请求速度太频繁了, 请于xxx后重试",
    "status":429
}

最后更新于