You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 64430fa
Browse filesBrowse the repository at this point in the historyBrowse files
docs: sync Lark/Feishu guide with current capabilities and permissions (#10400)
* docs: sync Lark/Feishu guide with current capabilities and permissions
The Lark guide still described the adapter as of v4.15.0:
- Receiving voice, video, and files has been supported since v4.16.0, and quoted (reply) message contents are parsed as well.
- Documented config field names (encrypt_key, verification_token) did not match the actual lark_encrypt_key / lark_verification_token.
- The permission list recommended im:message:send and im:resource:upload, which Feishu no longer accepts for new applications; im:message covers sending and im:resource covers resource upload/download. The one-click permission URL is updated accordingly.
- Group chats only receive @-mentioned messages unless im:message.group_msg is granted, so the wake-prefix wording and the final /help step were corrected.
- Long connections are supported for both Lark China and Lark International; webhook is only a fallback, not a requirement for international Lark.
* docs: correct Lark media support in plugin platform matrix
The zh plugin platform matrix marked Lark Record and Video as unsupported, but the adapter receives and sends both.
* docs: clarify Lark group delivery and wake conditions
The group-chat wording only mentioned @ mentions. Delivery (which events Lark pushes to AstrBot) and waking (which received messages AstrBot responds to) are separate layers: a group chat only pushes messages that @ mention the bot unless im:message.group_msg is granted, while AstrBot also responds to @ALL (unless ignore_at_all is set), replies to its own messages, and wake-prefixed messages.
Copy file name to clipboardExpand all lines: docs/en/platform/lark.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,19 @@
2
2
3
3
## Supported Message Types
4
4
5
-
> Version v4.15.0.
5
+
> Version v4.16.0.
6
6
7
7
| Message Type | Receive Support | Send Support | Notes |
8
8
| --- | --- | --- | --- |
9
9
| Text | Yes | Yes ||
10
10
| Image | Yes | Yes ||
11
-
| Voice | No | Yes ||
12
-
| Video | No | Yes ||
13
-
| File | No | Yes ||
11
+
| Voice | Yes | Yes | Converted to wav on receive and opus on send |
12
+
| Video | Yes | Yes | Converted to mp4 before sending |
13
+
| File | Yes | Yes ||
14
+
15
+
When you receive a quoted (reply) message, AstrBot parses the quoted text, images, videos, and files.
16
+
17
+
In group chats, the bot responds to messages that @ mention it, @ all members (unless disabled), reply to it, or start with a wake prefix such as `/`.
14
18
15
19
Proactive message push: Supported.
16
20
@@ -24,21 +28,21 @@ Lark supports two setup methods: one-click QR creation in AstrBot, or manually c
24
28
25
29
### Option 1: One-click QR Creation
26
30
27
-
AstrBot version requirement: >= 4.25.0.
31
+
AstrBot version requirement: >= v4.25.0.
28
32
29
33
Open the AstrBot management panel, click `Platforms` in the left sidebar, click `Add Adapter`, and select `lark`.
30
34
31
35
Under `Creation Method`, select `One-click QR Creation`, choose the China or international edition as needed, then scan the QR code with the Lark mobile app and confirm. After creation succeeds, AstrBot automatically fills in the app's `app_id`, `app_secret`, and domain configuration.
32
36
33
37
> [!IMPORTANT]
34
-
> After an app is created through QR scanning, group chats receive only messages that @ mention the bot or messages triggered by a wake prefix such as `/` by default. If you need the bot to receive all group messages, enable the additional permissions in the Lark Developer Console.
38
+
> In group chats, Lark only pushes messages that @ mention the bot to AstrBot by default. If you need the bot to receive all group messages, enable the `im:message.group_msg` permission in the Lark Developer Console.
35
39
>
36
40
> Replace `<APP_ID>` in the URL below with your Lark app ID, then open it to jump to the permission enablement page:
37
41
>
38
42
> To find the App ID, go back to AstrBot's `Platforms` page, select the Lark bot you just created, and check `app_id` under `Connection settings`.
After QR creation succeeds, continue checking the event subscription, permissions, version release, and group installation steps below.
@@ -74,9 +78,9 @@ Fill in the configuration fields as follows:
74
78
75
79
For the domain field, if you're using Lark China, keep the default value. If you're using Lark International, set it to `https://open.larksuite.com`. If you're using a self-hosted enterprise Lark instance, enter your Lark instance's domain.
76
80
77
-
For the subscription method, `socket` uses a long connection subscription approach, while `webhook` sends events to your developer server and requires a public server. Generally, `socket` is recommended. However, if you're using Lark International or a self-hosted Lark instance, choose `webhook`. The subsequent configuration steps will differ accordingly.
81
+
For the subscription method, `socket` uses a long connection subscription approach, while `webhook` sends events to your developer server and requires a public server. Generally, `socket` is recommended, and both Lark China and Lark International support long connections. For a self-hosted Lark instance, choose `webhook` if long connections are unavailable. The subsequent configuration steps will differ accordingly.
78
82
79
-
If you selected the `webhook` method, navigate to the Lark Developer Console, click on "Events & Callbacks," then "Encryption Policy," and fill in the Encrypt Key. While not mandatory, AstrBot takes your data security seriously, so we strongly recommend setting this up. After filling it in, copy the `Encrypt Key` and `Verification Token` to the corresponding `encrypt_key` and `verification_token` fields in AstrBot's configuration.
83
+
If you selected the `webhook` method, navigate to the Lark Developer Console, click on "Events & Callbacks," then "Encryption Policy," and fill in the Encrypt Key. While not mandatory, AstrBot takes your data security seriously, so we strongly recommend setting this up. After filling it in, copy the `Encrypt Key` and `Verification Token` into the corresponding `Encrypt Key` (`lark_encrypt_key`) and `Verification Token` (`lark_verification_token`) fields in AstrBot.
80
84
81
85
Click `Save`.
82
86
@@ -111,16 +115,16 @@ Click to enable the following permissions.
111
115
112
116
Then click the `Save` button at the top.
113
117
114
-
Next, click on "Permission Management," click "Enable Permissions," and enter `im:message:send,im:message,im:message:send_as_bot`. Add the filtered permissions.
118
+
Next, click on "Permission Management," click "Enable Permissions," and enter `im:message,im:message:send_as_bot`. Add the filtered permissions.
115
119
116
-
Enter `im:resource:upload,im:resource` again to enable image upload permissions.
120
+
Enter `im:resource` to enable uploading and downloading images, files, and other resources.
117
121
118
122
Enable `contact:contact.base:readonly` and `contact:user.base:readonly` so private-message senders can be shown by their display names.
119
123
120
124
If you want to use the bot in group chats, additionally enable `im:message.group_at_msg:readonly` and `im:message.group_msg`.
121
125
122
126
> [!TIP]
123
-
> Apps created through one-click QR creation are suitable for @ mentions and wake-prefix triggers by default. To receive every group message, make sure `im:message.group_msg` is enabled. You can also use the permission URL above to quickly open the corresponding page.
127
+
> An app created through one-click QR creation only receives group messages that @ mention the bot by default. To receive every group message, make sure `im:message.group_msg` is enabled. You can also use the permission URL above to quickly open the corresponding page.
124
128
125
129
If you want to use streaming output, additionally enable `Create and update cards (cardkit:card:write)`.
126
130
@@ -146,6 +150,6 @@ Search for the bot you just created. For example, if you created the `AstrBot` b
146
150
147
151
## 🎉 All Done!
148
152
149
-
Send a `/help` command in the group, and the bot will respond.
153
+
Mention the bot in the group and send a `/help` command, and the bot will respond.
0 commit comments