All Docs

Supported Chat Platforms / 支持的聊天平台

lsbot 支持 19 种聊天平台，涵盖国内外主流 IM、社交和协作平台。所有平台均通过 lsbot onboard 交互式向导配置，也可通过命令行参数或环境变量指定。

lsbot supports 19 chat platforms covering mainstream IM, social, and collaboration platforms globally. Configure via lsbot onboard interactive wizard, or specify via CLI flags and environment variables.

Tip: Not sure which mode to use? See Gateway vs Relay for a detailed comparison.

Platform List / 平台列表

#Platform名称Connection / 连接方式Setup / 接入方式
1wecomWeCom / 企业微信Callback APICloud Relay / Self-hosted 云中继或自建
2wechatWeChat Official / 微信公众号Cloud Relay 云中继Relay only 仅云中继
3dingtalkDingTalk / 钉钉Stream ModeOne-click 一键接入
4feishuFeishu / Lark / 飞书WebSocketOne-click 一键接入
5slackSlackSocket ModeOne-click 一键接入
6telegramTelegramBot API (long polling)One-click 一键接入
7discordDiscordGateway (WebSocket)One-click 一键接入
8whatsappWhatsApp BusinessWebhook + Graph APISelf-hosted 自建
9lineLINEWebhook + Push APISelf-hosted 自建
10teamsMicrosoft TeamsBot Framework + OAuth2Self-hosted 自建
11matrixMatrix / ElementHTTP Sync PollingSelf-hosted 自建
12googlechatGoogle ChatWebhook + REST APISelf-hosted 自建
13mattermostMattermostWebSocket + REST APISelf-hosted 自建
14imessageiMessage (BlueBubbles)HTTP PollingSelf-hosted 自建
15signalSignal (signal-cli)HTTP PollingSelf-hosted 自建
16twitchTwitchIRCSelf-hosted 自建
17nostrNOSTRWebSocket (Relays)Self-hosted 自建
18zaloZaloWebhook + REST APISelf-hosted 自建
19nextcloudNextcloud TalkHTTP Polling + RESTSelf-hosted 自建

Configuration / 配置详情

1. WeCom / 企业微信

Field / 字段FlagEnv / 环境变量Description / 说明
Corp ID--wecom-corp-idWECOM_CORP_IDCorporation ID / 企业 ID
Agent ID--wecom-agent-idWECOM_AGENT_IDAgent ID / 应用 ID
Secret--wecom-secretWECOM_SECRETAgent Secret / 应用密钥
Token--wecom-tokenWECOM_TOKENCallback Token / 回调 Token
AES Key--wecom-aes-keyWECOM_AES_KEYEncodingAESKey / 消息加密密钥
Port--wecom-portWECOM_PORTCallback port (default: 8080) / 回调端口

Guide / 教程: WeCom Integration / 企业微信集成指南

2. WeChat Official / 微信公众号

WeChat Official Account uses Cloud Relay mode only. Configure via lsbot onboard and select wechat.

微信公众号仅支持云中继模式。通过 lsbot onboard 向导选择 wechat 即可。

Guide / 教程: WeChat Integration / 微信公众号接入指南

3. DingTalk / 钉钉

Field / 字段FlagEnv / 环境变量Description / 说明
Client ID--dingtalk-client-idDINGTALK_CLIENT_IDAppKey from Developer Console / 开发者后台 AppKey
Client Secret--dingtalk-client-secretDINGTALK_CLIENT_SECRETAppSecret / 应用密钥

4. Feishu / Lark / 飞书

Field / 字段FlagEnv / 环境变量Description / 说明
App ID--feishu-app-idFEISHU_APP_IDApp ID (cli_...)
App Secret--feishu-app-secretFEISHU_APP_SECRETApp Secret / 应用密钥

Setup steps / 配置步骤：

  1. 访问 飞书开放平台，创建企业自建应用
  2. 在 「凭证与基础信息」 复制 App ID 和 App Secret
  3. 进入 「添加应用能力」 → 「机器人」，启用机器人
  4. 「权限管理」 中开通 im:message（收发消息）权限
  5. 首次启动 bot 建立连接（解锁长连接选项）： 
    export FEISHU_APP_ID="cli_your_app_id"
export FEISHU_APP_SECRET="your_app_secret"
lsbot gateway --provider deepseek --api-key sk-xxx
  6. 返回飞书后台 → 「机器人」 → 「消息接收方式」，选择 「使用长连接接收消息」
  7. 「事件与回调」 → 订阅方式选 「使用长连接接收事件」，添加 im.message.receive_v1 事件
  8. 发布应用版本

同时支持飞书（open.feishu.cn）和 Lark 国际版（open.larksuite.com），SDK 自动处理地区差异。

5. Slack

Field / 字段FlagEnv / 环境变量Description / 说明
Bot Token--slack-bot-tokenSLACK_BOT_TOKENBot Token (xoxb-...)
App Token--slack-app-tokenSLACK_APP_TOKENApp Token (xapp-...)

Guide / 教程: Slack Integration / Slack 集成指南

6. Telegram

Field / 字段FlagEnv / 环境变量Description / 说明
Bot Token--telegram-tokenTELEGRAM_BOT_TOKENBot token from @BotFather

7. Discord

Field / 字段FlagEnv / 环境变量Description / 说明
Bot Token--discord-tokenDISCORD_BOT_TOKENBot token from Developer Portal

8. WhatsApp Business

Field / 字段FlagEnv / 环境变量Description / 说明
Phone Number ID--whatsapp-phone-idWHATSAPP_PHONE_NUMBER_IDWhatsApp Business Phone Number ID
Access Token--whatsapp-access-tokenWHATSAPP_ACCESS_TOKENMeta Graph API access token
Verify Token--whatsapp-verify-tokenWHATSAPP_VERIFY_TOKENWebhook verification token

