WhatsApp BusinessプラットフォームオンプレミスAPI

開発者セットアップ:単一インスタンス

本書では、テストのため開発者マシンでWhatsApp Business APIクライアントの単一インスタンスを設定する方法について説明します。

本番環境の設定については、それに関して本番環境の設定に示されている手順を実行してください。

開始する前に

以下が必要です。

  • Docker
  • Docker Compose
    • これはDockerインストールにバンドルされているはずですが、バンドルされていない場合はインストールできます。
  • 開発環境でテストアカウントをローカルに設定する
    • これを実行する目的は、開発の時間短縮のため、また新しいリリースをテストするためです。

WhatsApp Business APIクライアントの初回セットアップ

以下の手順を実行して、開発者システム上でWhatsApp Business APIクライアントの単一インスタンスをインストールします。

ステップ1: 設定スクリプトを格納するbizディレクトリを作成する

WhatsApp Business APIクライアント用に選択した場所で次のコマンドを実行します。

mkdir ~/biz; cd ~/biz;

ステップ2: WhatsApp Business APIクライアントの構成ファイルを取得する

WhatsApp Business APIクライアントの構成ファイルは、GitHubリポジトリWhatsApp-Business-API-Setup-Scripts内にあります。WhatsApp Business APIクライアントは、MySQLかPostgresのいずれかのデータベースインスタンスを使用して設定できます。

ステップ3: WA_API_VERSION環境変数を設定する

次のコマンドを使用して、WA_API_VERSION環境変数を現在のバージョンに設定します。

export WA_API_VERSION=current-whatsapp-version

ステップ4: WhatsApp Business APIクライアントを起動する

1つのデータベースコンテナ、1つのWebappコンテナ、および1つのCoreappコンテナによりWhatsApp Business APIクライアントを開始するには、次のコマンドを実行します:

docker-compose up -d

結果の出力は次のようになります。

Creating volume "biz_whatsappMedia" with local driver
Creating volume "biz_mysqlData" with local driver
Creating biz_db_1 ... done
Creating biz_wacore_1 ... done
Creating biz_waweb_1  ... done

ステップ5: コンテナが実行されていることを確認する

次のコマンドを実行して、すべてのコンテナの状態がUPであることを確認します。

docker-compose ps

デフォルトの場合、Webappコンテナは9090ポートで実行され、データベースコンテナはポート33060で実行されます。

結果の出力は次のようになります。

~/biz $ docker-compose ps
     Name                    Command               State                   Ports
-------------------------------------------------------------------------------------------------
biz_db_1       docker-entrypoint.sh mysqld      Up      0.0.0.0:33060->3306/tcp, 33060/tcp
biz_wacore_1   /opt/whatsapp/bin/wait_on_ ...   Up      6250/tcp, 6251/tcp, 6252/tcp, 6253/tcp
biz_waweb_1    /opt/whatsapp/bin/wait_on_ ...   Up      0.0.0.0:9090->443/tcp

ステップ6: ヘルスチェックを実行する

FacebookのPostmanコレクションをダウンロードして構成すると、コマンドラインを使用せずにWhatsApp Business APIを操作できます。

WhatsApp Business APIクライアントにヘルスチェックを実行するには、healthノードへのAPI呼び出しを使用します。

結果の出力は次のようになります。

{
    "health": {
        "gateway_status": "unregistered"
    }
}

WhatsApp Business APIクライアントがまだ登録されていないので、応答にはgateway_statusとしてunregisteredのgateway_statusが表示されます。

ステップ7: WhatsApp Business APIクライアントを登録する

WhatsApp Business APIクライアントを登録するには、accountノードに対するAPI呼び出しを使用します。

ステップ8: ヘルスチェックをもう一度実行する

登録の完了後、healthノードへのAPI呼び出しを使用して、WhatsApp Business APIクライアントにもう一度ヘルスチェックを実行します。

結果の出力は次のようになります。

{
    "health": {
        "gateway_status": "connected"
    }
}

gateway_statusがconnectedの場合は、Coreappコンテナが連絡先チェックやメッセージ送信のためにWhatsAppサーバーに接続可能であることを意味しています。

