Skip to Content
实操指南IM频道飞书接入配置指引

飞书接入配置指引

本指南将帮助您在飞书中配置 DeepWorks 机器人,让您可以通过飞书随时随地远程操控电脑上的 DeepWorks 完成编程任务。

前提条件

在开始之前,请确保您已满足以下条件:

  • 已在电脑上安装 DeepWorks,并开启了 IM频道 远程控制功能
  • 如需创建企业机器人需拥有一个飞书企业账号(需要有创建应用的权限)。

创建飞书应用

登录开发者后台

打开浏览器,访问 飞书开放平台 ,使用企业账号登录后,点击创建企业自建应用。 这里使用的是具备收发消息能力的应用机器人。群聊中的仅 Webhook 通知机器人不能替代该接入方式。

Pasted image 20261028171428

填写应用信息

在弹出的创建窗口中,填写以下信息:

配置项说明
应用名称给应用起一个名字,如DeepWorks 助手
应用描述简单描述应用的功能
应用图标上传一个应用图标

Pasted image 20261028171454

填写完成后,点击创建按钮。

进入应用详情

应用创建成功后,会自动跳转到应用详情页面,点击添加应用能力,找到机器人卡片,点击添加按钮。

Pasted image 20261028171633

配置事件与回调

在应用详情页左侧菜单中,点击事件与回调,分别配置事件和回调的接收方式,并添加接收消息事件。

第一步:配置事件接收方式

  1. 进入事件配置页签,在订阅方式中选择使用长连接接收事件。
  2. 确认显示连接成功后,点击保存。

Pasted image 20261028174924

第二步:配置回调接收方式

  1. 切换到回调配置页签,在订阅方式中选择使用长连接接收回调。
  2. 验证连接状态,确认显示连接成功后,点击保存。

Pasted image 20261028175648

第三步:添加接收消息事件

  1. 返回事件配置页签,在已添加事件区域点击添加事件。
  2. 选择接收消息事件(im.message.receive_v1),完成添加。
  3. 确认事件已出现在列表中,并按第三章配置应用权限开通单聊消息及群内 @ 消息所需权限。

添加该事件后,应用可接收权限范围内的用户消息,包括发给机器人的单聊消息和群聊中 @ 机器人的消息。

Pasted image 20261029100729

可参考飞书官方的长连接接收事件 和消息事件说明 。

配置应用权限

为了让机器人能够正常收发消息,需要为应用添加必要的权限。

进入权限管理

在应用详情页左侧菜单中,点击权限管理

Pasted image 20261028171752

搜索并配置如下权限:

权限用途
接收单聊消息 im:message.p2p_msg:readonly接收用户发给机器人的单聊消息
接收群内 @ 消息 im:message.group_at_msg:readonly接收群中 @ 机器人的消息
以应用身份发消息 im:message:send_as_bot向用户或群回复消息
获取用户基本信息识别使用者
获取用户手机号手机号字段授权和通讯录数据范围均需覆盖使用者
获取与上传资源 im:resource处理消息中的图片、文件等资源
创建与更新卡片 cardkit:card:write使用流式卡片功能时需要

开通权限后,按飞书提示完成审批和版本发布。应用可用范围与通讯录数据范围需要分别检查。

批量导入权限

更多常用权限见如下清单,可直接进行批量导入。

在弹出的窗口中:

  1. 清空输入框中的所有内容
  2. 将下方的权限列表完整复制并粘贴进去
  3. 点击确定新增权限

需要导入的权限列表:

{ "scopes": { "tenant": [ "contact:contact.base:readonly", "docx:document:readonly", "im:chat:read", "im:chat:update", "im:message.group_at_msg:readonly", "im:message.p2p_msg:readonly", "im:message.pins:read", "im:message.pins:write_only", "im:message.reactions:read", "im:message.reactions:write_only", "im:message:readonly", "im:message:recall", "im:message:send_as_bot", "im:message:send_multi_users", "im:message:send_sys_msg", "im:message:update", "im:resource", "application:application:self_manage", "cardkit:card:write", "cardkit:card:read" ], "user": [ "contact:user.employee_id:readonly", "offline_access", "base:app:copy", "base:field:create", "base:field:delete", "base:field:read", "base:field:update", "base:record:create", "base:record:delete", "base:record:retrieve", "base:record:update", "base:table:create", "base:table:delete", "base:table:read", "base:table:update", "base:view:read", "base:view:write_only", "base:app:create", "base:app:update", "base:app:read", "board:whiteboard:node:create", "board:whiteboard:node:read", "calendar:calendar:read", "calendar:calendar.event:create", "calendar:calendar.event:delete", "calendar:calendar.event:read", "calendar:calendar.event:reply", "calendar:calendar.event:update", "calendar:calendar.free_busy:read", "contact:contact.base:readonly", "contact:user.base:readonly", "contact:user:search", "docs:document.comment:create", "docs:document.comment:read", "docs:document.comment:update", "docs:document.media:download", "docs:document:copy", "docx:document:create", "docx:document:readonly", "docx:document:write_only", "drive:drive.metadata:readonly", "drive:file:download", "drive:file:upload", "im:chat.members:read", "im:chat:read", "im:message", "im:message.group_msg:get_as_user", "im:message.p2p_msg:get_as_user", "im:message:readonly", "search:docs:read", "search:message", "space:document:delete", "space:document:move", "space:document:retrieve", "task:comment:read", "task:comment:write", "task:task:read", "task:task:write", "task:task:writeonly", "task:tasklist:read", "task:tasklist:write", "wiki:node:copy", "wiki:node:create", "wiki:node:move", "wiki:node:read", "wiki:node:retrieve", "wiki:space:read", "wiki:space:retrieve", "wiki:space:write_only" ] } }

