開始使用

本教學導覽說明如何設定內部部署 API 用戶端、註冊商家電話號碼、更新設定，以及傳送測試訊息。

開始使用此 API 的程序可分為 3 個部分：

準備資產 - 在開始之前，您必須設定完成 API 整合所需的資產，包括 WhatsApp Business 帳號。
安裝內部部署 API 用戶端 - 安裝 API 用戶端。在用戶端運作之後，您就可以更新應用程式設定。
開始使用用戶端 - 向 /account 發出 API 呼叫來註冊電話號碼，並向 /messages 發出呼叫來傳送測試訊息。

準備工作

必備資料：

Facebook 企業管理平台帳號
已驗證的企業
WhatsApp Business 帳號
WhatsApp Business 帳號的帳號額度 - 您也可以參閱關於內部部署 API 收費，進一步瞭解收費處理的資訊。
命令列工具，例如 Terminal 或可執行 cURL 要求的 Postman 等應用程式。

驗證企業商家之後，系統將針對企業是否遵守 WhatsApp 服務條款和 WhatsApp 商務政策進行審查。此步驟會自動啟動。您可以在企業管理平台中 WhatsApp Business 帳號的設定頁籤，查看商家驗證和企業審查的狀態。審查核准後，商家驗證將顯示為已驗證，帳號狀態將顯示為已核准。

設定 WhatsApp 帳號

在 WhatsApp Business 帳號中新增電話號碼及其顯示名稱。此舉會提交顯示名稱以供審查。

在完成註冊前，您可以視需要反覆變更顯示名稱；完成註冊後，每次提出顯示名稱變更要求都要間隔 30 天。

完成所有審查後，您可以查看和存取 Base64 編碼憑證，此為註冊內部部署 API 用戶端必須持有的憑證。建議在對顯示名稱進行任何其他變更之前，先使用核准的顯示名稱註冊開始整合。整合之後，您可以隨時變更顯示名稱。

審查收費和定價資訊

若您的企業商家開始使用內部部署 API 傳送訊息，請務必瞭解這項程式的收費流程，例如收費方式與時機，以及查看與支付每月帳單的方法。如需詳細資訊，請參閱關於 WhatsApp Business 帳號收費。如需定價規則和每則訊息的成本，請參閱定價頁面。

軟體	版本	詳細資訊
內部部署 API	請查看變更紀錄	請查看變更紀錄
適用於 AWS 的內部部署 API	請查看變更紀錄範本版本：`v3.0.1`	請查看變更紀錄
MySQL	`5.7.xx` 和 `8.0.xx`	請注意，已經移轉至 MySQL 8 的資料庫不能降級為 MySQL 5。因此，在移轉之前請備份資料庫。
PostgreSQL	`13.8`	支援 `13.x`、`12.x` 和 `11.x`
Docker	`18.04` 或更新版本，不包括 `19.03.7` 版	自 `v2.33` 起要求使用 `18.04` 版請確定 statx syscall 已列入 Docker 的 syscall 許可清單。
Postman	任何最新版本
libseccomp	`2.3.3`	僅支援 `2.3.3` 版
glibc	`2.28`	僅支援 `2.28` 或更新版本
作業系統（OS）	最新版本	至少使用最低核心 `4.11` 版

步驟 1：安裝內部部署 API 用戶端

環境

內部部署 API 用戶端的核心是以 Docker 為基礎。請參閱用戶端架構，瞭解各個元件的相關資訊。

內部部署 API 用戶端目前不支援 Docker for Windows 或 Windows Subsystem for Linux。針對開發需求，建議使用 Linux 虛擬機器來執行 Docker。若是生產工作負載，建議使用 Linux 伺服器以避免相容性和效能問題。

設備

內部部署 API 用戶端可以在執行 Linux 版 Docker 的任何網際網路連線電腦（無論在虛擬機或在 Linux 伺服器中）上執行。如需詳細資訊，請參閱常見問題。例如，您可以在筆記型電腦上進行簡單的測試。如果要在生產環境伺服器上使用，建議至少配備 250 GB SSD、16 GB RAM 和 4 核心 CPU。不建議使用 HDD，因為 I/O 速度會成為負載的瓶頸。

在大多數情況下，您應該從核心應用程式和網路應用程式容器的個別實體伺服器上執行資料庫。資料庫伺服器離運算電腦應只有幾毫秒的延遲。

安裝

開始使用內部部署 API 的方法有兩種：

