新手指南
本教學導覽介紹如何設定內部部署 API 用戶端、註冊商家手機號碼、更新設定以及傳送測試訊息。
本 API 入門程序可分為 3 個部分：
- 準備資產：開始前，請務必設定完成 API 整合所需的資產，包括 WhatsApp Business 帳戶。
- 安裝內部部署 API 用戶端：安裝 API 用戶端。用戶端開始運作後，您可以更新您的應用程式設定。
- 開始使用用戶端：使用 API 呼叫，將手機號碼註冊至
/account，並透過呼叫將測試訊息傳送至/messages。
準備工作
您需要：
- WhatsApp Business 帳戶信用額度：如欲進一步了解有關收費流程的資訊，請參閱內部部署 API 帳單收費簡介。
- 指令碼行工具（如終端機）或可以執行 cURL 要求的應用程式（如 Postman）。
完成商家驗證後，我們會審查您的企業是否符合《WhatsApp 服務條款》和《WhatsApp 商務政策》。系統將自動開始此步驟。您可以前往企業管理平台，在 WhatsApp Business 帳戶的設定分頁中查看商家驗證及企業審查的狀態。獲得批准後，商家驗證將顯示為已驗證，而帳戶狀態將顯示為已批准。
設定您的 WhatsApp 帳戶
為 WhatsApp Business 帳戶加入手機號碼及顯示名稱。此動作將提交顯示名稱以供審查。
如果您想更改顯示名稱，則可以在完成註冊程序前執行此操作（次數不限）；完成註冊程序後，每次提交顯示名稱更改要求時，您將需等待 30 日才能再次提出此類要求。
完成所有審查後，您可以查看和存取以 Base64 方式編碼的證書，而此證書是註冊內部部署 API 用戶端的必要條件。我們鼓勵您先使用已批准的顯示名稱來註冊，以便開始整合流程，然後再進一步更改顯示名稱。完成整合後，您可以隨時更改顯示名稱。
查看帳單及定價資訊
若您的企業開始使用內部部署 API 傳送訊息，請務必了解其帳單收費流程，例如收費方式與時機，以及查看和支付每月帳單的方法。如需更多資訊，請參閱關於 WhatsApp Business 帳戶的帳單。如要進一步了解每則訊息的定價規則和成本，請參閱我們的定價頁面。
建議的軟件版本
| 軟件 | 版本 | 詳細資訊 |
|---|---|---|
內部部署 API | ||
AWS 內部部署 API | 範本版本： | |
MySQL |
| 請注意，轉移到 MySQL 8 的數據庫無法降級到 MySQL 5。因此，請在轉移前備份數據庫。 |
PostgreSQL |
| 支援 |
Docker |
| 由 確保 statx syscall 位於 docker 的系統呼叫許可清單之中。 |
Postman | 任何最新版本 | |
libseccomp |
| 僅支援 |
glibc |
| 僅支援 |
作業系統（OS） | 最新版本 | 最少使用最低內核版本 |
第 1 步：安裝內部部署 API 用戶端
環境
內部部署 API 用戶端本質上是以 Docker 為基礎。如需了解每個組成部分，請參閱用戶端架構。
內部部署 API 用戶端目前不支援 Windows 版 Docker 或 Linux 版 Windows Subsystem。如有開發需要，我們建議您使用 Linux 虛擬機器，並在此虛擬機器中運行 Docker。如需處理正式版負載，我們建議您使用 Linux 伺服器，以免出現相容性和效能問題。
設備
內部部署 API 用戶端可在任何透過虛擬機器或 Linux 伺服器運行 Linux 版 Docker，且連接至互聯網的機器中運作。詳細資訊請參閱常見問題。例如，您可以使用手提電腦來進行簡單的測試。若要在正式版環境伺服器中使用它，我們建議最少配備 250 GB SSD、16GB RAM 和 4 核 CPU。我們不建議您使用 HDD，因為 I／O 速度會在承受負載時變成阻礙。
在大多數情況下，您應該使用與核心應用程式和網頁應用程式容器分開的實體伺服器來運行數據庫。數據庫伺服器與電腦之間只可有幾毫秒的延遲時間。
安裝
開始使用內部部署 API 的方法有兩種：
- Amazon Web Services（AWS）：如果您正在使用 AWS，或是有意使用更獨立的解決方案，請參閱我們的 AWS 指南。AWS 解決方案能在由您管理和擁有的 AWS 雲端中建立一個完整的內部部署 API 解決方案，並設有備份、復原等功能。
內部部署 API 用戶端開始運行後，您就必須以 admin 身分登入，才可以執行餘下的設定步驟。
更新您的設定
內部部署 API 用戶端開始運行後，您便可以更改應用程式設定。不過，您必須完成註冊，方可獲得內部部署 API 用戶端不同個人檔案設定的存取權限。
- 應用程式設定與用戶端的運作方式相關，包括回呼設定、Webhooks、On-call Pager、傳送狀態、媒體下載行為等。請注意：我們強烈建議您設定 Webhook 網址，以接收有關已接收訊息或錯誤的通知。
第 2 步：開始使用用戶端
註冊程序
啟動並運行內部部署 API 用戶端後，您便可以向 account 端點傳送 API 呼叫，以註冊手機號碼。
傳送測試訊息
您可以使用 messages 端點傳送測試訊息。首先，請檢查您正在用於測試的手機號碼狀態。您將需要使用測試手機號碼向您的 WhatsApp 帳戶傳送訊息，以啟用顧客服務期限，而您則可以在為時 24 小時的期限內傳送任何類型的訊息（詳情請參閱截斷控制）。然後，向您的測試手機號碼傳送短訊。如果訊息能夠送達，則代表安裝成功。如果未能送達，請檢查 Webhook 是否有任何可能指出任何問題的通知。
帳戶安全
如需了解與內部部署 API 用戶端相關的密碼、驗證、SSL 配置、網絡隔離、加密通訊、HTTP 標頭和網絡伺服器 TLS 協定之資訊，請參閱我們的帳戶安全指南。
啟動程序
WhatsApp 內部部署 API 在與伺服器建立連線後會經歷啟動程序。要確保順暢且可靠地傳送和接收訊息，此程序至關重要。在此啟動階段，核心應用程式（coreapp）會等待幾項必要條件達成，包括：
載入範本訊息：在初始化程序中，API 會從伺服器載入範本訊息。
接收和處理離線訊息：其還會負責接收與處理離線訊息。
如果在未達到這些必要條件的情況下嘗試傳送訊息，核心應用程式將回應「核心應用程式未準備就緒」的錯誤訊息，記錄亦會顯示「服務未準備就緒」這個錯誤。請務必注意，每次與 WhatsApp 伺服器建立新連線時都會執行此啟動程序。因此，如果核心應用程式重新啟動或遇到連線中斷，啟動程序便會再次展開，以將核心應用程式的狀態設定為「準備就緒」。這可確保 WhatsApp 內部部署 API 準備好可靠地處理訊息通訊。
離線訊息處理
當系統找不到離線訊息時，便會省略離線訊息處理步驟。換言之，如果沒有訊息在離線狀態下有待處理，系統便會繞過這個特定的訊息處理階段。
在一般情況下，WhatsApp 內部部署 API 會遵循標準協定處理離線訊息。API 會等待接收和處理所有離線訊息，而預先定義的逾時上限為 6 分鐘。此 6 分鐘時限過後，即視為成功完成離線訊息處理階段。
其他建議
建議做法剛開始時先與內部員工收發訊息，以便檢查系統是否正常運作。 在 24 小時內回覆所有顧客。 遵守我們在 WhatsApp Business 政策和 WhatsApp 商務政策中所列的政策。 為開發、測試和正式版階段使用不同的手機號碼。 在開啟直接支援工作單前，請先查看常見問題。 提供產品意見。直接支援是提供產品意見的最佳渠道。 | 不建議做法向多個渠道傳送重複通知。 傳送垃圾訊息。 使用以 1-800 開頭的手機號碼來測試。 僅為 WhatsApp 整合建立企業管理平台。如有的話，只需使用現有平台即可。 |
如果我們發現您違反了任何守則或政策，我們將保留限制或移除您使用 WhatsApp 的權限。