390bd11f33
- Unified UX: channels login + message send; no plugin-specific top-level command\n- Added generic directory CLI for channel identity/groups\n- Docs: channel + plugin pages
76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
---
|
|
summary: "Zalo Personal plugin: QR login + messaging via zca-cli (plugin install + channel config + CLI + tool)"
|
|
read_when:
|
|
- You want Zalo Personal (unofficial) support in Clawdbot
|
|
- You are configuring or developing the zalouser plugin
|
|
---
|
|
|
|
# Zalo Personal (plugin)
|
|
|
|
Zalo Personal support for Clawdbot via a plugin, using `zca-cli` to automate a normal Zalo user account.
|
|
|
|
> **Warning:** Unofficial automation may lead to account suspension/ban. Use at your own risk.
|
|
|
|
## Naming
|
|
Channel id is `zalouser` to make it explicit this automates a **personal Zalo user account** (unofficial). We keep `zalo` reserved for a potential future official Zalo API integration.
|
|
|
|
## Where it runs
|
|
This plugin runs **inside the Gateway process**.
|
|
|
|
If you use a remote Gateway, install/configure it on the **machine running the Gateway**, then restart the Gateway.
|
|
|
|
## Install
|
|
|
|
### Option A: install from npm
|
|
|
|
```bash
|
|
clawdbot plugins install @clawdbot/zalouser
|
|
```
|
|
|
|
Restart the Gateway afterwards.
|
|
|
|
### Option B: install from a local folder (dev)
|
|
|
|
```bash
|
|
clawdbot plugins install ./extensions/zalouser
|
|
cd ./extensions/zalouser && pnpm install
|
|
```
|
|
|
|
Restart the Gateway afterwards.
|
|
|
|
## Prerequisite: zca-cli
|
|
The Gateway machine must have `zca` on `PATH`:
|
|
|
|
```bash
|
|
zca --version
|
|
```
|
|
|
|
## Config
|
|
Channel config lives under `channels.zalouser` (not `plugins.entries.*`):
|
|
|
|
```json5
|
|
{
|
|
channels: {
|
|
zalouser: {
|
|
enabled: true,
|
|
dmPolicy: "pairing"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## CLI
|
|
|
|
```bash
|
|
clawdbot channels login --channel zalouser
|
|
clawdbot channels logout --channel zalouser
|
|
clawdbot channels status --probe
|
|
clawdbot message send --channel zalouser --to <threadId> --message "Hello from Clawdbot"
|
|
clawdbot directory peers list --channel zalouser --query "name"
|
|
```
|
|
|
|
## Agent tool
|
|
Tool name: `zalouser`
|
|
|
|
Actions: `send`, `image`, `link`, `friends`, `groups`, `me`, `status`
|