9. LINE

Field / 字段FlagEnv / 环境变量Description / 说明
Channel Secret--line-channel-secretLINE_CHANNEL_SECRETLINE Channel Secret
Channel Token--line-channel-tokenLINE_CHANNEL_TOKENLINE Channel Access Token

10. Microsoft Teams

Field / 字段FlagEnv / 环境变量Description / 说明
App ID--teams-app-idTEAMS_APP_IDTeams App ID
App Password--teams-app-passwordTEAMS_APP_PASSWORDTeams App Password
Tenant ID--teams-tenant-idTEAMS_TENANT_IDAzure Tenant ID

11. Matrix / Element

Field / 字段FlagEnv / 环境变量Description / 说明
Homeserver URL--matrix-homeserver-urlMATRIX_HOMESERVER_URLe.g. https://matrix.org
User ID--matrix-user-idMATRIX_USER_IDe.g. @bot:matrix.org
Access Token--matrix-access-tokenMATRIX_ACCESS_TOKENMatrix access token

12. Google Chat

Field / 字段FlagEnv / 环境变量Description / 说明
Project ID--googlechat-project-idGOOGLE_CHAT_PROJECT_IDGoogle Cloud project ID
Credentials File--googlechat-credentials-fileGOOGLE_CHAT_CREDENTIALS_FILEService account JSON path / 服务账号 JSON 路径

13. Mattermost

Field / 字段FlagEnv / 环境变量Description / 说明
Server URL--mattermost-server-urlMATTERMOST_SERVER_URLMattermost server URL
Token--mattermost-tokenMATTERMOST_TOKENPersonal access token
Team Name--mattermost-team-nameMATTERMOST_TEAM_NAMETeam name / 团队名称

14. iMessage (BlueBubbles)

Field / 字段FlagEnv / 环境变量Description / 说明
Server URL--bluebubbles-urlBLUEBUBBLES_URLBlueBubbles server URL
Password--bluebubbles-passwordBLUEBUBBLES_PASSWORDBlueBubbles server password

Requires BlueBubbles server running on macOS. 需要在 macOS 上运行 BlueBubbles 服务器。

15. Signal

Field / 字段FlagEnv / 环境变量Description / 说明
API URL--signal-api-urlSIGNAL_API_URLsignal-cli REST API URL
Phone Number--signal-phone-numberSIGNAL_PHONE_NUMBERRegistered phone number / 注册手机号

Requires signal-cli-rest-api running. 需要运行 signal-cli-rest-api 服务。

16. Twitch

Field / 字段FlagEnv / 环境变量Description / 说明
OAuth Token--twitch-tokenTWITCH_TOKENTwitch OAuth token (oauth:xxx)
Channel--twitch-channelTWITCH_CHANNELChannel name / 频道名
Bot Name--twitch-bot-nameTWITCH_BOT_NAMEBot username / 机器人用户名

17. NOSTR

Field / 字段FlagEnv / 环境变量Description / 说明
Private Key--nostr-private-keyNOSTR_PRIVATE_KEYPrivate key (hex or nsec) / 私钥
Relays--nostr-relaysNOSTR_RELAYSComma-separated relay URLs / 中继地址（逗号分隔）

18. Zalo

Field / 字段FlagEnv / 环境变量Description / 说明
App ID--zalo-app-idZALO_APP_IDZalo App ID
Secret Key--zalo-secret-keyZALO_SECRET_KEYZalo Secret Key
Access Token--zalo-access-tokenZALO_ACCESS_TOKENZalo Access Token

19. Nextcloud Talk

Field / 字段FlagEnv / 环境变量Description / 说明
Server URL--nextcloud-server-urlNEXTCLOUD_SERVER_URLNextcloud server URL
Username--nextcloud-usernameNEXTCLOUD_USERNAMEBot username / 机器人用户名
Password--nextcloud-passwordNEXTCLOUD_PASSWORDPassword or app password / 密码或应用密码
Room Token--nextcloud-room-tokenNEXTCLOUD_ROOM_TOKENTalk room token / 房间 Token

Usage / 用法

# Interactive wizard / 交互式向导
lsbot onboard

# Command line examples / 命令行示例
lsbot gateway --provider deepseek --api-key sk-xxx \
  --slack-bot-token xoxb-... --slack-app-token xapp-...

lsbot gateway --provider deepseek --api-key sk-xxx \
  --telegram-token 123456:ABC-DEF

lsbot relay --platform wecom --provider deepseek --api-key sk-xxx

# Environment variables / 环境变量
export SLACK_BOT_TOKEN="xoxb-..."
export SLACK_APP_TOKEN="xapp-..."
export TELEGRAM_BOT_TOKEN="123456:ABC-DEF"
lsbot gateway --provider deepseek --api-key sk-xxx

Notes / 说明

  • Multiple platforms can run simultaneously via lsbot gateway. Each platform with valid credentials will be registered automatically.
  • 多个平台可通过 lsbot gateway 同时运行。提供了有效凭证的平台会自动注册。
  • Cloud Relay (lsbot relay) is the easiest way to connect WeCom and WeChat Official Account — no public server needed.
  • 云中继（lsbot relay）是接入企业微信和微信公众号最简单的方式 — 无需公网服务器。
  • All platform credentials can be saved via lsbot onboard and stored in ~/Library/Preferences/Lingti/bot.yaml (macOS) or ~/.config/lingti/bot.yaml (Linux).
  • 所有平台凭证可通过 lsbot onboard 保存到 ~/Library/Preferences/Lingti/bot.yaml（macOS）或 ~/.config/lingti/bot.yaml（Linux）。