OpenWA：开源 WhatsApp API 网关，彻底摆脱商业短信 API 的枷锁

// 数据库适配器接口 (简化示意)
interface IDatabaseAdapter {
  connect(config: DBConfig): Promise<void>;
  getRepository<T>(entity: Entity): Repository<T>;
}

// SQLite 适配器
class SqliteAdapter implements IDatabaseAdapter {
  async connect(config: DBConfig) {
    return createConnection({
      type: 'sqlite',
      database: config.sqlite.path,
      // ...
    });
  }
}

// PostgreSQL 适配器
class PostgresAdapter implements IDatabaseAdapter {
  async connect(config: DBConfig) {
    return createConnection({
      type: 'postgres',
      host: config.postgres.host,
      // ...
    });
  }
}

# 克隆仓库
git clone https://github.com/rmyndharis/OpenWA.git
cd OpenWA

# 启动开发环境（SQLite + 本地存储）
docker compose -f docker-compose.dev.yml up -d

# 访问服务
# Dashboard: http://localhost:2886
# API: http://localhost:2785/api
# Swagger 文档: http://localhost:2785/api/docs

# 克隆仓库
git clone https://github.com/rmyndharis/OpenWA.git
cd OpenWA

# 安装依赖（会自动安装 Dashboard 前端依赖）
npm install

# 启动开发模式（API + Dashboard 同时启动）
npm run dev

# 访问
# Dashboard: http://localhost:2886
# API: http://localhost:2785/api

# 创建会话
curl -X POST http://localhost:2785/api/sessions \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"name": "my-bot"}'

# 启动会话（返回 sessionId）
# 获取 QR 码并扫描
curl http://localhost:2785/api/sessions/{sessionId}/qr \
  -H "X-API-Key: YOUR_API_KEY"

# 发送消息
curl -X POST http://localhost:2785/api/sessions/{sessionId}/messages/send-text \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "chatId": "[email protected]",
    "text": "Hello from OpenWA!"
  }'

curl -X POST http://localhost:2785/api/sessions/{sessionId}/webhooks \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "url": "https://your-server.com/webhook",
    "events": ["message.received", "session.status"],
    "secret": "your-hmac-secret"
  }'

// Webhook 接收端示例 (Node.js/Express)
app.post('/webhook', (req, res) => {
  const signature = req.headers['x-openwa-signature'];
  const payload = JSON.stringify(req.body);
  
  const expected = crypto
    .createHmac('sha256', 'your-hmac-secret')
    .update(payload)
    .digest('hex');
  
  if (signature !== expected) {
    return res.status(401).send('Invalid signature');
  }
  
  // 处理事件
  console.log('Event:', req.body.event);
  res.status(200).send('OK');
});

// 使用 OpenWA API 构建简单客服机器人
import axios from 'axios';

const API_BASE = 'http://localhost:2785/api';
const API_KEY = 'YOUR_API_KEY';
const SESSION_ID = 'your-session-id';

// 监听 webhook 事件 (message.received)
async function handleIncomingMessage(event: any) {
  const { from, body } = event.data;
  
  // 简单关键词回复
  let reply = '';
  if (body.includes('你好') || body.includes('hello')) {
    reply = '您好！我是客服机器人，请问有什么可以帮您？';
  } else if (body.includes('价格') || body.includes('price')) {
    reply = '我们的产品价格为 $99/年，详情请访问 https://example.com';
  } else {
    reply = '感谢您的留言，我们会尽快回复您。';
  }
  
  // 发送回复
  await axios.post(
    `${API_BASE}/sessions/${SESSION_ID}/messages/send-text`,
    { chatId: from, text: reply },
    { headers: { 'X-API-Key': API_KEY } }
  );
}

# 使用生产 Profile（PostgreSQL + Redis + MinIO）
docker compose --profile full up -d

# 或直接指定 Profile
docker compose --profile postgres --profile redis up -d

# 数据库
DATABASE_PROVIDER=postgres
DATABASE_HOST=postgres
DATABASE_PORT=5432
DATABASE_USER=openwa
DATABASE_PASSWORD=secret
DATABASE_NAME=openwa

# 缓存
CACHE_PROVIDER=redis
REDIS_HOST=redis
REDIS_PORT=6379

# 存储
STORAGE_PROVIDER=s3
S3_ENDPOINT=http://minio:9000
S3_BUCKET=openwa-media
S3_ACCESS_KEY=minioadmin
S3_SECRET_KEY=minioadmin

# macOS
xcode-select --install

# Ubuntu/Debian
sudo apt-get install python3 make g++

# 然后重新安装
rm -rf node_modules package-lock.json
npm install

# 启用 Redis 缓存
docker compose --profile redis up -d

# 配置限流（防止过载）
RATE_LIMIT_TTL=60
RATE_LIMIT_LIMIT=100

nvm install 22
nvm use 22