docs(feishu): add demo screenshots and pairing code example
This commit is contained in:
parent
7941ff7cfe
commit
66a7572bd3
@ -9,6 +9,12 @@ read_when:
|
|||||||
|
|
||||||
Status: experimental. Supports direct messages and groups via Bot API using WebSocket long connection.
|
Status: experimental. Supports direct messages and groups via Bot API using WebSocket long connection.
|
||||||
|
|
||||||
|
## Demo
|
||||||
|
|
||||||
|
<frame>
|
||||||
|
<img src="/images/feishu/demo-chat.png" alt="Feishu Bot Demo" />
|
||||||
|
</frame>
|
||||||
|
|
||||||
## Key Features
|
## Key Features
|
||||||
|
|
||||||
- **WebSocket long connection**: No public IP or webhook setup required
|
- **WebSocket long connection**: No public IP or webhook setup required
|
||||||
@ -60,15 +66,17 @@ Request approval if required by your organization.
|
|||||||
|
|
||||||
### 4. Configure Credentials
|
### 4. Configure Credentials
|
||||||
|
|
||||||
**Option A: Environment variables**
|
**Option A: Clawdbot config**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export FEISHU_APP_ID=cli_xxxxxxxxxx
|
clawdbot config set channels.feishu.enabled true
|
||||||
export FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxx
|
clawdbot config set channels.feishu.appId "cli_xxxxxxxxxx"
|
||||||
|
clawdbot config set channels.feishu.appSecret "xxxxxxxxxxxxxxxxxxxxxxxx"
|
||||||
```
|
```
|
||||||
|
|
||||||
**Option B: Configuration file**
|
|
||||||
|
|
||||||
|
**Option B: Configuration file**
|
||||||
|
~/.clawdbot/clawdbot.json
|
||||||
```json5
|
```json5
|
||||||
{
|
{
|
||||||
channels: {
|
channels: {
|
||||||
@ -81,6 +89,14 @@ export FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxx
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Option C: Environment variables**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export FEISHU_APP_ID=cli_xxxxxxxxxx
|
||||||
|
export FEISHU_APP_SECRET=xxxxxxxxxxxxxxxxxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### 5. Publish and Start
|
### 5. Publish and Start
|
||||||
|
|
||||||
1. Go to "Version Management and Release" in Feishu console
|
1. Go to "Version Management and Release" in Feishu console
|
||||||
@ -130,13 +146,26 @@ All outbound messages use Feishu interactive card format with markdown:
|
|||||||
| `open` | Anyone can message (requires `allowFrom: ["*"]`) |
|
| `open` | Anyone can message (requires `allowFrom: ["*"]`) |
|
||||||
| `disabled` | DMs blocked |
|
| `disabled` | DMs blocked |
|
||||||
|
|
||||||
|
#### Pairing Flow
|
||||||
|
|
||||||
|
When a new user messages your bot with `dmPolicy: "pairing"` (default), they receive a pairing code:
|
||||||
|
|
||||||
|
<frame>
|
||||||
|
<img src="/images/feishu/pairing-code.png" alt="Feishu Pairing Code" />
|
||||||
|
</frame>
|
||||||
|
|
||||||
**Approve pairing requests:**
|
**Approve pairing requests:**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# List pending pairing requests
|
||||||
clawdbot pairing list feishu
|
clawdbot pairing list feishu
|
||||||
clawdbot pairing approve feishu <CODE>
|
|
||||||
|
# Approve a specific code
|
||||||
|
clawdbot pairing approve feishu KZ6YE87U
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Once approved, the user can interact with the bot normally.
|
||||||
|
|
||||||
### Groups
|
### Groups
|
||||||
|
|
||||||
- Default policy: `allowlist` - only allowed groups receive responses
|
- Default policy: `allowlist` - only allowed groups receive responses
|
||||||
|
|||||||
BIN
docs/images/feishu/demo-chat.png
Normal file
BIN
docs/images/feishu/demo-chat.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 151 KiB |
BIN
docs/images/feishu/pairing-code.png
Normal file
BIN
docs/images/feishu/pairing-code.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Loading…
Reference in New Issue
Block a user