查询PPT文档详情
1.接口说明
请求该接口查询PPT文档详细数据。
2.请求地址
https://digitbot.bokecc.com/api/ppt/get
3.请求方式
GET
4.请求参数
(1).公共参数,参考服务说明。
(2).接口参数
①.Query参数:通过URL参数传递。
| 参数名 | 类型 | 必需 | 说明 |
|---|---|---|---|
| version | String | 是 | 接口版本号,当前支持版本:1.0.0。 |
| projectId | String | 是 | 项目ID。 |
| pptId | String | 是 | PPT-ID。 |
5.请求示例
GET https://digitbot.bokecc.com/api/ppt/get?projectId=xxx&pptId=xxx&accountId=xxx&version=1.0.0&hash=xxx&time=xxx HTTP/1.1
6.响应示例
{
"id": "xxx",
"filename": "xxxx讲义.pptx",
"size": 91211200,
"status": 1,
"totalPage": 30,
"successPage": 25,
"createTime": "2024-01-24 09:10:11",
"finishTime": "",
"failReason": "",
"images": [{
"id": "xxxx",
"indexNo": 1,
"createTime": "2024-01-24 09:11:11"
"imageUrl": "https://xxxx.xxxx/xx",
"width": 960,
"height": 540,
"pptNotes": "xxxxx"
}, ...]
}
7.响应说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | String | PPT-ID。 |
| filename | String | PPT文件名称。 |
| size | Long | PPT文件大小,单位:B(字节)。 |
| status | Integer | PPT文档状态,枚举值。0=上传中;1=解析中;2=处理完成;-1=上传失败。 |
| totalPage | Integer | PPT总页数。 |
| successPage | Integer | 已解析成功页数。 |
| createTime | String | 创建时间,yyyy-MM-dd HH:mm:ss格式。 |
| finishTime | String | 完成时间,yyyy-MM-dd HH:mm:ss格式。 |
| failReason | String | 上传失败原因。 |
| images | Array | 已解析成功的图片(image)列表,按PPT页面编号排列。 |
image字段说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| id | String | PPT图片ID。 |
| indexNo | Integer | PPT图片在PPT文档中的页面编号,从1开始,按顺序递增。 |
| createTime | String | 创建时间,yyyy-MM-dd HH:mm:ss格式 |
| imageUrl | String | PPT图片链接。 |
| width | Integer | PPT图片宽度,像素值。 |
| height | Integer | PPT图片高度,像素值。 |
| pptNotes | String | PPT图片对应PPT文档页面中的备注信息。 |