飞书集成

约束限制

操作流程

步骤一：准备工作

1. 创建企业自建应用。

   登录飞书开放平台，单击右上角的“开发者后台”，选择“创建企业自建应用”，创建一个企业自建应用。

2. 添加机器人。

   进入“添加应用能力”页面，在“按能力添加”页签中，单击机器人下的“添加”，即可为应用添加一个机器人。

3. 为机器人添加应用身份权限。

   进入“权限管理”页面，单击“开通权限”。在“应用身份权限 tenant_access_token”页签中，为机器人添加如下权限：

   • 获取群组信息（im:chat:readonly）
   • 获取与发送单聊、群组消息（im:message）
   • 获取与更新群组信息（im:chat）
   • 获取群组中用户@机器人消息（im:message.group_at_msg:readonly）
   • 获取群组中其他机器人和用户@当前机器人的消息（im:message.group_at_msg.include_bot:readonly）
   • 读取用户发送给机器人的单聊消息（im:message.p2p_msg:readonly）
   • 以应用的身份发消息（im:message:send_as_bot）
   • 获取与上传图片或文件资源（im:resource）
   • 获取卡片信息（cardkit:card:read）
   • 创建与更新卡片（cardkit:card:write）
   • 读取卡片模板信息（cardkit:template:read）

4. 在事件和回调中添加事件。
   1. 进入“事件与回调”页面，在“事件配置”页签中，选中“订阅方式”下的“使用 长连接 接收事件”，单击“保存”。

      此处的“订阅方式”必须选择“使用 长连接 接收事件”。

   2. 单击“添加事件”，在“应用身份订阅”页签中，添加如下事件。
      • 机器人进群（im.chat.member.bot.added_v1）
      • 机器人被移出群（im.chat.member.bot.deleted_v1）
      • 接收消息（im.message.receive_v1）
      • 消息已读（im.message.message_read_v1）
   3. 在“回调配置”页签中，选中“订阅方式”下的“使用 长连接 接收回调”，单击“保存”。

      此处的“订阅方式”必须选择“使用 长连接 接收回调”。

   4. 单击“添加回调”，搜索添加卡片回传交互（card.action.trigger）并完成添加。

5. 发布应用。

   进入“凭证与基础信息”页面，单击页面上方的“创建版本”，提交应用发布申请。随后，前往“应用发布 > 版本管理与发布”页面查看进度。若“版本状态”显示为“已发布”，则说明应用已成功上线。

6. 获取应用凭证。

   获取凭证信息：进入“凭证与基础信息”页面，在“应用凭证”中，即可获取App ID和App Secret。后续在码道Space中，连接飞书机器人时需要使用该凭证。

步骤二：码道Space配置

1. 参考快速启动操作，进入码道Space。
2. 单击输入框下方的“选择工作空间”，您可以选择“新建工作空间”或“打开本地文件夹”。
   图1 打开一个文件夹
   

3. 左侧导航栏选择“IM助理”，单击“飞书”卡片，进入“连接飞书”页面。
4. 选择“手动配置”页面，输入6中获取的飞书应用信息，单击“连接”。
   图2 完成飞书连接
   

   等待注册完成，当状态由“连接中”变为“已连接”时，说明飞书机器人注册成功。

5. 连接成功后，可在码道Space界面右上角查看到连接状态。

步骤三：飞书远程控制

1. 登录飞书客户端，添加机器人。
   • 单聊：在飞书客户端的搜索框中，搜索1中创建的应用名称。单击搜索到的结果，即可进入对应的机器人。
   • 群聊：在飞书客户端的右上方，单击“...”，选择“设置”。在群机器人中，单击“添加机器人”。搜索2中创建的机器人，单击搜索到的结果，再单击“添加”，即可将机器人添加到群聊中。

2. 在飞书机器人中输入想要执行的任务内容，单击“发送”提交任务。

   机器人将自动接收到来自码道Space的反馈信息。

3. 根据反馈消息确认任务需求及关键信息，完成任务的创建。
4. 查看任务执行结果。
   • 在飞书机器人端：飞书机器人接收到来自码道Space的完成反馈，提示任务执行结束并附带产物位置。
   • 在码道Space侧：在码道Space界面的中，您可以实时查看任务执行过程及结果。