一、查询知识库全部分类
1、请求方式
POST
2、请求地址
/openapi/platform/document/listAllCategory
3、请求参数
| 名称 | 类型 | 描述 |
| name | String | 名称 |
| parentId | String | 父id |
| level | Integer | 级别 |
4、请求示例
{
"name":"名称",
"parentId":"父级id",
"level":1
}
5、响应参数
| 名称 | 类型 | 描述 |
| code | String | 成功=200 |
| message | String | 错误信息 |
| success | boolean | true/false |
| data | List<Object> | 接口返回数据 |
| ->categoryId | String | 分类id |
| ->accountId | String | 账户id |
| ->createTime | String | 创建时间 yyyy-MM-dd HH:mm:ss |
| ->updateTime | String | 更新时间 yyyy-MM-dd HH:mm:ss |
| ->createAgent | String | 创建座席 |
| ->updateAgent | String | 更新座席 |
| ->name | String | 名称 |
| ->parentId | String | 父级id |
| ->level | Integer | 层级 |
| ->isLeaf | Boolean | 是否叶子节点 |
| ->sort | Integer | 排序，越小越靠前 |
| ->children | List<Object> | 子分类列表,参数同上 |
6、响应示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": [
{
"categoryId": "all",
"accountId": "1124",
"createTime": null,
"updateTime": null,
"createAgent": null,
"updateAgent": null,
"name": "全部文档",
"parentId": "root",
"level": 1,
"isLeaf": true,
"sort": -2,
"children": []
},
{
"categoryId": "none",
"accountId": "1124",
"createTime": null,
"updateTime": null,
"createAgent": null,
"updateAgent": null,
"name": "未分类",
"parentId": "root",
"level": 1,
"isLeaf": true,
"sort": -1,
"children": []
},
{
"categoryId": "693342481148227584",
"accountId": "1124",
"createTime": "2023-07-17 20:27:50",
"updateTime": "2023-07-17 20:27:50",
"createAgent": "687845353468846080",
"updateAgent": "687845353468846080",
"name": "分类1",
"parentId": "root",
"level": 1,
"isLeaf": true,
"sort": 0,
"children": []
},
{
"categoryId": "693342498256793600",
"accountId": "1124",
"createTime": "2023-07-17 20:27:54",
"updateTime": "2023-07-17 20:27:54",
"createAgent": "687845353468846080",
"updateAgent": "687845353468846080",
"name": "分类2",
"parentId": "root",
"level": 1,
"isLeaf": true,
"sort": 1,
"children": []
}
]
}
二、知识库查询
1、请求方式
POST
2、请求地址
/openapi/platform/document/list
3、请求参数
| 名称 | 类型 | 描述 |
| categoryId | String | 分类ID，全部文档=all，未分类=none |
| name | String | 标题或内容关键词 |
| page | Integer | 当前页码 |
| limit | Integer | 每页数量 |
4、请求示例
{
"limit":10,
"page":1,
"categoryId":"none",
"name":"内容"
}
5、响应参数
| 名称 | 类型 | 描述 |
| code | String | 成功=200 |
| message | String | 错误信息 |
| success | boolean | true/false |
| data | object | 接口返回数据 |
| ->count | Integer | 总数 |
| ->list | List<Object> | 当前页数据 |
| ->docId | String | 文档ID |
| ->accountId | String | 账户ID |
| ->createTime | String | 创建时间yyyy-MM-dd HH:mm:ss |
| ->updateTime | String | 更新时间yyyy-MM-dd HH:mm:ss |
| ->createAgent | String | 创建坐席id |
| ->updateAgent | String | 更新坐席id |
| ->title | String | 标题 |
| ->content | String | 内容 |
| ->categoryId | String | 所属分类id |
| ->filePath | String | 附件地址 |
| ->fileName | String | 附件名称 |
| ->viewNum | Integer | 查看数 |
| ->readNum | Integer | 阅读数 |
| ->citeNum | Integer | 引用数 |
6、响应示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": {
"list": [
{
"docId": "708852914922606592",
"accountId": "1090",
"createTime": "2023-08-29 15:40:45",
"updateTime": "2023-08-29 15:40:45",
"createAgent": "691521418588135424",
"updateAgent": "691521418588135424",
"title": "标题",
"content": "内容",
"categoryId": null,
"isDel": 0,
"status": 0,
"filePath": null,
"fileName": null,
"viewNum": 0,
"readNum": 0,
"citeNum": 0
}
],
"count": 1
}
}
三、知识库新增
1、请求方式
POST
2、请求地址
/openapi/platform/document/add
3、请求参数
| 名称 | 类型 | 描述 |
| title | String | 标题 |
| content | String | 内容 |
| categoryId | String | 分类ID |
| filePath | String | 附件地址 |
| fileName | String | 附件名称 |
4、请求示例
{
"title":"标题",
"content":"内容",
"categoryId":"分类ID",
"filePath":"附件地址",
"fileName":"附件名称"
}
5、响应参数
| 名称 | 类型 | 描述 |
| code | String | 成功=200 |
| message | String | 错误信息 |
| success | boolean | true/false |
| data | object | 接口返回数据 |
6、响应示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": null
}
四、知识库编辑
1、请求方式
POST
2、请求地址
/openapi/platform/document/update
3、请求参数
| 名称 | 类型 | 描述 |
| title | String | 标题 |
| content | String | 内容 |
| categoryId | String | 分类ID |
| filePath | String | 附件地址 |
| fileName | String | 附件名称 |
| docId | String | 文档ID |
4、请求示例
{
"title":"标题",
"content":"内容",
"categoryId":"分类ID",
"filePath":"附件地址",
"fileName":"附件名称",
"id":"文档ID"
}
5、响应参数
| 名称 | 类型 | 描述 |
| code | String | 成功=200 |
| message | String | 错误信息 |
| success | boolean | true/false |
| data | object | 接口返回数据 |
6、响应示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": null
}
五、知识库删除
1、请求方式
POST
2、请求地址
/openapi/platform/document/delete
3、请求参数
| 名称 | 类型 | 描述 |
| id | String | 文档ID |
4、请求示例
{
"id":"文档ID"
}
5、响应参数
| 名称 | 类型 | 描述 |
| code | String | 成功=200 |
| message | String | 错误信息 |
| success | boolean | true/false |
| data | object | 接口返回数据 |
6、响应示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": null
}