mirror of
https://github.com/lobehub/lobehub.git
synced 2026-03-26 13:19:34 +07:00
📝 docs: spilit feishu with lark and update overview (#13165)
chore: spilit feishu with lark and update overview
This commit is contained in:
@@ -1,45 +1,42 @@
|
||||
---
|
||||
title: Connect LobeHub to Feishu / Lark
|
||||
title: Connect LobeHub to Feishu (飞书)
|
||||
description: >-
|
||||
Learn how to create a Feishu (Lark) custom app and connect it to your LobeHub
|
||||
Learn how to create a Feishu custom app and connect it to your LobeHub
|
||||
agent as a message channel, enabling your AI assistant to interact with team
|
||||
members in Feishu or Lark chats.
|
||||
members in Feishu chats.
|
||||
tags:
|
||||
- Feishu
|
||||
- Lark
|
||||
- 飞书
|
||||
- Message Channels
|
||||
- Bot Setup
|
||||
- Integration
|
||||
---
|
||||
|
||||
# Connect LobeHub to Feishu / Lark
|
||||
# Connect LobeHub to Feishu (飞书)
|
||||
|
||||
<Callout type={'info'}>
|
||||
This feature is currently in development and may not be fully stable. You can enable it by turning on **Developer Mode** in **Settings** → **Advanced Settings** → **Developer Mode**.
|
||||
</Callout>
|
||||
|
||||
By connecting a Feishu (or Lark) channel to your LobeHub agent, team members can interact with the AI assistant directly in Feishu private chats and group conversations.
|
||||
By connecting a Feishu channel to your LobeHub agent, team members can interact with the AI assistant directly in Feishu private chats and group conversations.
|
||||
|
||||
> Feishu is the Chinese version, and Lark is the international version. The setup process is identical — just use the corresponding platform portal.
|
||||
> If you are using the international version (Lark), please refer to the [Lark setup guide](/docs/usage/channels/lark).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A LobeHub account with an active subscription
|
||||
- A Feishu or Lark account with permissions to create enterprise apps
|
||||
- A Feishu account with permissions to create enterprise apps
|
||||
|
||||
## Step 1: Create a Feishu / Lark App
|
||||
## Step 1: Create a Feishu App
|
||||
|
||||
<Steps>
|
||||
### Open the Developer Portal
|
||||
|
||||
- **Feishu:** Visit [open.feishu.cn/app](https://open.feishu.cn/app)
|
||||
- **Lark:** Visit [open.larksuite.com/app](https://open.larksuite.com/app)
|
||||
|
||||
Sign in with your account.
|
||||
Visit [open.feishu.cn/app](https://open.feishu.cn/app) and sign in with your account.
|
||||
|
||||
### Create an Enterprise App
|
||||
|
||||
Click **Create Enterprise App**. Fill in the app name (e.g., "LobeHub Assistant"), description, and icon, then submit the form.
|
||||
Click **Create Enterprise App**. Fill in the app name (e.g., "LobeHub 助手"), description, and icon, then submit the form.
|
||||
|
||||
### Copy App Credentials
|
||||
|
||||
@@ -90,28 +87,24 @@ By connecting a Feishu (or Lark) channel to your LobeHub agent, team members can
|
||||
}
|
||||
```
|
||||
|
||||
<Callout type={'warning'}>
|
||||
The JSON above is for **Feishu (飞书)**. If you are using **Lark (international)**, some scopes may not be available (e.g. `aily:*`, `corehr:*`, `im:chat.access_event.bot_p2p_chat:read`). Remove any scopes that the batch import rejects.
|
||||
</Callout>
|
||||
|
||||
### Enable Bot Capability
|
||||
|
||||
Go to **App Capability** → **Bot**. Toggle the bot capability on and set your preferred bot name.
|
||||
</Steps>
|
||||
|
||||
## Step 3: Configure Feishu / Lark in LobeHub
|
||||
## Step 3: Configure Feishu in LobeHub
|
||||
|
||||
<Steps>
|
||||
### Open Channel Settings
|
||||
|
||||
In LobeHub, navigate to your agent's settings, then select the **Channels** tab. Click **飞书** (Feishu) or **Lark** from the platform list.
|
||||
In LobeHub, navigate to your agent's settings, then select the **Channels** tab. Click **飞书** (Feishu) from the platform list.
|
||||
|
||||
### Fill in App Credentials
|
||||
|
||||
Enter the following fields:
|
||||
|
||||
- **App ID** — The App ID from your Feishu/Lark app
|
||||
- **App Secret** — The App Secret from your Feishu/Lark app
|
||||
- **App ID** — The App ID from your Feishu app
|
||||
- **App Secret** — The App Secret from your Feishu app
|
||||
|
||||
> You don't need to fill in **Verification Token** or **Encrypt Key** at this point — you can set them up after configuring the Event Subscription in Step 4.
|
||||
|
||||
@@ -120,12 +113,12 @@ By connecting a Feishu (or Lark) channel to your LobeHub agent, team members can
|
||||
Click **Save Configuration**. After saving, an **Event Subscription URL** will be displayed. Copy this URL — you will need it in the next step.
|
||||
</Steps>
|
||||
|
||||
## Step 4: Set Up Event Subscription in Feishu / Lark
|
||||
## Step 4: Set Up Event Subscription in Feishu
|
||||
|
||||
<Steps>
|
||||
### Open Event Subscription Settings
|
||||
|
||||
Go back to your app in the Feishu/Lark Developer Portal. Navigate to **Event Subscription**.
|
||||
Go back to your app in the Feishu Developer Portal. Navigate to **Event Subscription**.
|
||||
|
||||
### Configure the Request URL
|
||||
|
||||
@@ -145,7 +138,7 @@ By connecting a Feishu (or Lark) channel to your LobeHub agent, team members can
|
||||
|
||||
Go back to LobeHub's channel settings and fill in:
|
||||
|
||||
- **Verification Token** — Used to verify that webhook events originate from Feishu/Lark
|
||||
- **Verification Token** — Used to verify that webhook events originate from Feishu
|
||||
- **Encrypt Key** (optional) — Used to decrypt encrypted event payloads
|
||||
|
||||
Click **Save Configuration** again to apply.
|
||||
@@ -165,21 +158,21 @@ By connecting a Feishu (or Lark) channel to your LobeHub agent, team members can
|
||||
|
||||
## Step 6: Test the Connection
|
||||
|
||||
Back in LobeHub's channel settings, click **Test Connection** to verify the credentials. Then find your bot in Feishu/Lark by searching its name and send it a message to confirm it responds.
|
||||
Back in LobeHub's channel settings, click **Test Connection** to verify the credentials. Then find your bot in Feishu by searching its name and send it a message to confirm it responds.
|
||||
|
||||
## Configuration Reference
|
||||
|
||||
| Field | Required | Description |
|
||||
| -------------------------- | -------- | -------------------------------------------------------------------- |
|
||||
| **App ID** | Yes | Your Feishu/Lark app's App ID (`cli_xxx`) |
|
||||
| **App Secret** | Yes | Your Feishu/Lark app's App Secret |
|
||||
| **Verification Token** | No | Verifies webhook event source (recommended) |
|
||||
| **Encrypt Key** | No | Decrypts encrypted event payloads |
|
||||
| **Event Subscription URL** | — | Auto-generated after saving; paste into Feishu/Lark Developer Portal |
|
||||
| Field | Required | Description |
|
||||
| -------------------------- | -------- | --------------------------------------------------------------- |
|
||||
| **App ID** | Yes | Your Feishu app's App ID (`cli_xxx`) |
|
||||
| **App Secret** | Yes | Your Feishu app's App Secret |
|
||||
| **Verification Token** | No | Verifies webhook event source (recommended) |
|
||||
| **Encrypt Key** | No | Decrypts encrypted event payloads |
|
||||
| **Event Subscription URL** | — | Auto-generated after saving; paste into Feishu Developer Portal |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Event Subscription URL verification failed:** Ensure you saved the configuration in LobeHub first, and the URL was copied correctly.
|
||||
- **Bot not responding:** Verify the app is published and approved, the bot capability is enabled, and the `im.message.receive_v1` event is subscribed.
|
||||
- **Permission errors:** Confirm all required permissions are added and approved in the Developer Portal.
|
||||
- **Test Connection failed:** Double-check the App ID and App Secret. For Lark, ensure you selected "Lark" (not "飞书") in LobeHub's channel settings.
|
||||
- **Test Connection failed:** Double-check the App ID and App Secret.
|
||||
|
||||
@@ -1,39 +1,35 @@
|
||||
---
|
||||
title: 将 LobeHub 连接到飞书 / Lark
|
||||
description: 了解如何创建飞书(Lark)自定义应用并将其连接到您的 LobeHub 代理作为消息渠道,使您的 AI 助手能够在飞书或 Lark 聊天中与团队成员互动。
|
||||
title: 将 LobeHub 连接到飞书
|
||||
description: 了解如何创建飞书自定义应用并将其连接到您的 LobeHub 代理作为消息渠道,使您的 AI 助手能够在飞书聊天中与团队成员互动。
|
||||
tags:
|
||||
- 飞书
|
||||
- Lark
|
||||
- 消息渠道
|
||||
- 机器人设置
|
||||
- 集成
|
||||
---
|
||||
|
||||
# 将 LobeHub 连接到飞书 / Lark
|
||||
# 将 LobeHub 连接到飞书
|
||||
|
||||
<Callout type={'info'}>
|
||||
此功能目前正在开发中,可能尚未完全稳定。您可以通过在 **设置** → **高级设置** → **开发者模式**
|
||||
中启用 **开发者模式** 来使用此功能。
|
||||
</Callout>
|
||||
|
||||
通过将飞书(或 Lark)渠道连接到您的 LobeHub 代理,团队成员可以直接在飞书的私聊和群组对话中与 AI 助手互动。
|
||||
通过将飞书渠道连接到您的 LobeHub 代理,团队成员可以直接在飞书的私聊和群组对话中与 AI 助手互动。
|
||||
|
||||
> 飞书是中国版本,Lark 是国际版本。设置过程完全相同 —— 只需使用对应的平台门户即可。
|
||||
> 如果您使用的是国际版(Lark),请参阅 [Lark 设置指南](/docs/usage/channels/lark)。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 一个拥有有效订阅的 LobeHub 账户
|
||||
- 一个拥有创建企业应用权限的飞书或 Lark 账户
|
||||
- 一个拥有创建企业应用权限的飞书账户
|
||||
|
||||
## 第一步:创建飞书 / Lark 应用
|
||||
## 第一步:创建飞书应用
|
||||
|
||||
<Steps>
|
||||
### 打开开发者门户
|
||||
|
||||
- **飞书:** 访问 [open.feishu.cn/app](https://open.feishu.cn/app)
|
||||
- **Lark:** 访问 [open.larksuite.com/app](https://open.larksuite.com/app)
|
||||
|
||||
使用您的账户登录。
|
||||
访问 [open.feishu.cn/app](https://open.feishu.cn/app) 并使用您的账户登录。
|
||||
|
||||
### 创建企业应用
|
||||
|
||||
@@ -88,47 +84,38 @@ tags:
|
||||
}
|
||||
```
|
||||
|
||||
<Callout type={'warning'}>
|
||||
以上 JSON 适用于**飞书**。如果您使用的是 **Lark(国际版)**,部分权限码可能不可用(如 `aily:*`、`corehr:*`、`im:chat.access_event.bot_p2p_chat:read`)。请移除批量导入时提示无效的权限码。
|
||||
</Callout>
|
||||
|
||||
### 启用机器人功能
|
||||
|
||||
进入 **应用能力** → **机器人**。开启机器人功能并设置您喜欢的机器人名称。
|
||||
</Steps>
|
||||
|
||||
## 第三步:在 LobeHub 中配置飞书 / Lark
|
||||
## 第三步:在 LobeHub 中配置飞书
|
||||
|
||||
<Steps>
|
||||
### 打开渠道设置
|
||||
|
||||
在 LobeHub 中,导航到您的代理设置,然后选择 **渠道** 标签。点击平台列表中的 **飞书** 或 **Lark**。
|
||||
在 LobeHub 中,导航到您的代理设置,然后选择 **渠道** 标签。点击平台列表中的 **飞书**。
|
||||
|
||||
### 填写应用凭证
|
||||
|
||||
输入以下字段:
|
||||
|
||||
- **应用 ID** — 来自飞书 / Lark 应用的应用 ID
|
||||
- **应用密钥** — 来自飞书 / Lark 应用的应用密钥
|
||||
- **Verification Token** — 用于验证 webhook 事件是否来自飞书 / Lark
|
||||
- **应用 ID** — 来自飞书应用的应用 ID
|
||||
- **应用密钥** — 来自飞书应用的应用密钥
|
||||
|
||||
您还可以选择配置以下内容:
|
||||
|
||||
- **Encrypt Key** — 用于解密飞书 / Lark 的加密事件负载
|
||||
|
||||
> Verification Token 和 Encrypt Key 可以在飞书 / Lark 开发者门户的 **事件订阅** → **加密策略** 中找到(位于页面顶部)。如果您还没有打开过事件订阅页面,可以在完成第四步后再回来填写 Verification Token。
|
||||
> 此时您不需要填写 **Verification Token** 或 **Encrypt Key** —— 可以在完成第四步配置事件订阅后再设置。
|
||||
|
||||
### 保存并复制 Webhook URL
|
||||
|
||||
点击 **保存配置**。保存后,将显示一个 **事件订阅 URL**。复制此 URL—— 您将在下一步中需要它。
|
||||
</Steps>
|
||||
|
||||
## 第四步:在飞书 / Lark 中设置事件订阅
|
||||
## 第四步:在飞书中设置事件订阅
|
||||
|
||||
<Steps>
|
||||
### 打开事件订阅设置
|
||||
|
||||
返回飞书 / Lark 开发者门户中的应用。导航到 **事件订阅**。
|
||||
返回飞书开发者门户中的应用。导航到 **事件订阅**。
|
||||
|
||||
### 配置请求 URL
|
||||
|
||||
@@ -141,6 +128,17 @@ tags:
|
||||
- `im.message.receive_v1` — 当收到消息时触发
|
||||
|
||||
这将使您的应用能够接收消息并将其转发到 LobeHub。
|
||||
|
||||
### (推荐)填写 Verification Token 和 Encrypt Key
|
||||
|
||||
配置事件订阅后,您可以在事件订阅页面顶部的 **加密策略** 中找到 **Verification Token** 和 **Encrypt Key**。
|
||||
|
||||
返回 LobeHub 的渠道设置,填写:
|
||||
|
||||
- **Verification Token** — 用于验证 webhook 事件是否来自飞书
|
||||
- **Encrypt Key**(可选)— 用于解密加密事件负载
|
||||
|
||||
再次点击 **保存配置** 以应用。
|
||||
</Steps>
|
||||
|
||||
## 第五步:发布应用
|
||||
@@ -157,21 +155,21 @@ tags:
|
||||
|
||||
## 第六步:测试连接
|
||||
|
||||
回到 LobeHub 的渠道设置,点击 **测试连接** 以验证凭证。然后在飞书 / Lark 中搜索您的机器人名称并发送消息,确认其是否响应。
|
||||
回到 LobeHub 的渠道设置,点击 **测试连接** 以验证凭证。然后在飞书中搜索您的机器人名称并发送消息,确认其是否响应。
|
||||
|
||||
## 配置参考
|
||||
|
||||
| 字段 | 是否必需 | 描述 |
|
||||
| ---------------------- | ---- | ------------------------------- |
|
||||
| **应用 ID** | 是 | 您的飞书 / Lark 应用的应用 ID(`cli_xxx`) |
|
||||
| **应用密钥** | 是 | 您的飞书 / Lark 应用的应用密钥 |
|
||||
| **Verification Token** | 是 | 验证 webhook 事件来源 |
|
||||
| **Encrypt Key** | 否 | 解密加密事件负载 |
|
||||
| **事件订阅 URL** | — | 保存后自动生成;粘贴到飞书 / Lark 开发者门户 |
|
||||
| 字段 | 是否必需 | 描述 |
|
||||
| ---------------------- | ---- | ----------------------- |
|
||||
| **应用 ID** | 是 | 您的飞书应用的应用 ID(`cli_xxx`) |
|
||||
| **应用密钥** | 是 | 您的飞书应用的应用密钥 |
|
||||
| **Verification Token** | 否 | 验证 webhook 事件来源(推荐) |
|
||||
| **Encrypt Key** | 否 | 解密加密事件负载 |
|
||||
| **事件订阅 URL** | — | 保存后自动生成;粘贴到飞书开发者门户 |
|
||||
|
||||
## 故障排除
|
||||
|
||||
- **事件订阅 URL 验证失败:** 确保您已在 LobeHub 中保存配置,并正确复制了 URL。
|
||||
- **机器人未响应:** 验证应用已发布并获得批准,机器人功能已启用,并订阅了 `im.message.receive_v1` 事件。
|
||||
- **权限错误:** 确保所有所需权限已在开发者门户中添加并获得批准。
|
||||
- **测试连接失败:** 仔细检查应用 ID 和应用密钥。对于 Lark,请确保您在 LobeHub 的渠道设置中选择了 "Lark"(而不是 "飞书")。
|
||||
- **测试连接失败:** 仔细检查应用 ID 和应用密钥。
|
||||
|
||||
173
docs/usage/channels/lark.mdx
Normal file
173
docs/usage/channels/lark.mdx
Normal file
@@ -0,0 +1,173 @@
|
||||
---
|
||||
title: Connect LobeHub to Lark
|
||||
description: >-
|
||||
Learn how to create a Lark custom app and connect it to your LobeHub
|
||||
agent as a message channel, enabling your AI assistant to interact with team
|
||||
members in Lark chats.
|
||||
tags:
|
||||
- Lark
|
||||
- Message Channels
|
||||
- Bot Setup
|
||||
- Integration
|
||||
---
|
||||
|
||||
# Connect LobeHub to Lark
|
||||
|
||||
<Callout type={'info'}>
|
||||
This feature is currently in development and may not be fully stable. You can enable it by turning on **Developer Mode** in **Settings** → **Advanced Settings** → **Developer Mode**.
|
||||
</Callout>
|
||||
|
||||
By connecting a Lark channel to your LobeHub agent, team members can interact with the AI assistant directly in Lark private chats and group conversations.
|
||||
|
||||
> If you are using the Chinese version (飞书), please refer to the [Feishu setup guide](/docs/usage/channels/feishu).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A LobeHub account with an active subscription
|
||||
- A Lark account with permissions to create enterprise apps
|
||||
|
||||
## Step 1: Create a Lark App
|
||||
|
||||
<Steps>
|
||||
### Open the Developer Portal
|
||||
|
||||
Visit [open.larksuite.com/app](https://open.larksuite.com/app) and sign in with your account.
|
||||
|
||||
### Create an Enterprise App
|
||||
|
||||
Click **Create Enterprise App**. Fill in the app name (e.g., "LobeHub Assistant"), description, and icon, then submit the form.
|
||||
|
||||
### Copy App Credentials
|
||||
|
||||
Go to **Credentials & Basic Info** and copy:
|
||||
|
||||
- **App ID** (format: `cli_xxx`)
|
||||
- **App Secret**
|
||||
|
||||
> **Important:** Keep your App Secret confidential. Never share it publicly.
|
||||
</Steps>
|
||||
|
||||
## Step 2: Configure App Permissions and Bot
|
||||
|
||||
<Steps>
|
||||
### Import Required Permissions
|
||||
|
||||
In your app settings, go to **Permissions & Scopes**, click **Batch Import**, and paste the JSON below to grant the bot all necessary permissions.
|
||||
|
||||
```json
|
||||
{
|
||||
"scopes": {
|
||||
"tenant": [
|
||||
"application:application.app_message_stats.overview:readonly",
|
||||
"application:application:self_manage",
|
||||
"application:bot.menu:write",
|
||||
"cardkit:card:read",
|
||||
"cardkit:card:write",
|
||||
"contact:user.employee_id:readonly",
|
||||
"event:ip_list",
|
||||
"im:chat.members:bot_access",
|
||||
"im:message",
|
||||
"im:message.group_at_msg:readonly",
|
||||
"im:message.p2p_msg:readonly",
|
||||
"im:message:readonly",
|
||||
"im:message:send_as_bot",
|
||||
"im:resource"
|
||||
],
|
||||
"user": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Callout type={'info'}>
|
||||
The scopes above are tailored for Lark (international). Some Feishu-specific scopes (e.g. `aily:*`, `corehr:*`, `im:chat.access_event.bot_p2p_chat:read`) are not available on Lark and have been excluded.
|
||||
</Callout>
|
||||
|
||||
### Enable Bot Capability
|
||||
|
||||
Go to **App Capability** → **Bot**. Toggle the bot capability on and set your preferred bot name.
|
||||
</Steps>
|
||||
|
||||
## Step 3: Configure Lark in LobeHub
|
||||
|
||||
<Steps>
|
||||
### Open Channel Settings
|
||||
|
||||
In LobeHub, navigate to your agent's settings, then select the **Channels** tab. Click **Lark** from the platform list.
|
||||
|
||||
### Fill in App Credentials
|
||||
|
||||
Enter the following fields:
|
||||
|
||||
- **App ID** — The App ID from your Lark app
|
||||
- **App Secret** — The App Secret from your Lark app
|
||||
|
||||
> You don't need to fill in **Verification Token** or **Encrypt Key** at this point — you can set them up after configuring the Event Subscription in Step 4.
|
||||
|
||||
### Save and Copy the Webhook URL
|
||||
|
||||
Click **Save Configuration**. After saving, an **Event Subscription URL** will be displayed. Copy this URL — you will need it in the next step.
|
||||
</Steps>
|
||||
|
||||
## Step 4: Set Up Event Subscription in Lark
|
||||
|
||||
<Steps>
|
||||
### Open Event Subscription Settings
|
||||
|
||||
Go back to your app in the Lark Developer Portal. Navigate to **Event Subscription**.
|
||||
|
||||
### Configure the Request URL
|
||||
|
||||
Paste the **Event Subscription URL** you copied from LobeHub into the **Request URL** field. The platform will verify the endpoint automatically.
|
||||
|
||||
### Add the Message Event
|
||||
|
||||
Add the following event:
|
||||
|
||||
- `im.message.receive_v1` — Triggered when a message is received
|
||||
|
||||
This allows your app to receive messages and forward them to LobeHub.
|
||||
|
||||
### (Recommended) Fill in Verification Token and Encrypt Key
|
||||
|
||||
After configuring Event Subscription, you can find the **Verification Token** and **Encrypt Key** at the top of the Event Subscription page under **Encryption Strategy**.
|
||||
|
||||
Go back to LobeHub's channel settings and fill in:
|
||||
|
||||
- **Verification Token** — Used to verify that webhook events originate from Lark
|
||||
- **Encrypt Key** (optional) — Used to decrypt encrypted event payloads
|
||||
|
||||
Click **Save Configuration** again to apply.
|
||||
</Steps>
|
||||
|
||||
## Step 5: Publish the App
|
||||
|
||||
<Steps>
|
||||
### Create a Version
|
||||
|
||||
In your app settings, go to **Version Management & Release**. Create a new version with release notes.
|
||||
|
||||
### Submit for Review
|
||||
|
||||
Submit the version for review and publish. For enterprise self-managed apps, approval is typically automatic.
|
||||
</Steps>
|
||||
|
||||
## Step 6: Test the Connection
|
||||
|
||||
Back in LobeHub's channel settings, click **Test Connection** to verify the credentials. Then find your bot in Lark by searching its name and send it a message to confirm it responds.
|
||||
|
||||
## Configuration Reference
|
||||
|
||||
| Field | Required | Description |
|
||||
| -------------------------- | -------- | ------------------------------------------------------------- |
|
||||
| **App ID** | Yes | Your Lark app's App ID (`cli_xxx`) |
|
||||
| **App Secret** | Yes | Your Lark app's App Secret |
|
||||
| **Verification Token** | No | Verifies webhook event source (recommended) |
|
||||
| **Encrypt Key** | No | Decrypts encrypted event payloads |
|
||||
| **Event Subscription URL** | — | Auto-generated after saving; paste into Lark Developer Portal |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Event Subscription URL verification failed:** Ensure you saved the configuration in LobeHub first, and the URL was copied correctly.
|
||||
- **Bot not responding:** Verify the app is published and approved, the bot capability is enabled, and the `im.message.receive_v1` event is subscribed.
|
||||
- **Permission errors:** Confirm all required permissions are added and approved in the Developer Portal.
|
||||
- **Test Connection failed:** Double-check the App ID and App Secret. Make sure you selected "Lark" (not "飞书") in LobeHub's channel settings.
|
||||
171
docs/usage/channels/lark.zh-CN.mdx
Normal file
171
docs/usage/channels/lark.zh-CN.mdx
Normal file
@@ -0,0 +1,171 @@
|
||||
---
|
||||
title: 将 LobeHub 连接到 Lark
|
||||
description: 了解如何创建 Lark 自定义应用并将其连接到您的 LobeHub 代理作为消息渠道,使您的 AI 助手能够在 Lark 聊天中与团队成员互动。
|
||||
tags:
|
||||
- Lark
|
||||
- 消息渠道
|
||||
- 机器人设置
|
||||
- 集成
|
||||
---
|
||||
|
||||
# 将 LobeHub 连接到 Lark
|
||||
|
||||
<Callout type={'info'}>
|
||||
此功能目前正在开发中,可能尚未完全稳定。您可以通过在 **设置** → **高级设置** → **开发者模式**
|
||||
中启用 **开发者模式** 来使用此功能。
|
||||
</Callout>
|
||||
|
||||
通过将 Lark 渠道连接到您的 LobeHub 代理,团队成员可以直接在 Lark 的私聊和群组对话中与 AI 助手互动。
|
||||
|
||||
> 如果您使用的是中国版(飞书),请参阅[飞书设置指南](/docs/usage/channels/feishu)。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 一个拥有有效订阅的 LobeHub 账户
|
||||
- 一个拥有创建企业应用权限的 Lark 账户
|
||||
|
||||
## 第一步:创建 Lark 应用
|
||||
|
||||
<Steps>
|
||||
### 打开开发者门户
|
||||
|
||||
访问 [open.larksuite.com/app](https://open.larksuite.com/app) 并使用您的账户登录。
|
||||
|
||||
### 创建企业应用
|
||||
|
||||
点击 **Create Enterprise App**。填写应用名称(例如 "LobeHub Assistant")、描述和图标,然后提交表单。
|
||||
|
||||
### 复制应用凭证
|
||||
|
||||
进入 **Credentials & Basic Info**,复制以下内容:
|
||||
|
||||
- **App ID**(格式:`cli_xxx`)
|
||||
- **App Secret**
|
||||
|
||||
> **重要提示:** 请妥善保管您的 App Secret。切勿公开分享。
|
||||
</Steps>
|
||||
|
||||
## 第二步:配置应用权限和机器人功能
|
||||
|
||||
<Steps>
|
||||
### 导入所需权限
|
||||
|
||||
在您的应用设置中,进入 **Permissions & Scopes**,点击 **Batch Import**,然后粘贴以下 JSON 以授予机器人所需的所有权限。
|
||||
|
||||
```json
|
||||
{
|
||||
"scopes": {
|
||||
"tenant": [
|
||||
"application:application.app_message_stats.overview:readonly",
|
||||
"application:application:self_manage",
|
||||
"application:bot.menu:write",
|
||||
"cardkit:card:read",
|
||||
"cardkit:card:write",
|
||||
"contact:user.employee_id:readonly",
|
||||
"event:ip_list",
|
||||
"im:chat.members:bot_access",
|
||||
"im:message",
|
||||
"im:message.group_at_msg:readonly",
|
||||
"im:message.p2p_msg:readonly",
|
||||
"im:message:readonly",
|
||||
"im:message:send_as_bot",
|
||||
"im:resource"
|
||||
],
|
||||
"user": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<Callout type={'info'}>
|
||||
以上权限码已针对 Lark(国际版)进行调整。部分飞书特有的权限码(如 `aily:*`、`corehr:*`、`im:chat.access_event.bot_p2p_chat:read`)在 Lark 上不可用,已被排除。
|
||||
</Callout>
|
||||
|
||||
### 启用机器人功能
|
||||
|
||||
进入 **App Capability** → **Bot**。开启机器人功能并设置您喜欢的机器人名称。
|
||||
</Steps>
|
||||
|
||||
## 第三步:在 LobeHub 中配置 Lark
|
||||
|
||||
<Steps>
|
||||
### 打开渠道设置
|
||||
|
||||
在 LobeHub 中,导航到您的代理设置,然后选择 **渠道** 标签。点击平台列表中的 **Lark**。
|
||||
|
||||
### 填写应用凭证
|
||||
|
||||
输入以下字段:
|
||||
|
||||
- **App ID** — 来自 Lark 应用的 App ID
|
||||
- **App Secret** — 来自 Lark 应用的 App Secret
|
||||
|
||||
> 此时您不需要填写 **Verification Token** 或 **Encrypt Key** —— 可以在完成第四步配置事件订阅后再设置。
|
||||
|
||||
### 保存并复制 Webhook URL
|
||||
|
||||
点击 **Save Configuration**。保存后,将显示一个 **Event Subscription URL**。复制此 URL —— 您将在下一步中需要它。
|
||||
</Steps>
|
||||
|
||||
## 第四步:在 Lark 中设置事件订阅
|
||||
|
||||
<Steps>
|
||||
### 打开事件订阅设置
|
||||
|
||||
返回 Lark 开发者门户中的应用。导航到 **Event Subscription**。
|
||||
|
||||
### 配置请求 URL
|
||||
|
||||
将您从 LobeHub 复制的 **Event Subscription URL** 粘贴到 **Request URL** 字段中。平台会自动验证端点。
|
||||
|
||||
### 添加消息事件
|
||||
|
||||
添加以下事件:
|
||||
|
||||
- `im.message.receive_v1` — 当收到消息时触发
|
||||
|
||||
这将使您的应用能够接收消息并将其转发到 LobeHub。
|
||||
|
||||
### (推荐)填写 Verification Token 和 Encrypt Key
|
||||
|
||||
配置事件订阅后,您可以在事件订阅页面顶部的 **Encryption Strategy** 中找到 **Verification Token** 和 **Encrypt Key**。
|
||||
|
||||
返回 LobeHub 的渠道设置,填写:
|
||||
|
||||
- **Verification Token** — 用于验证 webhook 事件是否来自 Lark
|
||||
- **Encrypt Key**(可选)— 用于解密加密事件负载
|
||||
|
||||
再次点击 **Save Configuration** 以应用。
|
||||
</Steps>
|
||||
|
||||
## 第五步:发布应用
|
||||
|
||||
<Steps>
|
||||
### 创建版本
|
||||
|
||||
在您的应用设置中,进入 **Version Management & Release**。创建一个新版本并填写发布说明。
|
||||
|
||||
### 提交审核
|
||||
|
||||
提交版本进行审核并发布。对于企业自管理应用,通常会自动批准。
|
||||
</Steps>
|
||||
|
||||
## 第六步:测试连接
|
||||
|
||||
回到 LobeHub 的渠道设置,点击 **Test Connection** 以验证凭证。然后在 Lark 中搜索您的机器人名称并发送消息,确认其是否响应。
|
||||
|
||||
## 配置参考
|
||||
|
||||
| 字段 | 是否必需 | 描述 |
|
||||
| -------------------------- | ---- | ----------------------------- |
|
||||
| **App ID** | 是 | 您的 Lark 应用的 App ID(`cli_xxx`) |
|
||||
| **App Secret** | 是 | 您的 Lark 应用的 App Secret |
|
||||
| **Verification Token** | 否 | 验证 webhook 事件来源(推荐) |
|
||||
| **Encrypt Key** | 否 | 解密加密事件负载 |
|
||||
| **Event Subscription URL** | — | 保存后自动生成;粘贴到 Lark 开发者门户 |
|
||||
|
||||
## 故障排除
|
||||
|
||||
- **Event Subscription URL 验证失败:** 确保您已在 LobeHub 中保存配置,并正确复制了 URL。
|
||||
- **机器人未响应:** 验证应用已发布并获得批准,机器人功能已启用,并订阅了 `im.message.receive_v1` 事件。
|
||||
- **权限错误:** 确保所有所需权限已在开发者门户中添加并获得批准。
|
||||
- **测试连接失败:** 仔细检查 App ID 和 App Secret。确保您在 LobeHub 的渠道设置中选择了 "Lark"(而不是 "飞书")。
|
||||
@@ -2,14 +2,16 @@
|
||||
title: Channels Overview
|
||||
description: >-
|
||||
Connect your LobeHub agents to external messaging platforms like Discord,
|
||||
Telegram, and Feishu/Lark, allowing users to interact with AI assistants
|
||||
directly in their favorite chat apps.
|
||||
Slack, Telegram, QQ, Feishu, and Lark, allowing users to interact with AI
|
||||
assistants directly in their favorite chat apps.
|
||||
tags:
|
||||
- Channels
|
||||
- Message Channels
|
||||
- Integration
|
||||
- Discord
|
||||
- Slack
|
||||
- Telegram
|
||||
- QQ
|
||||
- Feishu
|
||||
- Lark
|
||||
---
|
||||
@@ -24,18 +26,21 @@ Channels allow you to connect your LobeHub agents to external messaging platform
|
||||
|
||||
## Supported Platforms
|
||||
|
||||
| Platform | Description |
|
||||
| -------------------------------------------- | --------------------------------------------------------------- |
|
||||
| [Discord](/docs/usage/channels/discord) | Connect to Discord servers for channel chat and direct messages |
|
||||
| [Telegram](/docs/usage/channels/telegram) | Connect to Telegram for private and group conversations |
|
||||
| [Feishu / Lark](/docs/usage/channels/feishu) | Connect to Feishu (飞书) or Lark for team collaboration |
|
||||
| Platform | Description |
|
||||
| ------------------------------------------ | --------------------------------------------------------------- |
|
||||
| [Discord](/docs/usage/channels/discord) | Connect to Discord servers for channel chat and direct messages |
|
||||
| [Slack](/docs/usage/channels/slack) | Connect to Slack for channel and direct message conversations |
|
||||
| [Telegram](/docs/usage/channels/telegram) | Connect to Telegram for private and group conversations |
|
||||
| [QQ](/docs/usage/channels/qq) | Connect to QQ for group chats and direct messages |
|
||||
| [Feishu (飞书)](/docs/usage/channels/feishu) | Connect to Feishu for team collaboration (Chinese version) |
|
||||
| [Lark](/docs/usage/channels/lark) | Connect to Lark for team collaboration (international version) |
|
||||
|
||||
## How It Works
|
||||
|
||||
Each channel integration works by linking a bot account on the target platform to a LobeHub agent. When a user sends a message to the bot, LobeHub processes it through the agent and sends the response back to the same conversation.
|
||||
|
||||
- **Per-agent configuration** — Each agent can have its own set of channel connections, so different agents can serve different platforms or communities.
|
||||
- **Multiple channels simultaneously** — A single agent can be connected to Discord, Telegram, and Feishu/Lark at the same time. LobeHub routes messages to the correct agent automatically.
|
||||
- **Multiple channels simultaneously** — A single agent can be connected to Discord, Slack, Telegram, QQ, Feishu, and Lark at the same time. LobeHub routes messages to the correct agent automatically.
|
||||
- **Secure credential storage** — All bot tokens and app secrets are encrypted before being stored.
|
||||
|
||||
## Getting Started
|
||||
@@ -44,17 +49,20 @@ Each channel integration works by linking a bot account on the target platform t
|
||||
2. Navigate to your agent's settings and select the **Channels** tab
|
||||
3. Choose a platform and follow the setup guide:
|
||||
- [Discord](/docs/usage/channels/discord)
|
||||
- [Slack](/docs/usage/channels/slack)
|
||||
- [Telegram](/docs/usage/channels/telegram)
|
||||
- [Feishu / Lark](/docs/usage/channels/feishu)
|
||||
- [QQ](/docs/usage/channels/qq)
|
||||
- [Feishu (飞书)](/docs/usage/channels/feishu)
|
||||
- [Lark](/docs/usage/channels/lark)
|
||||
|
||||
## Feature Support
|
||||
|
||||
Text messages are supported across all platforms. Some features vary by platform:
|
||||
|
||||
| Feature | Discord | Telegram | Feishu / Lark |
|
||||
| ---------------------- | ------- | -------- | ------------- |
|
||||
| Text messages | Yes | Yes | Yes |
|
||||
| Direct messages | Yes | Yes | Yes |
|
||||
| Group chats | Yes | Yes | Yes |
|
||||
| Reactions | Yes | Yes | Partial |
|
||||
| Image/file attachments | Yes | Yes | Yes |
|
||||
| Feature | Discord | Slack | Telegram | QQ | Feishu | Lark |
|
||||
| ---------------------- | ------- | ----- | -------- | --- | ------- | ------- |
|
||||
| Text messages | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Direct messages | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Group chats | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
| Reactions | Yes | Yes | Yes | No | Partial | Partial |
|
||||
| Image/file attachments | Yes | Yes | Yes | Yes | Yes | Yes |
|
||||
|
||||
@@ -1,12 +1,14 @@
|
||||
---
|
||||
title: 渠道概览
|
||||
description: 将 LobeHub 代理连接到外部消息平台,如 Discord、Telegram 和飞书/Lark,让用户可以直接在他们喜欢的聊天应用中与 AI 助手互动。
|
||||
description: 将 LobeHub 代理连接到外部消息平台,如 Discord、Slack、Telegram、QQ、飞书和 Lark,让用户可以直接在他们喜欢的聊天应用中与 AI 助手互动。
|
||||
tags:
|
||||
- 渠道
|
||||
- 消息渠道
|
||||
- 集成
|
||||
- Discord
|
||||
- Slack
|
||||
- Telegram
|
||||
- QQ
|
||||
- 飞书
|
||||
- Lark
|
||||
---
|
||||
@@ -21,18 +23,21 @@ tags:
|
||||
|
||||
## 支持的平台
|
||||
|
||||
| 平台 | 描述 |
|
||||
| ----------------------------------------- | -------------------------- |
|
||||
| [Discord](/docs/usage/channels/discord) | 连接到 Discord 服务器,用于频道聊天和私信 |
|
||||
| [Telegram](/docs/usage/channels/telegram) | 连接到 Telegram,用于私人和群组对话 |
|
||||
| [飞书 / Lark](/docs/usage/channels/feishu) | 连接到飞书(Feishu)或 Lark,用于团队协作 |
|
||||
| 平台 | 描述 |
|
||||
| ----------------------------------------- | ------------------------- |
|
||||
| [Discord](/docs/usage/channels/discord) | 连接到 Discord 服务器,用于频道聊天和私信 |
|
||||
| [Slack](/docs/usage/channels/slack) | 连接到 Slack,用于频道和私信对话 |
|
||||
| [Telegram](/docs/usage/channels/telegram) | 连接到 Telegram,用于私人和群组对话 |
|
||||
| [QQ](/docs/usage/channels/qq) | 连接到 QQ,用于群聊和私信 |
|
||||
| [飞书](/docs/usage/channels/feishu) | 连接到飞书,用于团队协作(中国版) |
|
||||
| [Lark](/docs/usage/channels/lark) | 连接到 Lark,用于团队协作(国际版) |
|
||||
|
||||
## 工作原理
|
||||
|
||||
每个渠道集成都通过将目标平台上的机器人账户与 LobeHub 代理连接来实现。当用户向机器人发送消息时,LobeHub 会通过代理处理消息并将响应发送回同一对话。
|
||||
|
||||
- **按代理配置** — 每个代理可以拥有自己的一组渠道连接,因此不同的代理可以服务于不同的平台或社区。
|
||||
- **同时支持多个渠道** — 单个代理可以同时连接到 Discord、Telegram 和飞书 / Lark。LobeHub 会自动将消息路由到正确的代理。
|
||||
- **同时支持多个渠道** — 单个代理可以同时连接到 Discord、Slack、Telegram、QQ、飞书和 Lark。LobeHub 会自动将消息路由到正确的代理。
|
||||
- **安全的凭据存储** — 所有机器人令牌和应用密钥在存储前都会被加密。
|
||||
|
||||
## 快速开始
|
||||
@@ -41,17 +46,20 @@ tags:
|
||||
2. 前往您的代理设置页面,选择 **渠道** 标签
|
||||
3. 选择一个平台并按照设置指南操作:
|
||||
- [Discord](/docs/usage/channels/discord)
|
||||
- [Slack](/docs/usage/channels/slack)
|
||||
- [Telegram](/docs/usage/channels/telegram)
|
||||
- [飞书 / Lark](/docs/usage/channels/feishu)
|
||||
- [QQ](/docs/usage/channels/qq)
|
||||
- [飞书](/docs/usage/channels/feishu)
|
||||
- [Lark](/docs/usage/channels/lark)
|
||||
|
||||
## 功能支持
|
||||
|
||||
所有平台均支持文本消息。某些功能因平台而异:
|
||||
|
||||
| 功能 | Discord | Telegram | 飞书 / Lark |
|
||||
| --------- | ------- | -------- | --------- |
|
||||
| 文本消息 | 是 | 是 | 是 |
|
||||
| 私人消息 | 是 | 是 | 是 |
|
||||
| 群组聊天 | 是 | 是 | 是 |
|
||||
| 表情反应 | 是 | 是 | 部分支持 |
|
||||
| 图片 / 文件附件 | 是 | 是 | 是 |
|
||||
| 功能 | Discord | Slack | Telegram | QQ | 飞书 | Lark |
|
||||
| --------- | ------- | ----- | -------- | -- | ---- | ---- |
|
||||
| 文本消息 | 是 | 是 | 是 | 是 | 是 | 是 |
|
||||
| 私人消息 | 是 | 是 | 是 | 是 | 是 | 是 |
|
||||
| 群组聊天 | 是 | 是 | 是 | 是 | 是 | 是 |
|
||||
| 表情反应 | 是 | 是 | 是 | 否 | 部分支持 | 部分支持 |
|
||||
| 图片 / 文件附件 | 是 | 是 | 是 | 是 | 是 | 是 |
|
||||
|
||||
Reference in New Issue
Block a user