內部部署安裝 - 您可以使用安裝指南自行設定 Docker 容器。建議您從其中一個開發人員設定開始著手，以熟悉設定程序和傳送訊息。在轉移到生產環境之前，您可以在電腦上使用此內部部署類型解決方案。
Amazon Web Services（AWS）：如果您使用 AWS 或想要更獨立的解決方案，請參閱 AWS 指南。AWS 解決方案會在您管理和擁有的 AWS 雲端設定完整的內部部署 API 解決方案，其中包含備份、復原等功能。

當內部部署 API 用戶端開始執行後，您必須以 admin 身分登入才能執行其餘的設定步驟。

更新設定

在內部部署 API 用戶端運作之後，您就可以變更應用程式設定。然而，您必須等到註冊完成之後，才能存取內部部署 API 用戶端的不同檔案設定。

與用戶端運作方式相關的應用程式設定 - 回呼設定、Webhooks、待命呼叫器、已傳送狀態、媒體下載行為等。注意：強烈建議您設定 Webhook 網址，以接收有關傳入訊息或錯誤的通知。
商業簡介設定和個人檔案設定涵蓋企業商家的資訊，例如地址、電子郵件、網站、行業、關於資訊和個人頭像。

步驟 2：開始使用用戶端

註冊

在準備好並執行內部部署 API 用戶端之後，您可以透過傳送 API 呼叫到 account 端點來註冊電話號碼。

傳送測試訊息

您可以使用 messages 端點傳送測試訊息。首先，檢查用於測試的電話號碼狀態。您必須從測試電話號碼向 WhatsApp 帳號傳送一則訊息，以啟用「客戶服務」視窗，讓您在 24 小時視窗中傳送任何類型的訊息（詳情請參閱截斷控制）。然後，傳送一則簡訊到您的測試電話號碼。如果訊息送達，代表已安裝成功。如果訊息未送達，請檢查 Webhook，看看是否有通知指示任何問題。

安全

請參閱我們的安全性指南，瞭解關於密碼、驗證、SSL 設定、網路隔離、加密通訊、HTTP 標頭，以及網頁伺服器 TLS 通訊協定與內部部署 API 用戶端相關的資訊。

啟動程序

WhatsApp 內部部署 API 在與伺服器建立連線後會進行啟動程序。為了確保提供順暢和可靠的方式來傳送和接收訊息，此程序至關重要。在此啟動階段，核心應用程式（coreapp）會等待滿足幾個必要條件，包括：

載入範本訊息：API 載入伺服器的範本訊息，作為其初始化程序的一部分。
接收和處理離線訊息：其同時會進行離線訊息的接收和處理。

如果在未滿足上述必要條件時嘗試傳送訊息，核心應用程式將回覆「核心應用程式未就緒」錯誤訊息，且記錄將顯示「服務未就緒」錯誤。請務必注意，每次與 WhatsApp 伺服器建立新連線時，都會執行此啟動程序。因此，如果核心應用程式重新啟動或中斷連線，系統將再次起始啟動程序，以將核心應用程式的狀態設定為「就緒」。如此可確保 WhatsApp 內部部署 API 在訊息通訊時的可靠性和整備度。

離線訊息處理

當系統找不到離線訊息時，將省略離線訊息處理步驟。換句話說，如果離線狀態下沒有訊息在等待，系統會略過此特定的訊息處理階段。

在一般情況下，WhatsApp 內部部署 API 會遵循離線訊息處理的標準通訊協定。其會等待接收和處理所有離線訊息，預先定義的最大逾時為 6 分鐘。經過此 6 分鐘時間長度後，系統會將離線訊息處理階段視為已成功完成。

其他建議

建議事項

開始向內部員工傳送和接收訊息，以檢查系統是否正常運作。

在 24 小時內回覆所有顧客。

遵守我們在《WhatsApp 商家政策》和《WhatsApp 商務政策》中概述的規範。

在開發版、測試版和正式版中使用多個電話號碼。

開啟直接支援（服務）票證之前，請先檢查常見問題。

提供產品意見回饋，直接支援（服務）是最佳回饋管道。

提供詳細資訊以利重現問題，例如：記錄、health 和 support 節點的支援資訊、WADebug 資料、可重現的 API 呼叫等。

避免事項

向多個管道傳送重複的通知。

傳送垃圾訊息。

使用 1-800 號碼進行測試。

僅建立適用於 WhatsApp 整合的企業管理平台。使用現有的產品（如果可用）。

如果我們發現您違反任何準則或政策，將保留限制或移除您存取 WhatsApp 的權利。

瞭解詳情

WhatsApp Business 平台 | 雲端 API | 內部部署 API | Business Management API