スタートガイド
このチュートリアルでは、オンプレミスAPIクライアントの設定、ビジネスの電話番号の登録、設定の更新、テストメッセージの送信方法について説明します。
このAPIの使用を開始するプロセスは、次の3つの主要部分に分けることができます。
- アセットを準備する — 開始する前に、API統合を完了するために必要なアセット(WhatsApp Businessアカウントなど)を設定する必要があります。
- オンプレミスAPIクライアントをインストールする — APIクライアントをインストールします。クライアントが稼働したら、アプリケーション設定を変更できます。
- クライアントの使用を開始する —
/accountへのAPI呼び出しにより電話番号を登録し、/messagesへの呼び出しによりテストメッセージを送信します。
開始する前に
以下が必要です。
- Facebookビジネスマネージャアカウント
- WhatsAppビジネスアカウントのクレジットライン — 請求プロセスについては、オンプレミスAPIの請求についてもご覧ください。
- cURLリクエストを実行できる、TerminalなどのコマンドラインツールまたはPostmanなどのアプリ。
ビジネスの認証後、ビジネスがWhatsApp利用規約およびWhatsAppコマースポリシーを遵守しているかどうかが審査されます。このステップは自動的に開始されます。ビジネスの認証と審査のステータスは、ビジネスマネージャで、WhatsAppビジネスアカウントの[設定]タブにより確認できます。承認されると、[ビジネス認証]が[認証済み]と表示され、[アカウントステータス]が[承認済み]と表示されます。
WhatsAppアカウントを設定する
WhatsAppビジネスアカウントに電話番号とその表示名を追加します。追加すると、表示名は審査のために送信されます。
表示名を変更したい場合、登録が完了するまでは何度でも変更できます。登録の完了後は、表示名の変更は前回のリクエストから30日以上たたないと行えません。
すべての審査が完了すると、オンプレミスAPIクライアントの登録に必要な、base64エンコードされた証明書を表示およびアクセスできるようになります。表示名をさらに変更する場合は、その前に承認済みの表示名を使用して登録し、統合を開始することをおすすめします。統合後はいつでも表示名を変更できます。
請求と価格の情報を確認する
ビジネスがオンプレミスAPIを介してメッセージの送信を開始したら、請求プロセス(課金される方法とタイミング、月次の請求書の確認方法と支払い方法などを含む)を把握することが重要です。詳しくは、WhatsApp Businessアカウントの請求についてをご覧ください。価格設定ルールとメッセージあたりのコストについては、価格設定のページをご覧ください。
ソフトウェアの推奨バージョン
| ソフトウェア | バージョン | 詳細 |
|---|---|---|
オンプレミスAPI | ||
AWS用オンプレミスAPI | テンプレートバージョン: | |
MySQL |
| MySQL 8に移行したデータベースは、MySQL 5にダウングレードできないことにご注意ください。したがって、移行する前にデータベースのバックアップを作成してください。 |
PostgreSQL |
|
|
Docker | バージョン |
statx syscallがDockerの許可されたsyscallのリストに入っていることを確認してください。 |
Postman | 任意の新しいバージョン | |
libseccomp |
|
|
glibc |
|
|
オペレーティングシステム(OS) | 最新バージョン | 最小カーネルバージョン |
ステップ1: オンプレミスAPIクライアントをインストールする
環境
オンプレミスAPIクライアントの中核部分は、Dockerがベースになっています。各コンポーネントについて詳しくは、クライアントアーキテクチャをご覧ください。
現時点で、オンプレミスAPIクライアントはDocker for WindowsにもWindows Subsystem for Linuxにも対応していません。開発に必要な場合は、Linux仮想マシンを使用し、その中でDockerを実行することをおすすめします。本番ワークロードには、互換性とパフォーマンスの問題を回避するためにLinuxサーバーを使用することをおすすめします。
機器
オンプレミスAPIクライアントは、インターネットに接続されていてDocker for Linuxを実行できるマシンであれば、仮想マシンであれ、Linuxサーバーであれ、どのような機器でも動作します。詳しくは、よくある質問(FAQ)をご覧ください。例えば、ノートパソコンで簡単なテストを実行できます。本番環境サーバーでは、少なくとも250 GB SSD、16 GB RAM、4コアのCPUをおすすめします。HDDは、負荷がかかった場合に入出力速度がボトルネックになるのでおすすめしません。
多くの場合、データベースは、CoreappコンテナやWebappコンテナとは別の物理サーバーで実行する必要があります。データベースサーバーとコンピュートマシンの間の遅延は、数ミリ秒以内である必要があります。
インストール
オンプレミスAPIの使用を開始するには、次の2つの方法があります。
- Amazon Web Services (AWS): AWSを使用している場合、またはスタンドアローンのソリューションを希望する場合は、AWSガイドをご覧ください。AWSソリューションでは、自分で管理し所有しているAWSクラウドで、バックアップや障害回復などの機能を持つ、包括的なオンプレミスAPIソリューションを設定します。
オンプレミスAPIクライアントが稼働したら、残りの設定ステップを実施するには、adminとしてログインする必要があります。
設定を変更する
オンプレミスAPIクライアントが稼働したら、アプリケーション設定を変更できます。ただし、登録が完了するまでは、オンプレミスAPIクライアントのさまざまなプロフィール設定にアクセスすることはできません。
- クライアントの動作に関するアプリケーション設定 — コールバック設定、Webhooks、オンコールポケベル、送信済みステータス、メディアのダウンロード動作など。注: 受信メッセージまたはエラーに関する通知を受け取るため、Webhook URLを設定することを強くおすすめします。
- ビジネスプロフィール設定とプロフィール設定により、住所、メールアドレス、ウェブサイト、業種、事業概要、プロフィール写真といったビジネスの情報を設定できます。
ステップ2: クライアントの使用を開始する
登録
オンプレミスAPIクライアントが稼働したら、accountエンドポイントへのAPI呼び出しを送信して、電話番号を登録できます。
テストメッセージを送信する
messagesエンドポイントを使用して、テストメッセージを送信できます。最初に、テストに使用する電話番号のステータスを確認します。テスト用電話番号からWhatsAppアカウントにメッセージを送信して、カスタマーサービス時間枠を有効にする必要があります。これにより、24時間以内に任意のタイプのメッセージを送信できるようになります(詳しくは、「カットオフ制御」をご覧ください)。次に、テスト用電話番号にテキストメッセージを送信します。メッセージが届いていれば、インストールは成功しています。届いていない場合は、Webhookの通知で問題が報告されていないかを確認します。
セキュリティ
オンプレミスAPIクライアントに関連したパスワード、認証、SSLの構成、ネットワーク隔離、暗号化通信、HTTPヘッダー、およびウェブサーバーTLSプロトコルについては、Metaのセキュリティガイドをご覧ください。
スタートアップ処理
WhatsAppオンプレミスAPIでは、サーバーとの接続確立時にスタートアップ手続きが実行されます。これは、メッセージを確実にシームレスかつ信頼性の高い方法で送受信するために不可欠な処理です。このスタートアップフェーズで、中核となるアプリケーション(コアアプリ)は、次のようないくつかの前提条件が満たされるのを待機します。
テンプレートメッセージの読み込み: APIは、初期化プロセスの一環としてサーバーからテンプレートメッセージを読み込みます。
オフラインメッセージの受信と処理: オフラインメッセージの受信と処理も行います。
これらの前提条件が満たされていない状態でメッセージを送信しようとすると、コアアプリから「コアアプリの準備ができていません」というエラーメッセージが返され、ログには「サービスの準備ができていません」というエラーが示されます。WhatsAppサーバーとの新しい接続が確立されるたびにこのスタートアップ処理が実行される点にご注意ください。そのため、コアアプリケーションが再起動または切断された場合、コアアプリのステータスを「準備完了」に設定するためにスタートアップ処理が再び開始されます。これにより、WhatsAppオンプレミスAPIのメッセージコミュニケーションの信頼性が確保され、確実に準備が整います。
オフラインメッセージ処理
オフラインメッセージが見つからない場合、オフラインメッセージ処理のステップは省略されます。つまり、オフライン状態で待機しているメッセージがなければ、この特定のメッセージ処理のフェーズは実行されません。
一般的な条件下では、WhatsAppオンプレミスAPIはオフラインメッセージを処理するための標準プロトコルに従っています。すべてのオフラインメッセージの受信と処理を待機します。事前に定義されている最大タイムアウトは6分です。この6分間が経過すると、オフラインメッセージ処理フェーズは正常に完了したとみなされます。
補足的な推奨事項
すべきこと最初は社内でメッセージの送受信を行って、システムの動作を確認する。 すべてのお客様に24時間以内に返信する。 WhatsAppビジネスポリシーとWhatsAppコマースポリシーに記載されているポリシーに準拠する。 開発用、テスト用、本番用に異なる電話番号を使用する。 ダイレクトサポートのチケットをオープンする前に、「よくある質問(FAQ)」を確認する。 製品についてのフィードバックを送る。これにはダイレクトサポートが最適なチャネルです。 | すべきではないこと複数のチャネルに重複してお知らせを送信する。 スパムを送信する。 テストに1-800ナンバー(米国のフリーダイヤル)を使用する。 WhatsAppの統合のためだけにビジネスマネージャを作成する。既存のものがある場合にそれを使用する。 |
ガイドライン違反またはポリシー違反が明らかになった場合、WhatsAppの利用が制限または停止されることがあります。