從雲端 API 轉移至內部部署 API

我們即將停用內部部署 API。詳情請參閱內部部署 API 停用文件，並從中了解如何轉用新一代雲端 API。

本文件會講解如何將商家電話號碼從雲端 API 轉移至內部部署 API。如需從內部部署 API 轉移至雲端 API，請參閱從內部部署 API 轉移至雲端 API。

請注意，在不同 API 之間轉移商家電話號碼的操作，有別於在 WhatsApp Business 帳戶之間轉移商家電話號碼。

轉移操作不會影響以下項目：

商家電話號碼的顯示名稱、驗證狀態或品質評分
商家電話號碼所用的範本及其狀態
商家自有的 WhatsApp Business 帳戶、官方商業帳戶狀態，或其收發訊息限制

不過，為了支援轉移操作，您必須留意任何 API 之間的差異並針對這些差異採取措施，然後才執行本文件所述的轉移步驟。

最佳操作實例

確保您的應用程式能夠應對所有 API 之間的差異後，建議您先轉移用量較低的商家電話號碼，然後再驗證您想透過內部部署 API 提供的所有功能是否都能正常運作。驗證一切都能正常運作後，您可轉移其他號碼。

我們亦建議在通往內部部署 API 部署的流量較低時執行轉移操作。

API 之間的差異

在開始轉移流程之前，請確保您的應用程式可以應對這些差異。

Webhooks

雲端 API 和企業管理 API 的 Webhooks 裝載結構與內部部署 API 的裝載結構並不相同。建議建立新的 Webhook 端點，專門用來處理內部部署 API Webhooks。

請參閱以下文件，了解不同裝載的差別：

配置：WhatsApp 的 Webhooks
雲端 API Webhook 裝載：Webhooks 通知裝載參考資料
企業管理 API Webhook 裝載：Webhooks 設定

在您完成轉移至內部部署 API 的流程後，系統將不再傳送商家電話號碼的雲端 API Webhooks，而是開始傳送內部部署 API Webhooks。

媒體

任何媒體上載至雲端 API 後，其媒體編號無法在透過內部部署 API 傳送訊息時使用，因此您必須使用內部部署 API 重新上載媒體以產生新的媒體編號，或者如果媒體託管在公開伺服器上，則必須使用媒體網址。請參閱傳送媒體訊息。

錯誤代碼

雲端 API 和企業管理 API 的錯誤代碼與內部部署 API 的錯誤代碼並不相同。請參閱下列文件：

「按住即可聊天」訊息

內部部署 API 透過將 messages.type 設定為 voice 以在 Webhooks 中辨別「按住即可聊天」（PTT）訊息，而雲端 API 則透過將 messages.audio.voice 設定為 true 以辨別 PTT 訊息。

停機時間

停機時間在您執行註冊程序步驟（步驟 3）時即會開始，應該只會持續幾秒鐘。期間，WhatsApp 用戶傳送至此號碼的訊息會被悄悄棄置。

強烈建議您將轉移時間安排在號碼活躍度較低的時段，以盡量減少停機時間的影響。

步驟 1：整合內部部署 API

由於您要將企業電話號碼轉移至內部部署 API，請確保您的應用程式可以成功使用內部部署 API 用戶端，並且檢查與該企業電話號碼連結的 WhatsApp Business 帳戶是否已正確配置 Webhooks。

步驟 2：準備轉移

建議您在完成轉移程序期間停止傳送訊息。

WhatsApp Business API 內部用戶端在連接至 WhatsApp 伺服器方面設有特定的網絡要求。為確保您做好準備，請查閱設定網絡及網絡偵錯。

步驟 3：註冊 API 用戶端

在您的內部部署 API 用戶端上註冊企業電話號碼。如要註冊，請呼叫 /account 端點：

POST /v1/account

{
    "cc": "COUNTRY_CODE",
    "phone_number": "PHONE_NUMBER_WITHOUT_COUNTRY_CODE",
    "method": "sms" or "voice",
    "cert": "VERIFIED_NAME_CERT_IN_BASE64",
    "pin": "EXISTING_6_DIGIT_PIN" # required if two-step verification is enabled
}

視乎收到的回應，我們會決定註冊步驟已完成，還是仍剩餘一個步驟。成功的話，您會收到下列其中一個 HTTP 狀態代碼。請遵循符合您所收到的回應之相關指示：

201 Created：此帳戶已存在。您已經註冊過應用程式，因此無需作出其他動作。
202 Accepted：此帳戶不存在。請根據您在要求中選擇的方式，檢查您用於接收註冊代碼的短訊或語音通話號碼。此回應將包括一個已傳回承載，其中包含從 cert 參數解碼的 vname，以便您確認需要設定的顯示名稱是否正確。如果正確，請繼續在完成帳戶註冊部分完成註冊。

點擊此處，查看此端點的所有可用欄位。

註冊完成後，訊息便會是由內部部署 API 用戶端所接收。

步驟 4：設定分片

註冊用戶端後，您便可以根據需要設定分片。

步驟 5：開始傳送訊息

您已準備好向顧客傳送訊息。請參閱傳送訊息指南，獲取相關指引。

WhatsApp Business 平台 | 雲端 API | 企業管理 API