EC-CUBE 4.2 / 4.3 対応

Chatwork 注文通知プラグイン

ChatworkAdminOrderNotify — 新規注文時に管理者へChatworkでリアルタイムに通知するシステム

プラグインコード: ChatworkAdminOrderNotify
提供元: CubeLab

1プラグイン概要

Chatwork 注文通知プラグインは、EC-CUBE 4.2 / 4.3 にて新規注文が確定した際に、指定した Chatwork グループチャットへ自動で通知を行うためのプラグインです。

注文詳細情報の把握や、注文の見落としをゼロにすることで、CX（顧客体験）向上および店舗運営の業務効率化に貢献します。

主な機能特徴

  • リアルタイム通知: お客様の注文確定メールと同時に、Chatwork の指定グループへ通知が送信されます。
  • 二重送信防止機能: 重複して同一注文の通知が行われないよう、データベース上で送信履歴を記録・制御しています。
  • API トークンの検証: 設定画面から、入力された Chatwork API Token の有効性をワンクリックで即時確認可能。
  • テスト送信サポート: 設定が機能しているか、実際にテスト用のテキストを投げて動作検証ができます。
  • 通知の再送信機能: 万が一の決済エラーや一時的な接続障害で送信されなかった場合、履歴から「再送信」を実行できます。

2インストール・有効化

2-1. ファイル配置

プラグインのプログラムファイルを EC-CUBE の Plugin ディレクトリへ配置します。

/path/to/eccube/app/Plugin/ChatworkAdminOrderNotify/   ← このパスへ配置
ディレクトリ名は必ず ChatworkAdminOrderNotify （大文字・小文字含む）で一致させてください。

2-2. コマンドでの有効化（推奨）

EC-CUBE ルートディレクトリにて以下のコマンドを実行します。

cd /path/to/eccube
php bin/console eccube:plugin:install --code=ChatworkAdminOrderNotify
php bin/console eccube:plugin:enable --code=ChatworkAdminOrderNotify
php bin/console cache:clear

2-3. 管理画面からの有効化

管理画面ログイン

EC-CUBE 管理画面（/admin）にログインします。

オーナーズストア → プラグイン一覧

メニューより オーナーズストア → プラグイン一覧 を開きます。

有効化の実行

「Chatwork 注文通知プラグイン」の 有効化 ボタンをクリックし、キャッシュをクリアします。

3Chatwork側の初期設定

プラグインを連携させるため、Chatwork側で「APIトークン」と「Room ID」を取得します。

3-1. API Token の取得

  1. Chatwork にログインします。
  2. 画面右上のアカウントメニューから、「サービス連携」 ➔ 「API Token」 を開きます。
  3. パスワードを入力し、API Token を表示または新規作成してコピーします。

3-2. Room ID の取得

  1. 通知を受信したいグループチャット（またはマイチャット）を開きます。
  2. ブラウザのアドレスバー（URL）を確認します。
    例: https://www.chatwork.com/#!rid123456789
  3. 末尾の rid 以降の数字（例: 123456789）が **Room ID** になります。

4プラグイン設定方法

管理画面の オーナーズストア → プラグイン一覧 ➔ 歯車アイコン（設定） より連携に必要な値を入力します。

設定項目 説明
有効化設定 チェックを入れると、注文完了時の自動通知処理が有効になります。
メッセージタイトル（プレフィックス） 通知メッセージの冒頭に差し込む店舗名などの固定文字列を設定できます。（例: 【CubeLab】新規注文を受け付けました！）
API Token Chatwork で取得した API Token を入力します。
Room ID 通知を送信したい Chatwork の Room ID（数値）を入力します。

5トークン検証・テスト送信

設定画面に情報を入力・保存した後、正しく連携できているかを確認できます。

5-1. トークンの有効性確認

設定画面にある 「Tokenの検証」 ボタンをクリックします。APIトークンが正しければ、接続先のアカウント名とIDがメッセージで表示されます。

5-2. テスト通知の送信

「テスト送信」 ボタンをクリックすると、設定された Room ID 宛てにデモの通知テストが1件送信されます。Chatworkチャット内にメッセージが届くか確認してください。

6送信履歴と再送信機能

設定画面の下部には、これまでに自動送信された注文通知の **送信ログ履歴（最新順）** がテーブル形式で表示されます。

6-1. 履歴の表示項目

  • 注文ID: 対象の注文データID。
  • 送信日時: 通知が行われたタイムスタンプ。
  • 応答ステータス: Chatwork API から返されたHTTPコード（正常時は 200）。

6-2. 手動での再送信（Resend）

Chatwork API トークンの期限切れやネットワークエラーで送信ステータスが正常に終わらなかった場合、履歴一覧の右側にある 「再送信」 ボタンをクリックすることで、いつでも対象注文の通知を強制的に再送することが可能です。

7よくあるご質問（FAQ）

Q1. 注文が入ってもChatworkにメッセージが届きません。

A. 以下のポイントを順番にご確認ください。

  1. プラグイン基本設定内の「有効化設定」がONになっているか確認します。
  2. API Token を再入力して「Tokenの検証」を行い、アカウントが認識されるか確認してください。
  3. Room ID に誤りがないか（`rid` 文字列を省いた数値のみになっているか）ご確認ください。

Q2. 再送信ボタンを押すと「送信に失敗しました」と表示されます。

A. 注文情報が既にEC-CUBE側で論理削除されているか、ChatworkのAPI制限に引っかかっている可能性があります。システムログまたは通信応答コードを確認してください。

Q3. カスタマイズの相談窓口はありますか？

A. 各種カスタマイズや機能追加のご相談は、CubeLab 公式サイトの窓口よりお気軽にお問い合わせください。