Pasted image 20261028172013

Pasted image 20261028172123

根据实际情况确定权限可访问范围。

Pasted image 20261028172151

发布应用

应用必须发布后才能在飞书中使用。

创建版本

点击页面上方的创建版本按钮,进入详情页创建或更新版本。

Pasted image 20261028172611

Pasted image 20261028172746

发布版本

创建成功后,点击版本右侧的发布按钮。

如果您是企业管理员或创建个人应用,应用通常会自动审批通过。如果需要审批,请联系您的企业管理员。

Pasted image 20261028172818

获取应用凭证

在应用详情页左侧菜单中,点击凭证与基础信息。

在页面中,您会看到两个重要的凭证信息:

  • App ID:应用的唯一标识
  • App Secret:应用的密钥(点击查看)

请务必妥善保管 App Secret,不要泄露给他人!

Pasted image 20261028173018

在 DeepWorks 中配置飞书

支持通过手机扫码创建或选择飞书应用并接入,也可以手动填写已有应用的凭证。

接入前提: 创建企业应用需具备相应的创建权限。接入前,请按前文完成机器人能力、订阅方式及所需应用权限的配置,并完成版本发布;企业机器人的应用可用范围、手机号授权及通讯录数据范围需覆盖使用人员。扫码接入后也需核对这些配置。

进入机器人配置

  1. 点击 DeepWorks 左下角用户头像,选择IM频道,确认需要配置的工作区。
  2. 在频道连接页签中完成飞书账号连接,具体参见 IM频道。
  3. 切换到机器人页签,点击添加机器人→飞书,打开创建飞书机器人弹窗。

IM频道-V1.4-05-创建飞书机器人

选择接入方式

方式一:手机扫码接入

  1. 点击一键创建飞书应用扫码接入。
  2. 在飞书创建或选择机器人二维码弹窗中,使用手机飞书扫描 DeepWorks 当前页面生成的二维码,按手机页面提示创建机器人或选择已有应用,并完成确认。
  3. 完成后,系统会自动填入应用凭据。返回创建弹窗,检查凭据,并填写或核对机器人名称,确保与实际机器人名称一致。
  4. 在飞书开放平台核对该应用的机器人能力、订阅方式及第三章列出的所需权限,并按第四章完成所需的版本发布。

IM频道-V1.4-06-飞书扫码接入

需要重新获取二维码时,点击刷新二维码。请扫描实际操作页面生成的二维码,不要扫描本指引中的示例图片。

方式二:手动填写凭证

已在飞书开放平台创建应用的,可直接填写以下信息:

配置项填写说明
机器人名称与飞书中实际机器人名称保持一致。
Client ID填写该飞书应用的 App ID。
Client Secret填写该飞书应用的 App Secret。

应用凭证的获取方式见第五章获取应用凭证。接入前,请确认已完成机器人能力、订阅方式、应用权限配置和版本发布。

创建并启用机器人

  1. 确认机器人名称和应用凭据填写完整,打开启用机器人开关,点击创建。
  2. 返回我的机器人列表,确认机器人已添加且处于启用状态。后续可通过配置修改信息,或通过启用机器人开关调整启用状态。
  3. 在飞书中打开对应机器人会话,发送消息并检查是否收到回复。

连接飞书账号后,也可直接使用自己或他人已接入的机器人,无需重复创建;如没有使用权限,可在企业机器人列表中查看创建人并联系申请。

开始使用

找到机器人

在飞书的搜索框中,输入刚才创建的机器人名称进行搜索。

开始对话

点击机器人进入对话窗口,或者点击打开应用开始使用,并发送任务。

Pasted image 20261029103911

在DeepWorks接收到消息

切换到DeepWorks中,也可接收到该消息。

Pasted image 20261029104048