使用 Amazon Web Services 部署

本文件顯示如何使用 Amazon Web Services（AWS）來部署 WhatsApp Business API。此程序可分為兩個主要步驟：

1. WhatsApp Business API 用戶端部署
2. WhatsApp Business API 用戶端配置

完成設定後，您可選擇升級用戶端。如果需要重新啟動網路應用程式和核心應用程式，請依照這些步驟操作。

開始使用

開始之前，您需要：

• 設定 AWS 帳號編號
• 建立 AWS 金鑰對
• 訂閱 CentOS 9 映像檔
• 部署在支援的區域

設定 AWS 帳號編號

您需要設定有效的 AWS 帳號並熟悉 AWS 上的作業。WhatsApp 提供 CloudFormation 範本，可供輕鬆部署 WhatsApp Business API 用戶端。如需詳細資訊，請參閱 AWS 入門資源中心。

建立 AWS 金鑰對

您需要建立新的金鑰組，以存取由 WhatsApp Business API 範本建立的 EC2 執行個體。您也可使用之前建立的金鑰對。請參閱「Amazon EC2 金鑰對」文件，瞭解如何建立金鑰對並用於 EC2 執行個體。

訂閱 CentOS 9 映像檔

WhatsApp Business API 用戶端使用 CentOS 9 映像檔（可在 AWS Marketplace 中取得）。使用範本之前，應先審閱並接受服務條款與條件。如果不接受條款，將導致範本建立失敗。

若要審閱並接受 CentOS 9 AMI 映像檔：

1. 前往 AWS Marketplace：CentOS 9（x86_64）- 含更新 HVM 頁面。
2. 點擊右上角的 Continue to Subscribe（繼續訂閱），然後點擊 Accept Terms（接受條款）按鈕。

支援的區域

WhatsApp Business API 範本使用 EFS 資源類型，並非在所有 AWS 區域都可用。因此，目前僅支援以下區域：

• 維吉尼亞北部（us-east-1）
• 俄亥俄（us-east-2）
• 加利佛尼亞北部（us-west-1）
• 奧勒岡（us-west-2）
• 孟買（ap-south-1）
• 首爾（ap-northeast-2）
• 新加坡（ap-southeast-1）
• 雪梨（ap-southeast-2）
• 東京（ap-northeast-1）
• 法蘭克福（eu-central-1）
• 愛爾蘭（eu-west-1）

常見問題

部署

步驟 1：[選用] 網路設定

註冊 AWS 帳號，通常會建立 Virtual Private Cloud（VPC）網路。此外，可能還需要一些企業商務特定的自訂和存取控制限制。

如果您已建立 VPC 網路基礎結構，則可以略過此步驟。否則，可使用下列範本在 AWS 上建立網路基礎結構。

網路需求

• 區域內的不同可用性區域中至少必須有兩個子網路。否則，建立 RDS（資料庫）資源時，範本建立將失敗。
• 應允許對 HTTP（埠：80）、HTTPS（ 埠：443）和 SSH（埠：22）的入站存取。基於安全考量，強烈建議您使用 HTTPS，並避免使用 HTTP。

若要部署網路範本：

1. 前往您所在區域的 CloudFormation 主控台（例如 eu-west-1）。
2. 選擇 Create Stack（建立堆疊）。
3. 從 GitHub 下載 wa_ent_net.yml 檔案並儲存在本機。
4. 選擇 Upload a template file（上傳範本檔案）做為範本來源，並上傳從步驟 3 下載的範本檔案。
   

   建立堆疊
5. 點擊 Next（下一步）。
6. 在 Specify stack details（指定堆疊詳細資訊）畫面中，根據下表輸入參數值：

參數

可用區域配置

VPC 配置

公有子網路配置

私有子網路配置

步驟 2：上傳資料庫和監控堆疊配置檔

在 AWS 上部署 WhatsApp Business API 堆疊之前，您需要先將參照子堆疊的配置檔上傳到您有讀取權限的 S3 儲存貯體。

