WeCom は Docker デプロイまたはサーバー上の Python デプロイのみサポートしています。ローカル実行モードには対応していません。
1. 前提条件
必要なリソース:- パブリック IP を持つサーバー(海外サーバー、または国際 API アクセス用のプロキシを持つ国内サーバー)
- 登録済みの WeCom アカウント(個人登録は可能ですが認証はできません)
- 認証済みの WeCom アカウントには、対応する法人名義で届け出済みのドメインが別途必要です
2. WeCom アプリの作成
-
WeCom 管理コンソールで、自社情報をクリックし、ページ下部の Corp ID を確認します。この ID を
wechatcom_corp_id設定フィールド用に保存します。 - アプリ管理に切り替え、アプリを作成をクリックします:
- アプリ作成ページで、
AgentIdとSecretを記録します:
- API 受信設定をクリックしてアプリケーションインターフェースを設定します:
- URL の形式:
http://ip:port/wxcomapp(認証済み企業は届け出済みドメインを使用する必要があります) - ランダムな
TokenとEncodingAESKeyを生成し、設定ファイル用に保存します
プログラムがまだ起動していないため、この時点では API 受信設定を保存できません。プロジェクトが動作した後に戻って保存してください。
3. 設定と起動
config.json に以下の設定を追加します(各パラメータと WeCom コンソールの対応関係は上のスクリーンショットを参照してください):
| パラメータ | 説明 |
|---|---|
wechatcom_corp_id | Corp ID |
wechatcomapp_token | API 受信設定の Token |
wechatcomapp_secret | アプリの Secret |
wechatcomapp_agent_id | アプリの AgentId |
wechatcomapp_aes_key | API 受信設定の EncodingAESKey |
wechatcomapp_port | リスンポート、デフォルトは 9898 |
http://0.0.0.0:9898/ と表示されれば、プログラムは正常に動作しています。このポートを外部に公開する必要があります(例:クラウドサーバーのセキュリティグループで許可します)。
プログラム起動後、WeCom 管理コンソールに戻ってメッセージサーバー設定を保存します。保存が成功したら、サーバー IP を企業の信頼済み IP に追加する必要もあります。追加しないとメッセージの送受信ができません:
4. 使い方
WeCom で作成したアプリ名を検索して、直接チャットを開始できます。異なるポートでリスンする複数のインスタンスを実行して、複数の WeCom アプリを作成できます:
外部の個人 WeChat ユーザーにアプリを利用してもらうには、自社情報 → WeChat プラグインに移動し、招待 QR コードを共有します。スキャンしてフォローした後、個人 WeChat ユーザーがアプリとチャットできるようになります:
