mirror of
https://github.com/sipeed/picoclaw.git
synced 2026-05-25 16:00:35 +00:00
Cytown
667fc85d54
add new field type to Channel struct config.channels refactor to channel_list update config version to 3 update the docs
54 lines
2.7 KiB
Markdown
54 lines
2.7 KiB
Markdown
> Back to [README](../../../README.md)
|
|
|
|
# Feishu
|
|
|
|
Feishu (international name: Lark) is an enterprise collaboration platform by ByteDance. It supports both Chinese and global markets through event-driven WebSocket connections.
|
|
|
|
## Configuration
|
|
|
|
```json
|
|
{
|
|
"channel_list": {
|
|
"feishu": {
|
|
"enabled": true,
|
|
"type": "feishu",
|
|
"app_id": "cli_xxx",
|
|
"app_secret": "xxx",
|
|
"encrypt_key": "",
|
|
"verification_token": "",
|
|
"allow_from": []
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
| Field | Type | Required | Description |
|
|
| --------------------- | ------ | -------- | ------------------------------------------------------------------ |
|
|
| enabled | bool | Yes | Whether to enable the Feishu channel |
|
|
| app_id | string | Yes | App ID of the Feishu application (starts with `cli_`) |
|
|
| app_secret | string | Yes | App Secret of the Feishu application |
|
|
| encrypt_key | string | No | Encryption key for event callbacks |
|
|
| verification_token | string | No | Token used for Webhook event verification |
|
|
| allow_from | array | No | Allowlist of user IDs; empty means all users are allowed |
|
|
| random_reaction_emoji | array | No | List of random reaction emojis; empty uses the default "Pin" |
|
|
|
|
## Setup
|
|
|
|
1. Go to the [Feishu Open Platform](https://open.feishu.cn/) and create an application
|
|
2. Enable the **Bot** capability in the application settings
|
|
3. Create a version and publish the application (configuration takes effect only after publishing)
|
|
4. Obtain the **App ID** (starts with `cli_`) and **App Secret**
|
|
5. Fill in the App ID and App Secret in the PicoClaw configuration file
|
|
6. Run `picoclaw gateway` to start the service
|
|
7. Search for the bot name in Feishu and start a conversation
|
|
|
|
> PicoClaw connects to Feishu using WebSocket/SDK mode — no public callback address or Webhook URL is required.
|
|
>
|
|
> `encrypt_key` and `verification_token` are optional; enabling event encryption is recommended for production environments.
|
|
>
|
|
> For custom emoji references, see: [Feishu Emoji List](https://open.larkoffice.com/document/server-docs/im-v1/message-reaction/emojis-introduce)
|
|
|
|
## Platform Limitations
|
|
|
|
> ⚠️ **Feishu channel does not support 32-bit devices.** The Feishu SDK only provides 64-bit builds. Devices running armv6, armv7, mipsle, or other 32-bit architectures cannot use the Feishu channel. For messaging on 32-bit devices, use Telegram, Discord, or OneBot instead.
|