1. 建立新的 S3 儲存貯體，或使用您有讀取權限的現有 S3 儲存貯體。
2. 從 GitHub 下載 wa_ent_db.yml 檔案和 wa_ent_monitoring.yml 檔案，並將這兩個檔案上傳到步驟 1 中提及的 S3 儲存貯體。
3. 從「Objects」（物件）清單中選擇 wa_ent_db.yml 檔案，然後複製其網址。其格式應為 https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_db.yml。
4. 在 wa_ent.yml 檔案中，將 dbStack 中的 TemplateURL 值替換為步驟 3 中的物件網址並儲存檔案。
5. 從「Objects」（物件）清單中選擇 wa_ent_monitoring.yml 檔案，然後複製其網址。其格式應為 https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_monitoring.yml。
6. 在 wa_ent.yml 檔案中，將 Monitoring 堆疊中的 TemplateURL 值替換為步驟 5 中的物件網址並儲存檔案。

上傳至 S3 儲存貯體

步驟 3：WhatsApp Business API 部署

WhatsApp Enterprise 為主要範本，並建立 WhatsApp Business API 用戶端所需的所有資源（網路除外）。如前所述，如果需要，此範本也會建立資料庫資源。

若要部署 WhatsApp Business API 用戶端：

1. 前往您所在區域的 CloudFormation 主控台（例如 eu-west-1）。
2. 選擇 Create Stack（建立堆疊）。
3. 從 GitHub 下載 wa_ent.yml 檔案並儲存在本機。
4. 選擇 Upload a template file（上傳範本檔案）做為範本來源，並上傳從步驟 3 下載的範本檔案。
   

   建立堆疊
5. 點擊 Next（下一步）
   
6. 然後您就可以輸入參數。參數說明請見下表。
   
7. 設定所有參數（如下表所示）後，點擊 Next（下一步）進入 Configure stack options（設定堆疊選項）頁面。您可以依據自己偏好進行任何所需的變更，然後點擊 Next（下一步）。
8. 在 Review stack（檢閱堆疊）頁面上，您會看到參數值和堆疊選項的摘要。驗證後，勾選 Capabilities（功能）區段中的兩個方塊，並點擊 Submit（提交），開始建立堆疊。
   注意：部署大約需要 20 至 30 分鐘。
   

參數

一般配置

網路配置

容器配置

資料庫配置

記錄配置

檔案系統配置

安全配置

WhatsApp Business API 存取點

Grafana 儀表板需要這些參數來擷取應用程式指標，以進行監控。

Grafana

部署後輸出

成功建立範本之後，會顯示下列參數：

• 負載平衡器名稱：存取 WhatsApp Business 平台 API 用戶端之負載平衡器的主機名稱
• 資料庫主機名稱：在範本建立期間建立或提供的資料庫主機名稱
• 資料庫連接埠編號：用於資料庫連線的連接埠編號
• ECS 叢集名稱：所建立之 ECS 叢集的名稱
• 記錄保留天數：保留記錄的天數
• 資料庫連線 CA：資料庫連線 CA 的值（如果已設定）
• 資料庫連線憑證：資料庫連線憑證的值（如果已設定）
• 資料庫連線金鑰：資料庫連線金鑰的值（如果已設定）
• Grafana：Grafana 儀表板網址
• ShardCount：為 WhatsApp Business Platform 平台 API 設定的分片數量

編輯 SSH 安全規則

依預設，堆疊建立的安全規則允許所有流量都能夠透過 SSH 傳送到 EC2 執行個體、透過 HTTPs 傳送到 API 端點和 Grafana 儀表板，以及傳送到 cadvisor 和 Prometheus 容器。基於安全考量，強烈建議您關閉不必要的存取權限。本節將以更新 SSH 安全規則的步驟為例進行說明。您應該一律將 SSH 存取權限限制用於您信任的流量。

1. 在 EC2 - 安全群組主控台（例如：EC2 管理主控台（amazon.com））中：
   1. 在右上角選擇正確的區域。
   2. 選擇包含 <stackName>-EcsSecurityGroup 的安全群組，然後切換到 Inbound Rules（傳入規則）標籤。
      

      編輯傳入規則
   3. 選擇 Edit inbound rules（編輯傳入規則），更新 Source（來源）欄，僅允許信任的流量（例如：My IP（我的 IP））透過 SSH 存取 EC2 主機。
      
   4. 調整所有安全規則後，點擊 Save rules（儲存規則）以套用變更。
   5. 針對包含 "<stackName>-ms-xxx-EcsSecurityGroup" 的安全群組重複這些變更，以限制監控堆疊的 SSH 存取權限。

WhatsApp Business API 用戶端配置

一旦成功部署 WhatsApp Business API 用戶端，就需要進行設定使其運作。

步驟 1：電話註冊

請參閱電話號碼指南，進一步瞭解電話號碼註冊的詳細資訊。

前往 Facebook 企業管理平台，在 WhatsApp 管理工具的電話號碼頁籤下，從您的 WhatsApp 帳號下載 base64 編碼的憑證。

選擇正確的電話號碼並擁有 base64 編碼的憑證後，您需要透過 account 節點註冊 WhatsApp Business API 用戶端。如需詳細資訊，請參閱「註冊」文件。

步驟 2：設定分片

建立堆疊後，您需要使用 shards API 呼叫來增加作用中核心應用程式執行個體的數目，以達到所需的輸送量。您可以在堆疊的「輸出」部分找到分片的數量。

步驟 3：更新應用程式設定

您可以在「應用程式設定」文件中找到 WhatsApp Business API 網路回呼和其他參數的配置說明。為了達到穩定的輸送量，建議使用下列應用程式設定。

 {
    "settings": {
        "application": {
            "callback_backoff_delay_ms": 3000,
            "callback_persist": true,
            "db_garbagecollector_enable": false, # change this to true when there are no ongoing messaging campaigns
            "heartbeat_interval": 5,
            "max_callback_backoff_delay_ms": 900000,
            "media": {
                "auto_download": [
                    "document",
                    "image",
                    "video",
                    "voice",
                    "sticker",
                    "audio"
                ]
            },
            "notify_user_change_number": true,
            "pass_through": false,
            "sent_status": true,
            "show_security_notifications": false,
            "skip_referral_media_download": false,
            "unhealthy_interval": 30,
            "wa_id": "12245552741",
            "webhooks": {
                "max_concurrent_requests": 24,
                "message": {
                    "delivered": true,
                    "read": true,
                    "sent": true
                },
                "url": "<YOUR_WEBHOOK_SERVER_URL>"
            }
        }
    },
    "meta": {
        "api_status": "stable",
        "version": "2.41.3"
    }
}

      
      
    

步驟 4：[選用] SSL 配置

建立 WhatsApp Business API 用戶端時，預設會產生自我簽署憑證。可能會需要用於產生自我簽署憑證的憑證授權單位（CA）憑證來驗證 WhatsApp Business API 用戶端端點，並避免憑證信任警告。

您可以下載 CA 憑證並儲存在本機上以避免憑證信任警告，或上傳您自己的憑證。如需詳細資訊，請參閱 certificate 節點說明文件。

步驟 5：設定的驗證

完成配置和註冊步驟後，即可傳送和接收訊息來驗證 WhatsApp Business API 用戶端的基本功能。完整說明請參閱「訊息」文件。

訊息成功接收後，WhatsApp Business API 用戶端會將訊息狀態／詳細資訊 POST 至步驟 3 中設定的 Webhook。

如果您的訊息成功接收，恭喜您已準備就緒！若要深入瞭解可用的 API 端點，請參閱「參考資料」文件。

重新啟動核心應用程式和網路應用程式

若要重新啟動 WhatsApp Business API 用戶端，請在 ECS 主控台（例如 https://us-west-2.console.aws.amazon.com/ecs/home?region=us-west-2#/clusters）中：

1. 在右上角選擇正確的區域。
2. 從清單中選擇適當的叢集。
3. 在 Services（服務）頁籤中，選擇包含 WAEntService 的服務名稱。
4. 選擇 Tasks（任務）頁籤。通常應該只有一項工作，其編號由十六進位數字組成。
5. 在 Tasks（任務）視窗中，點擊右上角的 Stop（停止），然後在出現提示時再次點擊 Stop（停止）。

