如何接入飞书文档

更新时间：2024-12-10

飞书的云文档功能允许用户在线创建、编辑和共享文档、表格和演示文稿，支持多人实时协作编辑，版本控制和评论功能，确保文档内容的准确性和实时性。

操作流程介绍

接口demo

提供iapi、postman、swagger等方式的接口连接，下载后即可请求使用。

接口定义

测试连接

GET /kmss/openapi/feishu/connector/testConnect

前置操作

登录开发者后台，选择指定的自建应用或新建自建应用。
在基础信息>凭证与基础信息页面，获取应用凭证App ID和App Secret。

3.在开发配置>权限管理页面，开启云文档相关api权限

请求参数

名称	位置	类型	必选	说明
appId	query	string	是	自建应用的appId
appSecret	query	string	是	自建应用的appSecret
Accept	header	string	是	application/json
token	header	string	是	29fa11915421f8f36837e52ebf93de7a
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中

返回示例

成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success"，
4  "data": "lz28vq3Zff"
5}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	说明
» errno	integer	true
» msg	string	true
» data	string	true	注册任务时需要的channelId字段

获取知识空间列表

GET /kmss/openapi/feishu/connector/getKnowledgeList

请求参数

名称	位置	类型	必选	说明
pageSize	query	integer	否	每页请求数量,默认20
pageToken	query	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
channelId	query	integer	是	测试链接后返回的data数据
Accept	header	string	是	application/json
token	header	string	是	0c468719f083645c6225b9a5b9a652ce
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中

返回示例

成功

Plain Text

1{
2    "errno": 0,
3    "msg": "success",
4    "data": {
5        "items": [
6            {
7                "name": "示例知识库 / Wiki samples",
8                "description": "",
9                "visibility": "public",
10                "creator": null,
11                "title": null,
12                "space_id": "7379125463078289412",
13                "space_type": "team",
14                "node_token": null,
15                "has_child": null,
16                "obj_token": null,
17                "obj_type": null,
18                "origin_node_token": null,
19                "origin_space_id": null,
20                "parent_node_token": null,
21                "obj_edit_time": null,
22                "obj_create_time": null
23            }
24        ],
25        "has_more": false,
26        "page_token": "0||7379125463078289412"
27    }
28}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名
» errno	integer	true	none	none
» msg	string	true	none	none
» data	object	true	none	none
»» items	[object]	true	none	none
»»» name	string	true	none	空间名称
»»» description	string	true	none	空间描述
»»» visibility	string	true	none	可见性public：公开空间 private：私有空间
»»» creator	null	false	none	none
»»» title	null	false	none	none
»»» space_id	string	true	none	空间id
»»» space_type	string	true	none	空间类型 team：团队空间 person：个人空间
»»» node_token	null	false	none	none
»»» has_child	null	false	none	none
»»» obj_token	null	false	none	none
»»» obj_type	null	false	none	none
»»» origin_node_token	null	false	none	none
»»» origin_space_id	null	false	none	none
»»» parent_node_token	null	false	none	none
»»» obj_edit_time	null	false	none	none
»»» obj_create_time	null	false	none	none
»» has_more	boolean	true	none	是否还有更多
»» page_token	string	true	none	需要翻页时传入此参数

失败任务重试接口

POST /kmss/openapi/feishu/connector/retry

Body 请求参数

Plain Text

1{
2  "fileToken": "NyDmdMisAopJJIxJaT2cjggVnad",
3  "taskId": "cz08vq3Zff",
4  "fileType": "docx"
5}

请求参数

名称	位置	类型	必选	说明
Accept	header	string	是	application/json
token	header	string	是	b675b77e1d5dfd8c694a2135ab3b81fa
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中
body	body	object	是	none
» taskId	body	integer	是	同步任务id
» fileType	body	string	是	文档类型
» fileToken	body	string	是	需要重试的文档id

返回示例成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success"
4}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» errno	integer	true	none	none
» msg	string	true	none	none

注册任务

POST /kmss/openapi/data/connector/addTask

Body 请求参数

Plain Text

1{
2  "items": [
3    {
4      "source": "7379125463078289412",
5      "channelId": "MWATe2ywyw",
6      "taskType": "feishu",
7      "spaceGuid": "o6sNkygHVu"
8    }
9  ]
10}

请求参数

名称	位置	类型	必选	说明
Accept	header	string	是	application/json
token	header	string	是	b18e4376fb3ea907e209fc4c50759915
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中
body	body	object	是	none
» items	body	[object]	是	none
»» source	body	string	是	none
»» channelId	body	integer	是	none
»» taskType	body	string	是	none

