飞书接入指南

本指南将帮助您在飞书中配置 QClaw ,让您可以通过飞书与 QClaw 完成互联。

一、前置条件

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

  • 已在电脑上安装 QClaw
  • 拥有一个飞书企业账号(需要有创建应用的权限)

二、流程指引

整体流程

在飞书中使用创建企业自建应用 -> 获取App ID 和 App Secret并填入QClaw

详细步骤

1、在飞书开放平台中获取App ID 和 App Secret

(1)登录飞书账号(建议登录个人账号,如果是企业账号,后续步骤需要企业管理员审核),登录成功后,点击【创建企业自建应用】

注意:不要用Lark登录

(2)填写应用信息后,提交「创建」,应用创建成功后,会自动跳转到应用详情页面

(3)在应用详情页的「添加应用能力」区域,找到「机器人」卡片,点击「添加」

(4)在应用详情页左侧菜单中,点击「权限管理」,然后选择「批量导入 / 导出权限」

(5)在弹出的窗口中:清空输入框中的所有内容,将下方的权限列表完整复制并粘贴进去,点击「下一步,确定新增权限」「申请开通」

{
  "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"
    ]
  }
}

注意:

代码如果出现格式错误,确认一下是不是创建成“商店应用”了

等待几秒钟,页面会显示权限已成功添加,点击右下角「确认」。

(6)在应用详情页左侧菜单中,点击「凭证与基础信息」。在页面中,即可获取App ID 和 App Secret

2、关联飞书与QClaw

(1)打开 QClaw,点击左下角设置按钮,进入「远控通道」

(2)选择「飞书」,点击「配置」

(3)填入刚才复制的 App ID 和 App Secret,点击「连接」完成绑定

3、飞书应用创建版本

注意:

需要与QClaw连接成功后,返回飞书创建版本才可以成功实现信息互通~

(1)配置飞书事件回调(需要告诉飞书将消息发送到哪里):返回飞书开放平台,进入应用详情页,在左侧菜单中,点击「事件与回调」,点击订阅方式旁编辑按钮

(2)选择订阅方式为「使用 长连接 接收事件」,再点击「保存」

(3)在「事件配置」区域,点击「添加事件」,搜索并添加「接收消息」事件。

(4)切换到「回调配置」页签,选择订阅方式为「使用 长连接 接收事件」,再点击「保存」

(5)在「回调配置」区域,点击「添加回调」,搜索「卡片回传交互」,点击「添加」,

(6)点击页面上方的「创建版本」按钮。在弹出的窗口中填写版本号(示例:1.0.0)、版本描述(首次发布),点击「确定」创建版本。

注意:

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

4、开始使用

(1)飞书列表中「开发者小助手」会推送“应用审批通路,已发布成功”,点击「打开应用」开始使用。

或在飞书的搜索框中,输入刚才创建的机器人名称进行搜索。点击机器人进入对话窗口。

(2)发送一条简单消息(例如“你好”)进行连通测试。如果配置正确,QClaw 会接收到消息并在飞书中返回回复。

说明:

如果机器人能够正常回复,说明您已成功完成 QClaw与飞书的对接🎊

三、常见问题

1、机器人没有响应怎么办?

(1)检查应用状态:确认应用已成功发布

(2)检查 QClaw:确保电脑上的 QClaw 正在运行

(3)检查网络连接:确保电脑能够正常访问网络

2、收不到消息怎么办?

(1)确认已添加「接收消息」事件

(2)确认已配置「卡片回传交互」回调