這樣會同時停止網路應用程式和核心應用程式。不久後，AWS 基礎架構會重新啟動網路應用程式和核心應用程式。

升級

本節逐步說明如何升級 WhatsApp Business API 用戶端和 CloudFormation（CFN）範本。執行升級會導致停機，因此請勿在此期間傳送訊息。僅在升級完成後，再恢復傳送訊息。

您可以執行以下操作來同時升級 CFN 範本和 WhatsApp Business API 用戶端版本：

1. 在「WhatsApp Business API 用戶端升級」操作說明的步驟 5 中，不要選擇 Use current template（使用目前範本），改為選擇 Replace current template（取代目前範本）。
2. 在 Specify template（指定範本）區段中，選擇「Upload a template file」（上傳範本檔案），並選擇從 GitHub 下載的最新範本檔案。

WhatsApp Business API 用戶端升級

1. 前往 CFN 主控台（例如 https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active）。
2. 在右上角選擇正確的區域。
3. 選擇已建立的 WhatsApp Business API 用戶端堆疊。
4. 點擊 Update（更新）。
5. 在 Prerequisite - Prepare template（先決條件 - 準備範本）」頁面上，選擇 Replace current template（取代目前範本）選項。在 Specify template（指定範本）區段中，選擇「Upload a template file」（上傳範本檔案），並選擇從 GitHub 下載的最新範本檔案。點擊 Next（下一步）。
6. 在 Specify stack details（指定堆疊詳細資訊）頁面上，將 WhatsApp Business API 用戶端（容器）版本變更為所需的版本。請勿變更任何其他參數。點擊 Next（下一步）。
7. 在 Configure stack options（設定堆疊選項）頁面上，點擊 Next（下一步）。
8. 在 Review（檢閱）頁面上，選擇「I acknowledge that AWS CloudFormation might create IAM resources with custom names」（我瞭解 AWS CloudFormation 可能會使用自訂名稱來建立 IAM 資源）。檢閱 Change set preview（變更設定的預覽）區段中是否有任何非預期的變更。如果有任何非預期的變更或您無法確定，請聯絡 WhatsApp 直接支援。點擊 Update stack（更新堆疊）。升級完成後，即可在 CFN 主控台中追蹤堆疊更新狀態，且堆疊更新狀態會從 UPDATE_IN_PROGRESS 變更為 UPDATE_COMPLETE。

WhatsApp CFN 範本升級

1. 前往 CFN 主控台（例如 https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active）。
2. 在右上角選擇正確的區域。
3. 選擇已建立的 WhatsApp Business API 用戶端堆疊。
4. 點擊 Update（更新）。
5. 在 Prerequisite - Prepare template（先決條件 - 準備範本）」頁面上，選擇 Replace current template（取代目前範本）選項。在 Specify template（指定範本）區段中，選擇「Upload a template file」（上傳範本檔案），並選擇從 GitHub 下載的最新範本檔案。點擊 Next（下一步）。
6. 在 Specify Stack Details（指定堆疊詳細資訊）頁面上，根據前面各節中的資訊輸入適當的參數。點擊 Next（下一步）。
7. 在 Configure Stack Options（設定堆疊選項）頁面上，點擊 Next（下一步）。
8. 在 Review（檢閱）頁面上，選擇「I acknowledge that AWS CloudFormation might create IAM resources with custom names」（我瞭解 AWS CloudFormation 可能會使用自訂名稱來建立 IAM 資源）。檢閱 Change set preview（變更設定的預覽）區段中是否有任何非預期的變更。如果有任何非預期的變更或您無法確定，請聯絡 WhatsApp 直接支援。點擊 Update stack（更新堆疊）。升級完成後，即可在 CFN 主控台中追蹤堆疊更新狀態，且堆疊更新狀態會從 UPDATE_IN_PROGRESS 變更為 UPDATE_COMPLETE。

如何在系統閒置時手動降低成本（選用）