WhatsApp Business APIクライアントのアップグレード

アップグレード処理中はダウンタイムが発生します。

アップグレードする前に、現在のアプリの設定をバックアップして、すぐに復旧して実行できるようにすることを強くおすすめします。「バックアップと復元」のドキュメントをご覧ください。

アップグレードは常に最も忙しくない時間帯に実行することをおすすめします。

ステップ1: WA_API_VERSION環境変数を新規バージョンに変更する

次のコマンドを使用して、WA_API_VERSION環境変数を新しいバージョン番号に更新します。

export WA_API_VERSION=new-whatsapp-version

ステップ2: Dockerコンテナを再起動する

次のコマンドを実行して、Dockerコンテナを再起動します。

docker-compose up -d

結果の出力は次のようになります。

biz_db_1 is up-to-date
Recreating biz_wacore_1 ... done
Recreating biz_waweb_1  ... done

MySQLデータベースユーザーがv2.23.x以上にアップグレードする場合

ダウンタイムを回避するため、アプリの実行中にデータベースをアップグレードできるデータベースアップグレードサービスが利用可能になりました。

ステップ1: 構成ファイルをダウンロードする

dbupgrade-compose.ymlファイルには、コンテナのバージョンを示すフィールドがあります。

例:

services:
  dbupgrade:
    image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:-2.21.3}

ステップ2: コンテナを起動する

インストール環境をアップグレードするには、次のようにWA_API_VERSION環境変数を最新バージョンに設定して、dbupgrade-serviceコンテナを起動します。

WA_API_VERSION=new-whatsapp-version docker-compose -f dbupgrade-compose.yml up -d

注: 終了時に終了コードにかかわらずコンテナを再起動するオーケストレーションを使用している場合は、EXIT_ON_SUCCESS環境変数をFALSEに設定してサービスを開始し、終了コードが0のときにコンテナが終了しないようにします。

ステップ3: アップグレードが完了するまで待機する

データベースのアップグレードが成功すると、コンテナはコード0で終了します。次のDockerコマンドを使用して、ステータスをトラッキングできます。

docker wait your-database-upgrade-container-name

このコマンドにより、dbupgrade-serviceコンテナの終了コードが出力されます。

ステップ4: CoreappコンテナとWebappコンテナを再起動する

次のようにWA_API_VERSION環境変数を最新バージョンに設定して、CoreappとWebappのDockerコンテナを再起動します。

WA_API_VERSION=new-whatsapp-version docker-compose up -d

WhatsApp Business APIクライアントのアンインストール

アンインストールする前に、現在のアプリの設定をバックアップすることを強くおすすめします。「バックアップと復元」のドキュメントをご覧ください。

すべてのコンテナを削除して開発環境をリセットする必要がある場合は、docker-compose.ymlファイルを配置したディレクトリから次のコマンドを実行します。

docker-compose down

結果の出力は次のようになります。

Stopping biz_waweb_1  ... done
Stopping biz_wacore_1 ... done
Stopping biz_db_1     ... done
Removing biz_waweb_1  ... done
Removing biz_wacore_1 ... done
Removing biz_db_1     ... done

コンテナに加え、docker-compose.ymlファイルで定義されているすべてのボリュームも削除する場合は、-vパラメーターを指定してdownコマンドを実行します。

docker-compose down -v

トラブルシューティング

より効果的なトラブルシューティングを行うには、WADebugの使用をおすすめします。WADebugは、WhatsApp Business APIセットアップの潜在的な問題を検出し、より効率的にWhatsAppサポートにヘルプをリクエストできるようにするコマンドラインツールです。

WADebugを使用できない場合、または実行するとエラーが返される場合は、次のコマンドを実行してすべてのコンテナのログを収集してください。

docker-compose logs > debug_output.txt

特定のサービスのログを収集するには、次のように、サービス名(wawebまたはwacore)をdocker-compose logsコマンドの末尾に追加します。

docker-compose logs waweb > debug_output.txt

ログは、現在のディレクトリのdebug_output.txtファイルに作成されます。

このソフトウェアでは、LGPLv2.1でライセンス付与されているFFmpegのコードを使用しています。ソースはこちらからダウンロードできます。