DataClaw集成飞书

更新时间:
复制为 MD 格式

创建飞书应用

  1. 访问飞书开放平台/Lark开放平台,单击创建企业自建应用,填写应用名称和描述,选择应用图标,单击创建

  2. 左侧导航栏单击凭证与基础信息 页面,复制App ID(格式如 cli_xxx)和App Secret

  3. 左侧导航栏单击 权限管理 页面,点击批量导入/导出权限 按钮,粘贴以下 JSON 配置,单击下一步,确认新增权限,单击申请开通

    JSON配置文件内容

    {
      "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"
        ]
      }
    }
  4. 左侧导航栏中单击添加应用能力, 选择按能力添加页签,找到机器人卡片,单击配置

    image

  5. 配置事件订阅。

    1. 返回DataWorks控制台,创建DataClaw实例,详情参见:DataClaw配置指南

    2. 在飞书开放平台左侧导航栏单击事件与回调,在事件配置页签中单击订阅方式,选择使用 长连接 接收事件,单击保存

    3. 在事件配置页面,单击添加事件,选择“应用身份订阅”页签,搜索“消息”并勾选“接收消息”、“消息被reaction”及“消息被取消reaction”三个事件,单击“确认添加”按钮。

  6. 版本管理与发布 页面创建版本,填写应用版本号更新说明,单击保存,提交审核并发布。

配置机器人

可以创建群聊或在已有群聊中添加机器人,在飞书群中@机器人进行对话,或通过搜索的方式与机器人私聊进行测试。

若需在外部群中使用机器人,可参考配置文档机器人支持外部群和外部用户单聊
  1. 按照添加路径添加机器人:··· > 设置 > 群机器人 > 添加机器人

  2. 单击机器人头像,单击发送消息,可向机器人私发一条消息,@机器人可在群中向机器人发送消息。