返回示例

成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success",
4  "data": [
5    {
6      "test02": "Haez5MRf7Z"
7    }
8  ]
9}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名
» errno	integer	true	none	none
» msg	string	true	none	none
» data	[object]	true	none	none
»»source	string	false	none	none

任务信息

GET /kmss/openapi/data/connector/taskInfo

请求参数

名称	位置	类型	必选	说明
id	query	string	是	注册任务时返回的任务id
Accept	header	string	是	application/json
token	header	string	是	5abeb6c1fadcbf0488d0a6e583b3803b
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中

返回示例

成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success",
4  "data": {
5    "id": "3xxHRPwcCZ",
6    "source": "test01",
7    "originalTotal": 3,
8    "total": 3,
9    "status": 50,
10    "createTime": "2024-06-21 23:43:15",
11    "updateTime": "2024-06-22 00:02:42",
12    "channelId": "RSmaY8sRgj",
13    "type": "confluence",
14    "host": "http://xxx.yq01.baidu.com",
15    "auth": "Basic YWRtaW46emhlbnpoaTAwMUBBYmM=",
16    "spaceGuid": "o6sNkygHVu",
17    "errMsg": null,
18    "extFields": {}
19  }
20}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	说明
» errno	integer	true	状态码
» msg	string	true	错误信息
» data	object	true
»» id	string	true	任务id
»» source	string	true	第三方数据源id
»» originalTotal	integer	true	数据源中原始需要同步的数量
»» total	integer	true	目前已经同步的文档数量
»» status	integer	true	状态信息
»» createTime	string	true	创建时间
»» updateTime	string	true	更新时间
»» channelId	string	true	测试连接后返回的id信息
»» type	string	true	任务类型
»» host	string	true	第三方链接地址
»» auth	string	true	第三方鉴权信息
»» spaceGuid	string	true	租户id
»» errMsg	null	true	错误文档信息
»» extFields	object	true	额外字段（包含天级别更新任务状态）

触发任务

GET /kmss/openapi/data/connector/triggerTask

请求参数

名称	位置	类型	必选	说明
id	query	string	是	任务id
spaceguid	query	string	是	租户id
Accept	header	string	是	application/json
token	header	string	是	b25a91326f3ee2efa5b7e993b6e773d1
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中

返回示例

成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success",
4  "data": "3xxHRPwcCZ"
5}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名
» errno	integer	true	none	none
» msg	string	true	none	none
» data	string	true	none	none

定时任务启动

全局生效，如果接入多数据源只需要触发一次

POST /kmss/openapi/data/connector/task/start

请求参数

名称	位置	类型	必选	说明
Accept	header	string	是	application/json
token	header	string	是	3cb65c0d5224291d2a5affcdc71a8d48
userid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userId数据填写到对应参数中
accountid	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将accountId数据填写到对应参数中
username	header	string	是	获取方法：登录百度智能云，进入甄知首页，打开浏览器检查，定位到/user/current接口查看接口返回参数，并将userName数据填写到对应参数中

返回示例

成功

Plain Text

1{
2  "errno": 0,
3  "msg": "success",
4  "data": "定时任务启动成功"
5}

返回结果

状态码	状态码含义	说明	数据模型
200	ok	成功	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名
» errno	integer	true	none	none
» msg	string	true	none	none
» data	string	true	none	none

预置数据源

如何接入Confluence文档

百度智能云

甄知企业知识管理平台

甄知企业知识管理平台

如何接入飞书文档

操作流程介绍

接口demo

接口定义

测试连接

前置操作

请求参数

返回结果

返回数据结构

获取知识空间列表

请求参数

返回结果

返回数据结构

失败任务重试接口

请求参数

返回结果

返回数据结构

注册任务

请求参数

返回结果

返回数据结构

任务信息

请求参数

返回结果

返回数据结构

触发任务

请求参数

返回结果

返回数据结构

定时任务启动

请求参数

返回结果

返回数据结构

甄知 企业知识管理平台

如何接入飞书文档

操作流程介绍

接口demo

接口定义

测试连接

前置操作

请求参数

返回结果

返回数据结构

获取知识空间列表

请求参数

返回结果

返回数据结构

失败任务重试接口

请求参数

返回结果

返回数据结构

注册任务

请求参数

返回结果

返回数据结构

任务信息

请求参数

返回结果

返回数据结构

触发任务

请求参数

返回结果

返回数据结构

定时任务启动

请求参数

返回结果

返回数据结构

甄知企业知识管理平台