企業通常會想要為有時間限制的行銷活動設定高輸送量環境，並希望在非行銷活動時間保持低成本環境運作。本節提供如何手動調低 AWS 設定以節省成本的建議。

1. 在 ECS 主控台（例如：Amazon ECS）中：
   1. 在右上角選擇正確的區域。
   2. 從清單中選擇適當的叢集。
   3. 在 Services（服務）頁籤中，選擇包含 WAEntCoreappService 的服務名稱。選擇 Edit Service（編輯服務），並將「Desired tasks」（所需任務）值更新為 0。
      

      部署配置
   4. 針對所有其他服務重複步驟 c，包括 WAEntWebService、WAEntMasterService 和 HostExporterService。
   5. 返回叢集頁面，在 Tasks（任務）頁籤中，確認上述服務沒有正在執行中的任務。
2. 在 EC2 - Auto Scaling Groups（自動擴展群組）主控台（例如：自動擴展群組 | EC2 管理主控台（amazon.com））中：
   1. 在右上角選擇正確的區域。
   2. 選擇名稱中包含 HAECSAutoScalingGroup 之堆疊的自動擴展群組，然後選擇 Edit（編輯）。將「Desired capacity」（所需容量）和「Minimum capacity」（容量下限）都更新為 3。
      

      群組大小
   3. 選擇名稱中包含 HAECSAutoScalingGroupWeb 之堆疊的自動擴展群組，然後選擇 Edit（編輯）。將「Desired capacity」（所需容量）和「Minimum capacity」（容量下限）都更新為 2。
3. （選用）如果「Type of message​​」（訊息類型）的初始值為任何映像類型，您可以將 EC2 執行個體類型更換為較便宜的 c5.large 選項。
   1. 在 EC2 - Launch Templates（啟動範本）主控台中，從清單中選擇適當的啟動範本。
   2. 選擇 Actions（動作）- Modify template (create new version)（修改範本（建立新版本））。
      

      啟動範本主控台
   3. 在 Instance type（執行個體類型）區段中，將「Instance type」（執行個體類型）更新為 c5.large，然後選擇 Create template version（建立範本版本）。
      

      執行個體類型
   4. 在 EC2 - Auto Scaling Groups（自動擴展群組）主控台中，選擇名稱中包含 HAECSAutoScalingGroup 之堆疊的自動擴展群組。
   5. 在 Launch template（啟動範本）區段中選擇 Edit（編輯）。
   6. 選擇在步驟 3c 中建立的新啟動範本，然後選擇 Update（更新）。
      

      啟動範本
4. 在 RDS 主控台（例如：RDS 管理主控台（amazon.com））中：
   1. 在右上角選擇正確的區域。
   2. 從清單中選擇適當的 Aurora 資料庫。
   3. 選擇 Modify（修改），然後將「DB instance class」（資料庫執行個體類別）更新為 r5.xlarge。
      

      執行個體配置
5. 在 ECS 主控台（例如：Amazon ECS）中：
   1. 在右上角選擇正確的區域。
   2. 從清單中選擇適當的叢集。
   3. 在 Services（服務）頁籤中，選擇包含 WAEntCoreappService 的服務名稱。選擇 Edit Service（編輯服務），並將「Desired tasks」（所需任務）值更新為 3。
   4. 在 Services（服務）頁籤中，選擇包含 HostExporterService 的服務名稱。選擇 Edit Service（編輯服務），並將「Desired tasks」（所需任務）值更新為 3。
   5. 在 Services（服務）頁籤中，選擇包含 WAEntWebService 的服務名稱。選擇 Edit Service（編輯服務），並將「Desired tasks」（所需任務）值更新為 2。
   6. 在 Services（服務）頁籤中，選擇包含 WAEntMasterService 的服務名稱。選擇 Edit Service（編輯服務），並將「Desired tasks」（所需任務）值更新為 2。
6. 等待所有服務啟動所需數量的任務。所有任務都開始執行後，使用設定分片 API 將分片重設為 2。
7. 使用健康狀態 API 來驗證系統的健康狀態。也可以傳送和接收訊息來驗證 WhatsApp Business API 用戶端的基本功能。完整說明請參閱「訊息」文件。