飞书API网关

fs-api.vipdouyin.cn - 统一飞书开放平台接口

管理后台

鉴权方式

所有API请求需携带API Key,支持两种方式:

Header: X-API-Key: fs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Query:  ?api_key=fs_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

统一响应格式

{ "code": 0, "msg": "success", "data": { ... } }

文档 /api/doc 8个接口

POST /api/doc/read

读取文档内容

doc_token*

POST /api/doc/write

替换文档全部内容(Markdown格式)

doc_token* content*

POST /api/doc/append

追加内容到文档末尾

doc_token* content*

POST /api/doc/create

创建新文档

title* folder_token

POST /api/doc/blocks

获取文档Block列表

doc_token* page_size page_token

POST /api/doc/block

获取单个Block

doc_token* block_id*

POST /api/doc/block/update

更新Block文本

doc_token* block_id* content

POST /api/doc/block/delete

删除Block

doc_token* block_id*

云盘 /api/drive 5个接口

POST /api/drive/list

列出文件夹内容

folder_token page_size page_token

POST /api/drive/info

获取文件元信息

file_token* type*

POST /api/drive/folder/create

创建文件夹

name* folder_token

POST /api/drive/move

移动文件

file_token* type* folder_token*

POST /api/drive/delete

删除文件

file_token* type*

权限 /api/perm 3个接口

POST /api/perm/list

列出协作者

token* type*

POST /api/perm/add

添加协作者

token* type* member_type* member_id* perm*

POST /api/perm/remove

移除协作者

token* type* member_type* member_id*

知识库 /api/wiki 6个接口

GET /api/wiki/spaces

列出所有知识空间

POST /api/wiki/nodes

列出节点

space_id* parent_node_token page_size

POST /api/wiki/get

获取节点详情

token*

POST /api/wiki/create

创建知识库节点

space_id* title* obj_type parent_node_token

POST /api/wiki/move

移动节点

space_id* node_token* target_space_id target_parent_token

POST /api/wiki/rename

重命名节点

space_id* node_token* title*

消息 /api/msg 7个接口

POST /api/msg/send

发送消息

receive_id* receive_id_type* msg_type* content*

POST /api/msg/reply

回复消息

message_id* msg_type* content*

POST /api/msg/list

获取消息列表

container_id* container_id_type page_size

POST /api/msg/get

获取单条消息

message_id*

POST /api/msg/delete

撤回消息

message_id*

GET /api/msg/chats

获取群列表

POST /api/msg/chat/info

获取群信息

chat_id*

通讯录 /api/contact 4个接口

GET /api/contact/users

获取用户列表

query page_size

GET /api/contact/departments

获取部门列表

department_id page_size

GET /api/contact/user/:user_id

获取用户详情

user_id*

POST /api/contact/search

搜索用户

query* page_size

内部Key获取 /api/internal 1个接口

POST /api/internal/provision-key

内部项目自助获取API Key(HMAC-SHA256签名鉴权,与qz/xt/jl-api共用同一套机制)

project_id* timestamp* signature*

signature = HMAC-SHA256(project_id + ":" + timestamp, master_secret)

fs-api v1.0 | Powered by Feishu Open Platform