docs(wechatcom_kf): add web console onboarding tab

This commit is contained in:
6vision
2026-05-27 21:53:54 +08:00
parent 2fa6343fe5
commit 6721dbdbcc
4 changed files with 109 additions and 62 deletions

View File

@@ -45,30 +45,41 @@ WeCom の自建アプリを「微信客服WeCom Customer Service」アカ
## 3. 設定と起動
`config.json` に以下の設定を追加します(各パラメータと WeCom コンソールの対応関係は上のスクリーンショットを参照してください)
前のステップで収集した 4 つのフィールドCorp ID / Secret / Token / EncodingAESKeyを入力します
```json
{
"channel_type": "wechatcom_kf",
"wechatcom_corp_id": "YOUR_CORP_ID",
"wechatcom_kf_secret": "YOUR_SECRET",
"wechatcom_kf_token": "YOUR_TOKEN",
"wechatcom_kf_aes_key": "YOUR_AES_KEY",
"wechatcom_kf_port": 9888
}
```
<Tabs>
<Tab title="Web コンソール">
Cow プロジェクトを起動した後、Web コンソールを開きます。**チャネル** メニューを選択し、**接入チャネル** をクリックし、**微信客服** を選択して、Corp ID / Secret / Token / AES Key を入力し(ポートはデフォルト 9888、変更可能、接入をクリックします。
| パラメータ | 説明 |
| --- | --- |
| `wechatcom_corp_id` | 企業 ID |
| `wechatcom_kf_secret` | カスタマーサービスにバインドした企業微信自建アプリの Secret |
| `wechatcom_kf_token` | API 受信設定の Token |
| `wechatcom_kf_aes_key` | API 受信設定の EncodingAESKey |
| `wechatcom_kf_port` | リスンポート、デフォルトは 9888 |
<img src="https://cdn.link-ai.tech/doc/cow-weixinkefu-web-control.png" width="800"/>
</Tab>
<Tab title="設定ファイル">
`config.json` に以下の設定を追加します(各パラメータと WeCom コンソールの対応関係は上のスクリーンショットを参照してください):
設定後、プログラムを起動します。ログに `Listening on http://0.0.0.0:9888/wxkf/` と表示されれば、プログラムは正常に動作しています。このポートを外部に公開する必要があります(例:クラウドサーバーのセキュリティグループで許可します)。
```json
{
"channel_type": "wechatcom_kf",
"wechatcom_corp_id": "YOUR_CORP_ID",
"wechatcom_kf_secret": "YOUR_SECRET",
"wechatcom_kf_token": "YOUR_TOKEN",
"wechatcom_kf_aes_key": "YOUR_AES_KEY",
"wechatcom_kf_port": 9888
}
```
プログラム起動後、WeCom 管理コンソールの **メッセージ受信 → API 受信設定** に戻り、コールバック URL に `http://<your-host>:9888/wxkf/` を入力して保存します。保存が成功したら、サーバー IP を **企業の信頼済み IP** に追加する必要もあります。追加しないとメッセージの送受信ができません:
| パラメータ | 説明 |
| --- | --- |
| `wechatcom_corp_id` | 企業 ID |
| `wechatcom_kf_secret` | カスタマーサービスにバインドした企業微信自建アプリの Secret |
| `wechatcom_kf_token` | API 受信設定の Token |
| `wechatcom_kf_aes_key` | API 受信設定の EncodingAESKey |
| `wechatcom_kf_port` | リスンポート、デフォルトは 9888 |
</Tab>
</Tabs>
接入完了後、プログラムを起動しますWeb コンソール方式ではチャネルが自動的に再起動されます)。ログに `Listening on http://0.0.0.0:9888/wxkf/` と表示されれば、プログラムは正常に動作しています。このポートを外部に公開する必要があります(例:クラウドサーバーのセキュリティグループで許可します)。
続いて、WeCom 管理コンソールの **メッセージ受信 → API 受信設定** に戻り、コールバック URL に `http://<your-host>:9888/wxkf/` を入力して保存します。保存が成功したら、サーバー IP を **企業の信頼済み IP** に追加する必要もあります。追加しないとメッセージの送受信ができません:
<img src="https://cdn.link-ai.tech/doc/wechat-com_config.png" width="600"/>