diff --git a/en/usage/platforms/dingtalk.mdx b/en/usage/platforms/dingtalk.mdx index d6eaca090..30b8896be 100644 --- a/en/usage/platforms/dingtalk.mdx +++ b/en/usage/platforms/dingtalk.mdx @@ -4,7 +4,45 @@ title: "Deploy DingTalk Bot" Deploy LangBot to DingTalk. -## Create Bot +## One-Click Setup (Recommended) + +LangBot supports one-click DingTalk app creation with automatic credential filling — no manual copy-paste needed. + +1. Open LangBot WebUI, go to **Bots > Create Bot** +2. Enter a bot name, select `DingTalk` as the platform/adapter +3. In the **One-Click Create App** section that appears, click the **Start** button + +![One-Click Create App](/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png) + +4. Scan the QR code with the DingTalk app. On your phone, select the organization to create the bot in + +![Select Organization](/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png) + +5. Choose to **create a new bot** or **select an existing one** + +![Create or Select Bot](/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png) + +6. After authorization, the phone will show "Configuration Successful", and Client ID / Client Secret will be **auto-filled** in the LangBot WebUI + +![Config Success](/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png) + +7. **Manually fill in the bot name** (must match the DingTalk bot name), and the **Robot Code** (required for image/file features — get it from DingTalk Developer Console > Bot Configuration) + +![Fill Name and Code](/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png) + +8. Click **Submit** to complete + + +After one-click setup, normal text chat works immediately. However: +- **Image/File support**: Requires the Robot Code (RobotCode) to be filled in. If not filled during one-click setup, get it from DingTalk Developer Console > Bot Configuration +- **Streaming replies**: Requires manually configuring a card template ID — see the Card Template section below + + +--- + +## Manual Configuration + +### Create Bot Enter the [DingTalk Developer Backend](https://open-dev.dingtalk.com/?spm=ding_open_doc.document.0.0.74f445e5MkawbT#/), log in and enter the organization. After successful login, enter the open platform, which looks like this: ![DingTalk Open Platform](/images/zh/deploy/bots/dingtalk/dingtalk1.png) @@ -14,7 +52,7 @@ Click `Application Development` at the top, then click the blue button `Create A Enter the bot's backend, for example, if we have a bot named langbot2, its management page looks like this: ![Bot Page](/images/zh/deploy/bots/dingtalk/dingtalk2.png) -## Configure Bot +### Configure Bot Click `Add Application Capability`, `Other Application Capabilities`, `Configure` in `Robot`, click configure and fill in the information, as shown below: ![Bot Configuration](/images/zh/deploy/bots/dingtalk/dingtalk3.png) @@ -57,7 +95,7 @@ After editing and confirming everything is correct, save it and copy the templat ![Save](../../../images/zh/deploy/bots/dingtalk/dingtalk14.png) ![Copy template ID](../../../images/zh/deploy/bots/dingtalk/dingtalk15.png) -## Fill in Configuration Information +### Fill in Configuration Information Click `Credentials and Basic Information`, record `Client ID` and `Client Secret`, Click `Application Capabilities`, `Robot`, record the RobotCode and Robot Name. @@ -73,7 +111,7 @@ Streaming related: **Start LangBot**. -## Add Bot +### Add Bot This article uses DingTalk Windows desktop version as an example, click `Search` at the top, `Features`, then enter the name of the bot you just created, as shown: ![robot_png](/images/zh/deploy/bots/dingtalk/dingtalk5.png) diff --git a/en/usage/platforms/lark.mdx b/en/usage/platforms/lark.mdx index a0f90234c..6b024f4e2 100644 --- a/en/usage/platforms/lark.mdx +++ b/en/usage/platforms/lark.mdx @@ -2,6 +2,37 @@ title: "Connect to Feishu Bot" --- +## One-Click Setup (Recommended) + +LangBot supports one-click Feishu app creation with automatic credential filling — no manual copy-paste needed. + +1. Open LangBot WebUI, go to **Bots > Create Bot** +2. Enter a bot name, select `Feishu` as the platform/adapter +3. In the **One-Click Create App** section that appears, click the **Start** button + +![One-Click Create Feishu App](/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png) + +4. Scan the QR code with Feishu. On your phone, you'll see the Feishu Open Platform's bot creation page +5. Choose to **use an existing app** or **create a new one**: + +![Select on Phone](/images/zh/deploy/bots/lark/lark_select_or_create_bot.png) + +If you choose an existing app, a list of your apps will be shown: + +![Select Existing App](/images/zh/deploy/bots/lark/lark_select_existing.png) + +6. After authorization, the phone will show "Configuration Successful", and app_id / app_secret will be **auto-filled** in the LangBot WebUI + +![Config Success](/images/zh/deploy/bots/lark/lark_config_success.png) + +7. **Manually fill in the bot name** — it must match the Feishu bot name, otherwise the bot won't receive messages in groups + +![Fill Bot Name](/images/zh/deploy/bots/lark/lark_fill_bot_name.png) + +8. Click **Submit** to complete + +--- + ## Create Bot Go to the [Feishu Open Platform](https://open.feishu.cn/app), log in, and create an enterprise self-built application or store application. [(difference introduction)](https://open.feishu.cn/document/platform-overveiw/overview) @@ -25,7 +56,7 @@ If card streaming permissions are required, additionally add the following card If you need to change the default card template, you need to modify the card template in the platform adapter's code yourself. -## Connect to LangBot +### Connect to LangBot Find `app_id` and `app_secret` on the `Credentials and Basic Information` page. @@ -57,7 +88,7 @@ Note that in Webhook mode, LangBot needs to be deployed on a server with a publi **No public server?** [LangBot Cloud](https://space.langbot.app/cloud) includes built-in domain and HTTPS — get Lark bots working out of the box. -## Configure Event Subscription +### Configure Event Subscription Go to the `Events and Callbacks` page, configure the subscription method as `Long Connection`: @@ -85,7 +116,7 @@ Please start LangBot first, fill in the Webhook address obtained from LangBot he -## Publish Bot +### Publish Bot Click `Create Version` at the top, fill in the version number and other information, click `Save` below. diff --git a/en/usage/platforms/webpage.mdx b/en/usage/platforms/webpage.mdx new file mode 100644 index 000000000..15d5a70aa --- /dev/null +++ b/en/usage/platforms/webpage.mdx @@ -0,0 +1,50 @@ +--- +title: "Web Page Bot" +--- + +Embed a LangBot chat widget into any website with a single script tag. + +## Create Bot + +Open LangBot WebUI, go to **Bots > Create Bot**, enter a bot name, and select `Web Page Bot` as the platform/adapter. + +![Create Web Page Bot](/images/zh/deploy/bots/web_page/webpage_01.png) + +## Configuration + +| Option | Description | +|--------|-------------| +| Component Title | Title displayed at the top of the chat widget, defaults to LangBot | +| Bubble Icon | Icon displayed on the floating chat bubble | +| Component Language | Display language for the chat widget (Simplified Chinese, English, etc.) | +| Turnstile Site Key | Cloudflare Turnstile site key for anti-abuse protection. Leave empty to disable | +| Turnstile Secret Key | Cloudflare Turnstile secret key, obtained together with the site key from Cloudflare console. Required when site key is set | + +## Get Embed Code + +After creating and saving the bot, an auto-generated ` +``` + + +The embed code URL defaults to `localhost`. If your LangBot is deployed on a server, replace `localhost:5300` with your actual address. + + +## Anti-Abuse (Optional) + +To protect against abuse, you can enable Cloudflare Turnstile: + +1. Go to [Cloudflare Turnstile](https://dash.cloudflare.com/) > Add Site +2. Get the **Site Key** and **Secret Key** +3. Fill them into the corresponding fields in the LangBot Web Page Bot configuration +4. Save to take effect + +## Start Using + +After adding the embed code to your website, visitors can click the chat bubble at the bottom-right corner to start chatting with your bot. diff --git a/en/usage/platforms/wechat/weixin.mdx b/en/usage/platforms/wechat/weixin.mdx index 35b401531..8303f41c5 100644 --- a/en/usage/platforms/wechat/weixin.mdx +++ b/en/usage/platforms/wechat/weixin.mdx @@ -6,43 +6,35 @@ title: "Connect Personal WeChat via OpenClaw" [OpenClaw](https://github.com/dingxiang-me/OpenClaw-Wechat) is an open-source AI Agent framework. Through the OpenClaw WeChat adapter, you can connect LangBot to your personal WeChat account, with support for group chats, streaming output, whitelist control, and more. -## Prerequisites +## Quick Scan Login (Recommended) -- LangBot is deployed and running +LangBot supports one-click scan login for WeChat, automatically filling in credentials — no manual token entry needed. -Please make sure your mobile WeChat version is the latest **8.0.69** or above, otherwise the OpenClaw WeChat adapter may not work properly. You can check your version in WeChat under "Me" -> "Settings" -> "About WeChat". +Please make sure your mobile WeChat version is **8.0.69** or above, otherwise it may not work properly. -## Configure in LangBot +1. Open LangBot WebUI, go to **Bots > Create Bot** +2. Enter a bot name, select `Personal WeChat Bot` as the platform/adapter +3. In the **Scan Login** section that appears, click the **Start** button -### 1. Create Adapter +![Select Scan Login](/images/zh/deploy/bots/wexin/wexin_scan_login.png) -Launch the LangBot main program, create a new bot, fill in the bot name, select `OpenClaw 微信` as the platform/adapter, and click Submit. +4. Scan the QR code with WeChat. On your phone, you'll see "Connect new OpenClaw to WeChat", tap **Continue** -![Create WeChat Adapter](/images/zh/deploy/bots/wexin/wexin_01.png) +![Scan and Connect](/images/zh/deploy/bots/wexin/wexin_scan_connect.png) -### 2. Enable Adapter +5. After authorization, the token and account ID will be **auto-filled** in the form -Enable the adapter and save the configuration. +![Config Auto Fill](/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png) -![Enable Adapter](/images/zh/deploy/bots/wexin/wexin_02.png) - -### 3. Scan QR Code to Log In - -Open the logs and check the log entry with an image icon to get the login QR code. - -![Open Logs to View QR Code](/images/zh/deploy/bots/wexin/wexin_03.png) - -Use your mobile WeChat to scan the QR code to complete the login. +6. Click **Submit** to complete -Before scanning, please confirm again that your WeChat version is the latest **8.0.69** or above, otherwise the scan may fail. +If connection fails, please confirm your WeChat version is 8.0.69 or above. -![Scan QR Code](/images/zh/deploy/bots/wexin/wexin_04.jpg) - -### 4. Confirm Successful Login +### Confirm Successful Login After scanning successfully, your phone will enter the ClawBot chat page on WeChat. diff --git a/en/usage/platforms/wecom/wecombot.mdx b/en/usage/platforms/wecom/wecombot.mdx index 803855677..97aa2eab1 100644 --- a/en/usage/platforms/wecom/wecombot.mdx +++ b/en/usage/platforms/wecom/wecombot.mdx @@ -2,8 +2,36 @@ title: "Deploying WeCom Intelligent Bot" --- +## One-Click Setup (Recommended) -## Creating a Bot +LangBot supports one-click WeCom bot creation with automatic BotId and Secret filling — no manual copy-paste needed. + +1. Open LangBot WebUI, go to **Bots > Create Bot** +2. Enter a bot name, select `WeCom Intelligent Bot` as the platform/adapter +3. In the **One-Click Create Bot** section that appears, click the **Start** button + +![One-Click Create Bot](/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png) + +4. Scan the QR code with WeCom. On your phone, tap **One-Click Create Intelligent Bot** + +![Phone One-Click Create](/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png) + +5. After authorization, BotId and Secret will be **auto-filled** in the form +6. **Manually fill in the bot name** — it must match the bot name in WeCom + +![Fill Bot Name](/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png) + +7. Click **Submit** to complete + + +WeCom Intelligent Bot **cannot use existing bots** for one-click setup — only new bots. To use an existing bot, refer to the manual configuration below. + + +--- + +## Manual Configuration + +### Creating a Bot First, log in to the [WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#/). @@ -19,14 +47,14 @@ Click `Create Bot` and select `Manual Creation`, scroll to the bottom of the pag ![Create via API Mode](/images/zh/deploy/bots/wecom/wecombot/wecombot_3.png) -## Long Connection Configuration +### Long Connection Configuration -### Enable Long Connection API Mode +#### Enable Long Connection API Mode In the WeCom Admin Console, go to the Intelligent Bot configuration page, enable "API Mode" and select "Long Connection": ![Long Connection Mode](/images/zh/deploy/bots/wecom/wecombot/wecombot_9.png) -### Obtaining Credentials +#### Obtaining Credentials After enabling the Long Connection API mode, you need to obtain the following credentials to establish the connection: | Credential | Description | @@ -41,7 +69,7 @@ Note: - Mode switching impact: API mode can only use one method (long connection or callback URL). Switching to "Callback URL" mode will invalidate existing long connections; conversely, switching from "Callback URL" to "Long Connection" mode will make the original callback URL no longer effective -### Configuring the Bot +#### Configuring the Bot Start the LangBot main program, select the adapter `WeCom Intelligent Bot`, and fill in the configuration items. Enter the BotID, Secret, and bot name from the long connection into the fields, click save and enable. > The bot name must match the name of the newly created bot, otherwise the bot will not respond in group chats. @@ -49,7 +77,7 @@ Enter the BotID, Secret, and bot name from the long connection into the fields, ![Long Connection Configuration](/images/zh/deploy/bots/wecom/wecombot/wecombot_10.png) -## URL Callback Configuration +### URL Callback Configuration Click to randomly generate Token and EncodingAESKey, then fill in the basic bot information above. **Pay attention to setting the visibility scope**. @@ -57,7 +85,7 @@ Click to randomly generate Token and EncodingAESKey, then fill in the basic bot Click `My Company` in the left sidebar and save the Company ID at the bottom. -### Configuring Callback URL +#### Configuring Callback URL Start the LangBot main program, select the adapter `WeCom Intelligent Bot`, and fill in the configuration items. Among them, the token is Token, the Encoding-AESKey is EncodingAESKey, and the Bot ID can be filled in as xxx (or filled in randomly, it will be changed later). After filling in, click @@ -80,14 +108,14 @@ Details page after successful creation: Copy the `Bot ID` and bot name from the WeCom robot details page, return to the LangBot management page, change the Bot ID of the deployed intelligent robot to the copied ID, fill in the bot name, and restart the robot. -## Enable Streaming +### Enable Streaming A streaming toggle has been added for locally deployed models or models that do not support streaming. ![Streaming Toggle](/images/zh/deploy/bots/wecom/wecombot/wecombot_12.png) -## Start Using +### Start Using Enter WeCom, click `➕`, as shown: @@ -97,6 +125,6 @@ Click `Company-Created`, select the created bot, and enter the chat interface. Similarly, if you want to invite the bot to a group chat, click the add member button in the group chat and add the bot from there. -## Effect Images +### Effect Images ![Effect Image 1](/images/zh/deploy/bots/wecom/wecombot/wecombot_7.png) diff --git a/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png b/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png new file mode 100644 index 000000000..027268a73 Binary files /dev/null and b/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png differ diff --git a/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png b/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png new file mode 100644 index 000000000..c669d2cce Binary files /dev/null and b/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png differ diff --git a/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png b/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png new file mode 100644 index 000000000..dc944e88a Binary files /dev/null and b/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png differ diff --git a/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png b/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png new file mode 100644 index 000000000..178b7eb50 Binary files /dev/null and b/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png differ diff --git a/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png b/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png new file mode 100644 index 000000000..b15f5b263 Binary files /dev/null and b/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png differ diff --git a/images/zh/deploy/bots/lark/lark_config_success.png b/images/zh/deploy/bots/lark/lark_config_success.png new file mode 100644 index 000000000..f8ace7ffc Binary files /dev/null and b/images/zh/deploy/bots/lark/lark_config_success.png differ diff --git a/images/zh/deploy/bots/lark/lark_fill_bot_name.png b/images/zh/deploy/bots/lark/lark_fill_bot_name.png new file mode 100644 index 000000000..fbd91c2f7 Binary files /dev/null and b/images/zh/deploy/bots/lark/lark_fill_bot_name.png differ diff --git a/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png b/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png new file mode 100644 index 000000000..c6c3513f0 Binary files /dev/null and b/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png differ diff --git a/images/zh/deploy/bots/lark/lark_select_existing.png b/images/zh/deploy/bots/lark/lark_select_existing.png new file mode 100644 index 000000000..e580eaf32 Binary files /dev/null and b/images/zh/deploy/bots/lark/lark_select_existing.png differ diff --git a/images/zh/deploy/bots/lark/lark_select_or_create_bot.png b/images/zh/deploy/bots/lark/lark_select_or_create_bot.png new file mode 100644 index 000000000..70c959f51 Binary files /dev/null and b/images/zh/deploy/bots/lark/lark_select_or_create_bot.png differ diff --git a/images/zh/deploy/bots/web_page/webpage_01.png b/images/zh/deploy/bots/web_page/webpage_01.png new file mode 100644 index 000000000..683f584cc Binary files /dev/null and b/images/zh/deploy/bots/web_page/webpage_01.png differ diff --git a/images/zh/deploy/bots/web_page/webpage_02.png b/images/zh/deploy/bots/web_page/webpage_02.png new file mode 100644 index 000000000..342d0faea Binary files /dev/null and b/images/zh/deploy/bots/web_page/webpage_02.png differ diff --git a/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png b/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png new file mode 100644 index 000000000..978f4e138 Binary files /dev/null and b/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png differ diff --git a/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png b/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png new file mode 100644 index 000000000..ec5b7f157 Binary files /dev/null and b/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png differ diff --git a/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png b/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png new file mode 100644 index 000000000..bb278d790 Binary files /dev/null and b/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png differ diff --git a/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png b/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png new file mode 100644 index 000000000..e975710e1 Binary files /dev/null and b/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png differ diff --git a/images/zh/deploy/bots/wexin/wexin_scan_connect.png b/images/zh/deploy/bots/wexin/wexin_scan_connect.png new file mode 100644 index 000000000..382255962 Binary files /dev/null and b/images/zh/deploy/bots/wexin/wexin_scan_connect.png differ diff --git a/images/zh/deploy/bots/wexin/wexin_scan_login.png b/images/zh/deploy/bots/wexin/wexin_scan_login.png new file mode 100644 index 000000000..375a11d4f Binary files /dev/null and b/images/zh/deploy/bots/wexin/wexin_scan_login.png differ diff --git a/ja/usage/platforms/dingtalk.mdx b/ja/usage/platforms/dingtalk.mdx index dce67c80e..404e76578 100644 --- a/ja/usage/platforms/dingtalk.mdx +++ b/ja/usage/platforms/dingtalk.mdx @@ -4,7 +4,45 @@ title: "DingTalk ボットのデプロイ" DingTalk に LangBot をデプロイします。 -## ボットの作成 +## 一键設定（おすすめ） + +LangBot は DingTalk アプリのワンクリック作成とクレデンシャルの自動入力に対応しています。手動でのコピペは不要です。 + +1. LangBot WebUI を開き、**ボット > ボットを作成** に移動 +2. ボット名を入力し、プラットフォーム/アダプターで `钉钉` を選択 +3. 表示される **一键创建应用** エリアで **開始** ボタンをクリック + +![一键创建應用](/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png) + +4. DingTalk で QR コードをスキャンし、手机端で组织を選択 + +![組織を選択](/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png) + +5. **新しいボットを作成** または **既存のボットを選択** できます + +![作成または選択](/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png) + +6. 認証成功後、手机端に「設定成功」と表示され、Client ID と Client Secret が LangBot WebUI に**自動入力**されます + +![設定成功](/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png) + +7. **ボット名を手動で入力**（DingTalk のボット名と一致させる必要があります）と**ロボットコード**（画像/ファイル機能に必須、DingTalk 開発者コンソール > ボット設定から取得）を入力 + +![名前とコードの入力](/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png) + +8. **送信** をクリックして完了 + + +一键設定後、テキストの送受信はすぐに利用できます。ただし： +- **画像/ファイル対応**：ロボットコード（RobotCode）の入力が必要です。一键設定時に未入力の場合は、DingTalk 開発者コンソール > ボット設定から取得して入力してください +- **ストリーミング返信**：カードテンプレート ID の手動設定が必要です。下記「ボットの設定」のカードテンプレート作成セクションを参照してください + + +--- + +## 手動設定 + +### ボットの作成 [DingTalk 開発者バックエンド](https://open-dev.dingtalk.com/?spm=ding_open_doc.document.0.0.74f445e5MkawbT#/)にアクセスし、ログインして組織に入ります。ログインに成功したら、オープンプラットフォームに入ります。以下のように表示されます： ![DingTalk Open Platform](/images/zh/deploy/bots/dingtalk/dingtalk1.png) @@ -14,7 +52,7 @@ DingTalk に LangBot をデプロイします。 ボットのバックエンドに入ります。例えば、langbot2 という名前のボットがある場合、管理ページは以下のように表示されます： ![Bot Page](/images/zh/deploy/bots/dingtalk/dingtalk2.png) -## ボットの設定 +### ボットの設定 「アプリケーション機能を追加」、「その他のアプリケーション機能」、「ロボット」の「設定」をクリックし、設定をクリックして情報を入力します。以下のように： ![Bot Configuration](/images/zh/deploy/bots/dingtalk/dingtalk3.png) @@ -57,7 +95,7 @@ DingTalk に LangBot をデプロイします。 ![Save](../../../images/zh/deploy/bots/dingtalk/dingtalk14.png) ![Copy template ID](../../../images/zh/deploy/bots/dingtalk/dingtalk15.png) -## 設定情報の入力 +### 設定情報の入力 「認証情報と基本情報」をクリックし、「Client ID」と「Client Secret」を記録します。 「アプリケーション機能」、「ロボット」をクリックし、RobotCode とロボット名を記録します。 @@ -73,7 +111,7 @@ DingTalk に LangBot をデプロイします。 **LangBot を起動します**。 -## ボットの追加 +### ボットの追加 この記事では DingTalk Windows デスクトップ版を例として使用します。上部の「検索」、「機能」をクリックし、先ほど作成したボットの名前を入力します。以下のように： ![robot_png](/images/zh/deploy/bots/dingtalk/dingtalk5.png) diff --git a/ja/usage/platforms/lark.mdx b/ja/usage/platforms/lark.mdx index 034672ea6..f84eb2465 100644 --- a/ja/usage/platforms/lark.mdx +++ b/ja/usage/platforms/lark.mdx @@ -2,6 +2,37 @@ title: "Feishu ボットに接続" --- +## 一键設定（おすすめ） + +LangBot は Feishu アプリのワンクリック作成とクレデンシャルの自動入力に対応しています。手動でのコピペは不要です。 + +1. LangBot WebUI を開き、**ボット > ボットを作成** に移動 +2. ボット名を入力し、プラットフォーム/アダプターで `飞书` を選択 +3. 表示される **一键创建应用** エリアで **開始** ボタンをクリック + +![一键创建飞书应用](/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png) + +4. 飛書で QR コードをスキャンし、手机端で飞書開放平台のボット作成ページが表示されます +5. **既存のアプリを使用** または **新規作成** を選択できます： + +![手机端で選択](/images/zh/deploy/bots/lark/lark_select_or_create_bot.png) + +既存のアプリを選択すると、アプリ一覧が表示されます： + +![既存アプリを選択](/images/zh/deploy/bots/lark/lark_select_existing.png) + +6. 認証成功後、手机端に「設定成功」と表示され、app_id と app_secret が LangBot WebUI に**自動入力**されます + +![設定成功](/images/zh/deploy/bots/lark/lark_config_success.png) + +7. **ボット名を手動で入力** — 飛書のボット名と一致させる必要があります。一致しない場合、グループ内でメッセージを受信できません + +![ボット名の入力](/images/zh/deploy/bots/lark/lark_fill_bot_name.png) + +8. **送信** をクリックして完了 + +--- + ## ボットの作成 [Feishu Open Platform](https://open.feishu.cn/app)にアクセスし、ログインして、企業の自己構築アプリケーションまたはストアアプリケーションを作成します。[(違いの紹介)](https://open.feishu.cn/document/platform-overveiw/overview) @@ -25,7 +56,7 @@ title: "Feishu ボットに接続" デフォルトのカードテンプレートを変更する必要がある場合は、プラットフォームアダプターのコードでカードテンプレートを自分で修正する必要があります。 -## LangBot に接続 +### LangBot に接続 「認証情報と基本情報」ページで `app_id` と `app_secret` を見つけます。 @@ -57,7 +88,7 @@ Webhook モードでは、LangBot をパブリック IP を持つサーバーに **パブリックサーバーがありませんか？** [LangBot Cloud](https://space.langbot.app/cloud) にはドメインと HTTPS が含まれており、Lark ボットをすぐに使用できます。 -## イベントサブスクリプションの設定 +### イベントサブスクリプションの設定 「イベントとコールバック」ページに移動し、サブスクリプション方式を「長時間接続」として設定します： @@ -85,7 +116,7 @@ Webhook モード設定方法： -## ボットの公開 +### ボットの公開 上部の「バージョンを作成」をクリックし、バージョン番号とその他の情報を入力し、下部の「保存」をクリックします。 diff --git a/ja/usage/platforms/webpage.mdx b/ja/usage/platforms/webpage.mdx new file mode 100644 index 000000000..213d97da7 --- /dev/null +++ b/ja/usage/platforms/webpage.mdx @@ -0,0 +1,50 @@ +--- +title: "ウェブページボット" +--- + +一行のスクリプトタグで LangBot チャットウィジェットを任意のウェブサイトに埋め込みます。 + +## ボットの作成 + +LangBot WebUI を開き、**ボット > ボットを作成** に移動し、ボット名を入力し、プラットフォーム/アダプターで `ページボット` を選択します。 + +![ページボットの作成](/images/zh/deploy/bots/web_page/webpage_01.png) + +## 設定項目 + +| 項目 | 説明 | +|------|------| +| コンポーネントタイトル | チャットウィジェットの上部に表示されるタイトル。デフォルトは LangBot | +| バブルアイコン | フローティングチャットバブルに表示されるアイコン | +| コンポーネント言語 | チャットウィジェットの表示言語（簡体字中国語、英語など） | +| Turnstile サイトキー | Cloudflare Turnstile のサイトキー。bot 対策用。空なら無効 | +| Turnstile シークレットキー | Cloudflare Turnstile のシークレットキー。サイトキーと一緒に Cloudflare コンソールで取得。サイトキー設定時に必須 | + +## 埋め込みコードの取得 + +作成・保存後、ボット設定ページの **埋め込みコード** エリアに自動生成された ` +``` + + +埋め込みコードの URL はデフォルトで `localhost` です。LangBot をサーバーにデプロイしている場合は、`localhost:5300` を実際のアドレスに置き換えてください。 + + +## bot 対策（オプション） + +Cloudflare Turnstile を有効にして bot 対策を行えます： + +1. [Cloudflare Turnstile](https://dash.cloudflare.com/) > サイトを追加 に移動 +2. **サイトキー** と **シークレットキー** を取得 +3. LangBot ページボットの対応するフィールドに入力 +4. 保存して反映 + +## 使い方 + +埋め込みコードをウェブサイトに追加後、ページ右下のチャットバブルをクリックするとボットとチャットできます。 diff --git a/ja/usage/platforms/wechat/weixin.mdx b/ja/usage/platforms/wechat/weixin.mdx index bde2a4244..8931fd05f 100644 --- a/ja/usage/platforms/wechat/weixin.mdx +++ b/ja/usage/platforms/wechat/weixin.mdx @@ -6,43 +6,35 @@ title: "OpenClaw で個人 WeChat に接続する" [OpenClaw](https://github.com/dingxiang-me/OpenClaw-Wechat) はオープンソースの AI Agent フレームワークです。OpenClaw WeChat アダプターを使用することで、LangBot を個人の WeChat アカウントに接続でき、グループチャット、ストリーミング出力、ホワイトリスト制御などの機能をサポートしています。 -## 前提条件 +## クイックスキャンログイン（おすすめ） -- LangBot がデプロイされ、実行中であること +LangBot は WeChat のワンクリックスキャンログインをサポートしており、クレデンシャルを自動入力します。手動でのトークン入力は不要です。 -スマートフォンの WeChat バージョンが最新の **8.0.69** 以上であることを確認してください。それ以外の場合、OpenClaw WeChat アダプターが正常に動作しない可能性があります。WeChat の「自分」->「設定」->「WeChat について」からバージョンを確認できます。 +スマートフォンの WeChat バージョンが **8.0.69** 以上であることを確認してください。それ以外の場合、正常に動作しない可能性があります。 -## LangBot での設定 +1. LangBot WebUI を開き、**ボット > ボットを作成** に移動 +2. ボット名を入力し、プラットフォーム/アダプターで `個人微信ボット` を選択 +3. 表示される **スキャンログイン** エリアで **開始** ボタンをクリック -### 1. アダプターの作成 +![スキャンログインを選択](/images/zh/deploy/bots/wexin/wexin_scan_login.png) -LangBot メインプログラムを起動し、新しいボットを作成します。ボット名を入力し、プラットフォーム/アダプターで `OpenClaw 微信` を選択して、送信をクリックします。 +4. WeChat で QR コードをスキャンし、手机端で「新しい OpenClaw を WeChat に接続」をタップし **続行** をクリック -![WeChat アダプターの作成](/images/zh/deploy/bots/wexin/wexin_01.png) +![スキャンして接続](/images/zh/deploy/bots/wexin/wexin_scan_connect.png) -### 2. アダプターの有効化 +5. 認証成功後、トークンとアカウント ID がフォームに**自動入力**されます -アダプターを有効にして、設定を保存します。 +![設定自動入力](/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png) -![アダプターの有効化](/images/zh/deploy/bots/wexin/wexin_02.png) - -### 3. QR コードをスキャンしてログイン - -ログを開き、画像アイコンが付いたログエントリを確認して、ログイン用の QR コードを取得します。 - -![ログを開いて QR コードを確認](/images/zh/deploy/bots/wexin/wexin_03.png) - -スマートフォンの WeChat で QR コードをスキャンしてログインを完了します。 +6. **送信** をクリックして完了 -スキャン前に、WeChat のバージョンが **8.0.69** 以上であることを再度確認してください。バージョンが古い場合、スキャンに失敗する可能性があります。 +接続に失敗した場合は、WeChat のバージョンが 8.0.69 以上であることを確認してください。 -![QR コードスキャン](/images/zh/deploy/bots/wexin/wexin_04.jpg) - -### 4. ログイン成功の確認 +### ログイン成功の確認 スキャンが成功すると、スマートフォンに ClawBot のチャット画面が表示されます。 diff --git a/ja/usage/platforms/wecom/wecombot.mdx b/ja/usage/platforms/wecom/wecombot.mdx index f137d205b..e1a984710 100644 --- a/ja/usage/platforms/wecom/wecombot.mdx +++ b/ja/usage/platforms/wecom/wecombot.mdx @@ -2,8 +2,36 @@ title: "WeCom インテリジェントボットのデプロイ" --- +## 一键設定（おすすめ） -## ボットの作成 +LangBot は WeCom ボットのワンクリック作成と BotId/Secret の自動入力に対応しています。手動でのコピペは不要です。 + +1. LangBot WebUI を開き、**ボット > ボットを作成** に移動 +2. ボット名を入力し、プラットフォーム/アダプターで `企业微信智能机器人` を選択 +3. 表示される **一键创建机器人** エリアで **開始** ボタンをクリック + +![一键创建机器人](/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png) + +4. 企業微信で QR コードをスキャンし、手机端で **一键创建智能机器人** をタップ + +![手机端一键作成](/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png) + +5. 認証成功後、BotId と Secret がフォームに**自動入力**されます +6. **ボット名を手動で入力** — 企業微信のボット名と一致させる必要があります + +![ボット名の入力](/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png) + +7. **送信** をクリックして完了 + + +企業微信インテリジェントボットは**既存のボットを使用できない**ため、一键設定は新規作成のみ対応しています。既存のボットを使用する場合は、下記の手動設定を参照してください。 + + +--- + +## 手動設定 + +### ボットの作成 まず、[WeCom Admin Console](https://work.weixin.qq.com/wework_admin/frame#/)にログインします。 @@ -19,14 +47,14 @@ title: "WeCom インテリジェントボットのデプロイ" ![Create via API Mode](/images/zh/deploy/bots/wecom/wecombot/wecombot_3.png) -## ロングコネクション設定 +### ロングコネクション設定 -### ロングコネクション API モードの有効化 +#### ロングコネクション API モードの有効化 WeCom 管理コンソールで、インテリジェントボットの設定ページに移動し、「API モード」を有効にして「ロングコネクション」を選択します： ![ロングコネクションモード](/images/zh/deploy/bots/wecom/wecombot/wecombot_9.png) -### 認証情報の取得 +#### 認証情報の取得 ロングコネクション API モードを有効にした後、接続を確立するために以下の認証情報を取得する必要があります： | 認証情報 | 説明 | @@ -41,7 +69,7 @@ WeCom 管理コンソールで、インテリジェントボットの設定ペ - モード切り替えの影響：API モードは一つの方式のみ使用できます（ロングコネクションまたはコールバック URL）。「コールバック URL」モードに切り替えると、既存のロングコネクションが無効になります。逆に、「コールバック URL」から「ロングコネクション」モードに切り替えると、元のコールバック URL は無効になります -### ボットの設定 +#### ボットの設定 LangBot メインプログラムを起動し、アダプター「WeCom Intelligent Bot」を選択し、設定項目を入力します。 ロングコネクションの BotID、Secret、およびボット名を入力し、保存して有効化をクリックします。 > ボット名は新しく作成したボットの名前と一致している必要があります。一致しない場合、グループチャットで応答しません。 @@ -49,7 +77,7 @@ LangBot メインプログラムを起動し、アダプター「WeCom Intellige ![ロングコネクション設定](/images/zh/deploy/bots/wecom/wecombot/wecombot_10.png) -## URL コールバック設定 +### URL コールバック設定 Token と EncodingAESKey をランダムに生成するためにクリックし、次に上部に基本的なボット情報を入力します。**表示範囲の設定に注意してください**。 @@ -57,7 +85,7 @@ Token と EncodingAESKey をランダムに生成するためにクリックし 左側のサイドバーの「私の会社」をクリックし、下部の会社 ID を保存します。 -### コールバック URL の設定 +#### コールバック URL の設定 LangBot メインプログラムを起動し、アダプター「WeCom Intelligent Bot」を選択し、設定項目を入力します。 その中で、token は Token、Encoding-AESKey は EncodingAESKey、Bot ID は xxx として入力できます（またはランダムに入力でき、後で変更されます）。入力後、 @@ -80,14 +108,14 @@ WeCom ロボット設定ページに戻り、コピーした webhook アドレ WeCom ロボット詳細ページから「Bot ID」とボット名をコピーし、LangBot 管理ページに戻り、デプロイされたインテリジェントロボットの Bot ID をコピーした ID に変更し、ボット名を入力して、ロボットを再起動します。 -## ストリーミングの有効化 +### ストリーミングの有効化 ローカルでデプロイされたモデルやストリーミングをサポートしていないモデル向けに、ストリーミングのオン・オフスイッチが追加されました。 ![ストリーミングスイッチ](/images/zh/deploy/bots/wecom/wecombot/wecombot_12.png) -## 使用開始 +### 使用開始 WeCom に入り、「➕」をクリックします。以下のように： @@ -97,6 +125,6 @@ WeCom に入り、「➕」をクリックします。以下のように： 同様に、ボットをグループチャットに招待したい場合は、グループチャットでメンバーを追加ボタンをクリックし、そこからボットを追加します。 -## 効果の画像 +### 効果の画像 ![Effect Image 1](/images/zh/deploy/bots/wecom/wecombot/wecombot_7.png) diff --git a/zh/usage/platforms/dingtalk.mdx b/zh/usage/platforms/dingtalk.mdx index bea8a55ef..083530cac 100644 --- a/zh/usage/platforms/dingtalk.mdx +++ b/zh/usage/platforms/dingtalk.mdx @@ -4,7 +4,45 @@ title: "部署钉钉机器人" 部署 LangBot 到钉钉。 -## 创建机器人 +## 一键配置（推荐） + +LangBot 支持一键创建钉钉应用并自动填写凭证，无需手动复制粘贴。 + +1. 打开 LangBot WebUI，进入**机器人 > 创建机器人** +2. 填写机器人名称，平台/适配器选择 `钉钉` +3. 在下方出现的**一键创建应用**区域，点击右侧的 **开始** 按钮 + +![一键创建应用](/images/zh/deploy/bots/dingtalk/dingtalk_oneclick_qrcode.png) + +4. 使用钉钉扫描弹出的二维码，手机端会提示选择加入的组织 + +![选择组织](/images/zh/deploy/bots/dingtalk/dingtalk_select_org.png) + +5. 选择组织后，可以**创建新的**机器人或**选择已有的**机器人 + +![创建或选择机器人](/images/zh/deploy/bots/dingtalk/dingtalk_create_or_select.png) + +6. 授权成功后，手机端会显示「配置成功」，同时 LangBot WebUI 中的 Client ID 和 Client Secret 会**自动填入** + +![配置成功](/images/zh/deploy/bots/dingtalk/dingtalk_config_success.png) + +7. **手动填写机器人名称**（名称需与钉钉中创建的机器人一致），以及**机器人代码**（识图、上传文件等功能必填，需前往钉钉开发者后台 > 机器人配置中获取） + +![填写机器人名称和代码](/images/zh/deploy/bots/dingtalk/dingtalk_fill_name_and_code.png) + +8. 点击**提交**，完成创建 + + +一键配置完成后即可正常进行文字收发消息。但有以下限制： +- **图片/文件收发**：需要填写机器人代码（RobotCode）才能支持，如一键配置时未填写，请前往钉钉开发者后台 > 机器人配置中获取并补填 +- **流式回复**：需要手动配置卡片模板ID才能开启，参考下方「配置机器人」中的卡片模板创建步骤 + + +--- + +## 手动配置 + +### 创建机器人 进入 [钉钉开发者后台](https://open-dev.dingtalk.com/?spm=ding_open_doc.document.0.0.74f445e5MkawbT#/)，登录并且进入组织。登录成功后进入开放平台，是这样的： ![钉钉开放平台](/images/zh/deploy/bots/dingtalk/dingtalk1.png) @@ -14,7 +52,7 @@ title: "部署钉钉机器人" 进入机器人的后台，比如我们有机器人 langbot2 ,那么它的管理页面是这样的： ![机器人页面](/images/zh/deploy/bots/dingtalk/dingtalk2.png) -## 配置机器人 +### 配置机器人 点击 `添加应用能力`，`其他应用能力`，`机器人`中的 `配置`，点击配置并且填写信息之后，如下图： ![机器人配置](/images/zh/deploy/bots/dingtalk/dingtalk3.png) @@ -58,7 +96,7 @@ title: "部署钉钉机器人" ![复制模板id](../../../images/zh/deploy/bots/dingtalk/dingtalk15.png) -## 填写配置信息 +### 填写配置信息 点击`凭证与基础信息`，记录`Client ID` 和 `Client Secret`， 点击`应用能力`，`机器人`，记录下 RobotCode 和 机器人名称。 @@ -75,7 +113,7 @@ title: "部署钉钉机器人" **启动 LangBot** 。 -## 添加机器人 +### 添加机器人 本文使用钉钉 windows 桌面版举例，点击上方的`搜索`，`功能`，然后输入刚才机器人创建的名称，如图： ![robot_png](/images/zh/deploy/bots/dingtalk/dingtalk5.png) diff --git a/zh/usage/platforms/lark.mdx b/zh/usage/platforms/lark.mdx index cfbdb0b8d..192f5399d 100644 --- a/zh/usage/platforms/lark.mdx +++ b/zh/usage/platforms/lark.mdx @@ -2,7 +2,40 @@ title: "接入飞书机器人" --- -## 创建机器人 +## 一键配置（推荐） + +LangBot 支持一键创建飞书应用并自动填写凭证，无需手动复制粘贴。 + +1. 打开 LangBot WebUI，进入**机器人 > 创建机器人** +2. 填写机器人名称，平台/适配器选择 `飞书` +3. 在下方出现的**一键创建应用**区域，点击右侧的 **开始** 按钮 + +![一键创建飞书应用](/images/zh/deploy/bots/lark/lark_oneclick_qrcode.png) + +4. 使用飞书扫描弹出的二维码，手机端会进入飞书开放平台的创建智能体应用页面 +5. 可以选择**已有应用**或**立即创建**新应用： + +![手机端选择](/images/zh/deploy/bots/lark/lark_select_or_create_bot.png) + +如果选择已有应用，会展示应用列表供你选择： + +![选择已有应用](/images/zh/deploy/bots/lark/lark_select_existing.png) + +6. 授权成功后，手机端会显示「配置成功」，同时 LangBot WebUI 中的应用ID、应用密钥等凭证会**自动填入** + +![配置成功](/images/zh/deploy/bots/lark/lark_config_success.png) + +7. **手动填写机器人名称**，名称必须与飞书机器人名称一致，否则机器人将无法在群内正常接收消息 + +![手动填写机器人名称](/images/zh/deploy/bots/lark/lark_fill_bot_name.png) + +8. 点击**提交**，完成创建 + +--- + +## 手动配置 + +### 创建机器人 前往[飞书开放平台](https://open.feishu.cn/app)，登录后，创建企业自建应用/商店应用 [(区别介绍)](https://open.feishu.cn/document/platform-overveiw/overview)。 @@ -25,7 +58,7 @@ title: "接入飞书机器人" 默认卡片模板如需更换，需要自己去平台适配器的代码中修改卡片模板 -## 对接 LangBot +### 对接 LangBot 在`凭证与基础信息`页找到`app_id`和`app_secret`。 @@ -57,7 +90,7 @@ title: "接入飞书机器人" **没有公网服务器？** [LangBot Cloud](https://space.langbot.app/cloud) 自带域名和 HTTPS，无需自行配置，开箱即用飞书机器人。 -## 配置事件订阅 +### 配置事件订阅 前往`事件与回调`页，配置订阅方式为`长连接`： @@ -85,7 +118,7 @@ Webhook 模式配置方式： -## 发布机器人 +### 发布机器人 点击顶部`创建版本`，填写版本号等信息，点击下方`保存`。 diff --git a/zh/usage/platforms/readme.mdx b/zh/usage/platforms/readme.mdx index 6224fb9c1..e9fb773b1 100644 --- a/zh/usage/platforms/readme.mdx +++ b/zh/usage/platforms/readme.mdx @@ -23,6 +23,7 @@ title: "配置机器人 (Bots)" | Slack | ✅ | | [教程](/zh/usage/platforms/slack) | | LINE | ✅ | | [教程](/zh/usage/platforms/line) | | KOOK | ✅ | | [教程](/zh/usage/platforms/kook) | +| 页面机器人 | ✅ | 将聊天组件嵌入网站 | [教程](/zh/usage/platforms/webpage) | **不想折腾公网 IP 和域名？** 企业微信、微信公众号、QQ 官方机器人、飞书、钉钉、Slack、LINE 等平台需要配置 Webhook 回调地址，这意味着你需要公网服务器、域名和 HTTPS 证书。[LangBot Cloud](https://space.langbot.app/cloud) 自带域名解析和 HTTPS，注册即可直接使用，省去繁琐的网络配置。 diff --git a/zh/usage/platforms/webpage.mdx b/zh/usage/platforms/webpage.mdx new file mode 100644 index 000000000..5e966bda0 --- /dev/null +++ b/zh/usage/platforms/webpage.mdx @@ -0,0 +1,50 @@ +--- +title: "页面机器人" +--- + +通过一行脚本标签将 LangBot 聊天组件嵌入到任何网站。 + +## 创建机器人 + +打开 LangBot WebUI，进入**机器人 > 创建机器人**，填写机器人名称，平台/适配器选择 `页面机器人`。 + +![创建页面机器人](/images/zh/deploy/bots/web_page/webpage_01.png) + +## 配置项 + +| 配置项 | 说明 | +|--------|------| +| 组件标题 | 显示在聊天组件顶部的标题，默认为 LangBot | +| 气泡图标 | 浮动聊天气泡上显示的图标 | +| 组件语言 | 聊天组件的显示语言，支持简体中文、English 等 | +| Turnstile 站点密钥 | Cloudflare Turnstile 站点密钥，用于防止机器人滥用。留空则不启用 | +| Turnstile 服务端密钥 | Cloudflare Turnstile 服务端密钥，与站点密钥一起在 Cloudflare 控制台中获取。设置了站点密钥时必填 | + +## 获取嵌入代码 + +创建并保存后，在机器人配置页面的**嵌入代码**区域会自动生成一段 ` +``` + + +嵌入代码中的 URL 默认为 `localhost`，如果你的 LangBot 部署在服务器上，请将 `localhost:5300` 替换为你的实际访问地址。 + + +## 防滥用（可选） + +如果担心接口被滥用，可以在 Cloudflare 控制台中开启 Turnstile： + +1. 前往 [Cloudflare Turnstile](https://dash.cloudflare.com/) > 添加站点 +2. 获取**站点密钥**和**服务端密钥** +3. 分别填入 LangBot 页面机器人的对应配置项 +4. 保存即可生效 + +## 开始使用 + +嵌入代码添加到网站后，访客点击页面右下角的聊天气泡即可与机器人进行对话。 diff --git a/zh/usage/platforms/wechat/weixin.mdx b/zh/usage/platforms/wechat/weixin.mdx index 013b36296..0f7e5ccec 100644 --- a/zh/usage/platforms/wechat/weixin.mdx +++ b/zh/usage/platforms/wechat/weixin.mdx @@ -6,43 +6,35 @@ title: "微信官方个人助手" [OpenClaw](https://github.com/dingxiang-me/OpenClaw-Wechat) 是一个开源 AI Agent 框架，通过 OpenClaw 微信适配器可以将 LangBot 接入个人微信，支持群聊、流式输出、白名单控制等功能。 -## 前置准备 +## 一键扫码登录（推荐） -- 已部署并运行 LangBot +LangBot 支持扫码一键登录微信，自动填写凭证，无需手动复制令牌。 -请确认您的手机微信版本为 最新的**8.0.69** 或以上，否则可能无法正常使用 OpenClaw 微信适配器。您可以在微信的「我」->「设置」->「关于微信」中查看当前版本号。 +请确认您的手机微信版本为 最新的**8.0.69** 或以上，否则可能无法正常使用。 -## 在 LangBot 中配置 +1. 打开 LangBot WebUI，进入**机器人 > 创建机器人** +2. 填写机器人名称，平台/适配器选择 `个人微信机器人` +3. 在下方出现的**扫码登录**区域，点击右侧的 **开始** 按钮 -### 1. 新建适配器 +![选择扫码登录](/images/zh/deploy/bots/wexin/wexin_scan_login.png) -启动 LangBot 主程序，新建机器人，填写机器人名称，平台/适配器选择 `OpenClaw 微信`，点击提交即可。 +4. 使用微信扫描弹出的二维码，手机端会提示「将新的 OpenClaw 连接到微信」，点击**继续连接** -![新建微信适配器](/images/zh/deploy/bots/wexin/wexin_01.png) +![扫码后手机点击连接](/images/zh/deploy/bots/wexin/wexin_scan_connect.png) -### 2. 启用适配器 +5. 授权成功后，令牌和账号标识会**自动填入**配置表单 -启用适配器并保存配置。 +![配置自动填入](/images/zh/deploy/bots/wexin/wexin_config_auto_fill.png) -![启用适配器](/images/zh/deploy/bots/wexin/wexin_02.png) - -### 3. 扫码登录 - -打开日志，查看带有图片标志的日志详情，获取登录二维码。 - -![打开日志查看二维码](/images/zh/deploy/bots/wexin/wexin_03.png) - -使用手机微信扫描二维码完成登录。 +6. 点击**提交**，完成创建 -扫码前请再次确认微信版本为 **8.0.69** 或以上，否则可能导致扫码失败。 +如果提示连接失败，请确认微信版本为 8.0.69 或以上。 -![扫码链接](/images/zh/deploy/bots/wexin/wexin_04.jpg) - -### 4. 确认登录成功 +### 确认登录成功 扫码成功后，手机端会进入与 ClawBot 的聊天页面。 @@ -55,4 +47,4 @@ title: "微信官方个人助手" ## 开始使用 -登录成功后，使用扫码账号向刚刚进入的ClawBot 聊天页面进行对话 LangBot 自动回复。 +登录成功后，使用扫码账号向刚刚进入的 ClawBot 聊天页面进行对话，LangBot 自动回复。 diff --git a/zh/usage/platforms/wecom/wecombot.mdx b/zh/usage/platforms/wecom/wecombot.mdx index 5bcd2a716..3cba1eef9 100644 --- a/zh/usage/platforms/wecom/wecombot.mdx +++ b/zh/usage/platforms/wecom/wecombot.mdx @@ -2,8 +2,36 @@ title: "部署企业微信智能机器人" --- +## 一键配置（推荐） -## 创建机器人 +LangBot 支持一键创建企业微信智能机器人并自动填写 BotId 和 Secret，无需手动复制粘贴。 + +1. 打开 LangBot WebUI，进入**机器人 > 创建机器人** +2. 填写机器人名称，平台/适配器选择 `企业微信智能机器人` +3. 在下方出现的**一键创建机器人**区域，点击右侧的 **开始** 按钮 + +![一键创建机器人](/images/zh/deploy/bots/wecom/wecombot/wecombot_oneclick.png) + +4. 使用企业微信扫描弹出的二维码，手机端会提示「请先创建智能机器人」，点击 **一键创建智能机器人** + +![手机端一键创建](/images/zh/deploy/bots/wecom/wecombot/wecombot_scan_create.png) + +5. 授权成功后，BotId 和 Secret 会**自动填入**配置表单 +6. **手动填写机器人名称**，名称需与企业微信中创建的机器人名称一致 + +![手动填写机器人名称](/images/zh/deploy/bots/wecom/wecombot/wecombot_fill_name.png) + +7. 点击**提交**，完成创建 + + +企业微信智能机器人**不能选择已有的机器人**进行一键配置，只能新建。如果需要使用已有机器人，请参考下方手动配置。 + + +--- + +## 手动配置 + +### 创建机器人 首先登录[企业微信管理后台](https://work.weixin.qq.com/wework_admin/frame#/)。 @@ -19,13 +47,13 @@ title: "部署企业微信智能机器人" ![API模式创建](/images/zh/deploy/bots/wecom/wecombot/wecombot_3.png) -## 长连接配置说明 -### 开启长连接 API 模式 +### 长连接配置说明 +#### 开启长连接 API 模式 在企业微信管理后台，进入智能机器人的配置页面，开启「API 模式」并选择「长连接」方式： ![长连接方式创建](/images/zh/deploy/bots/wecom/wecombot/wecombot_9.png) -### 获取凭证 +#### 获取凭证 开启长连接 API 模式后，需要获取以下凭证用于建立连接： @@ -41,7 +69,7 @@ title: "部署企业微信智能机器人" - 模式切换影响：API 模式只能选择一种方式（长连接或设置接收消息回调地址），切换到「设置接收消息回调地址」模式会导致现有长连接失效；反之，从「设置接收消息回调地址」切换到「长连接」模式后，原有的回调地址将不再生效 -### 配置机器人 +#### 配置机器人 启动 LangBot 主程序，适配器选择 `企业微信智能机器人`，填写配置项， 将长连接中的botid和secret以及机器人名称填入，点击保存并使用 > 其中机器人名称要与新建的机器人名称一样，不然群聊会不回复 @@ -49,7 +77,7 @@ title: "部署企业微信智能机器人" ![长连接配置](/images/zh/deploy/bots/wecom/wecombot/wecombot_10.png) -## 使用url回调配置说明 +### 使用url回调配置说明 点击随机获取 Token 和 EncodingAESKey，然后填写上方的机器人基本信息，**注意设置可见范围**。 @@ -57,7 +85,7 @@ title: "部署企业微信智能机器人" 点击左边栏的`我的企业`，保存最下方的企业ID。 -### 配置回调地址 +#### 配置回调地址 启动 LangBot 主程序，适配器选择 `企业微信智能机器人`，填写配置项， 其中，令牌为 Token，消息加解密密钥为 EncodingAESKey，机器人ID填写入xxx（或者随便填写，后续会改），填写之后点击 @@ -80,14 +108,14 @@ title: "部署企业微信智能机器人" 复制企业微信机器人详情页的`Bot ID`和机器人的名称，回到LangBot管理页面，将部署的智能机器人的机器人Id改为复制的ID，并填入机器人名称，重新启动机器人。 -## 开启流式 +### 开启流式 针对部分本地搭建或者不支持流式的模型新增流式开关 ![流式开关](/images/zh/deploy/bots/wecom/wecombot/wecombot_12.png) -## 开始使用 +### 开始使用 进入企业微信，点击 `➕`,如图： @@ -97,6 +125,6 @@ title: "部署企业微信智能机器人" 同理，若想邀请机器人进入群聊，那么点击群聊的添加人员，在其中添加机器人。 -## 效果图 +### 效果图 ![效果图1](/images/zh/deploy/bots/wecom/wecombot/wecombot_7.png)