解決方案合作夥伴新手指南

此指南逐步說明解決方案合作夥伴應如何為顧客提供雲端 API。整個流程包含 4 個主要階段：

1. 準備和規劃
2. 設定資產
3. 簽署合約
4. 組建整合工具

完成這些操作後，請持續留意每月更新。

準備和規劃

閱讀文件

開始之前，建議您先詳閱我們的開發人員文件和 Postman 收藏。這樣有助您理解雲端 API 的運作方式，包括如何開始使用和轉移號碼。

規劃入門流程和轉移

您必須使用內嵌註冊功能協助新顧客展開雲端 API 入門流程。如果您未曾使用內嵌註冊，請整合並啟用此功能。內嵌註冊是最快捷簡單的顧客註冊方式，他們可以在五分鐘內完成註冊並開始傳送訊息。

接下來，請考慮您希望首先把哪些客戶轉移至雲端 API。一般來說，我們建議您把所有客戶從內部部署 API 轉移至雲端 API，但每位客戶的需求可能各有不同。在考慮轉移哪些客戶時，請注意以下事項：

當您確定轉移對象後，即可開始制定轉移計劃和時間表。

制定計劃時，請記得系統設計需要符合以下兩種情況：協助新顧客展開入門流程，以及將現有顧客從內部部署 API 轉移至雲端 API。如果是轉移客戶，請加入一些相關的計劃，以將您目前的內部部署實例備份並把相關號碼轉移至雲端 API。

制定與客戶的溝通計劃

首先，您需要確定是否要通知現有客戶有關轉移的事宜。然後，您應確定是否需要建立或更新任何文件，以支援雲端 API 設定。

作出定價決策

雲端 API 的寄存費用由 Meta 承擔，因此您要決定是否對您的定價作出相應更新。

設定資產

如要使用雲端 API，解決方案合作夥伴必須擁有以下資產：

簽署合約

接受服務條款

如要存取 WhatsApp Business 訊息雲端 API，您必須先代表商家接受《WhatsApp Business 平台服務條款》。

操作方法如下：前往 WhatsApp 管理工具，在資訊橫額中接受服務條款。

如果您目前是雲端 API 的測試版合作夥伴，則可享有 90 天的寬限期。換言之，您必須在 2022 年 7 月 5 日之前接受條款，否則會失去存取權。

如果您是初次使用雲端 API 的商家（包括從內部部署 API 轉移過來的商家），請務必先接受服務條款，否則無法開始使用雲端 API。如不接受服務條款，您將無法接收註冊通話。

組建整合工具

第 1 步：取得系統用戶存取憑證

Graph API 呼叫會使用存取憑證以作驗證。詳情請參閱存取憑證。建議您以系統用戶的角色產生憑證。

如要產生系統用戶存取憑證：

1. 前往企業管理平台 > 企業管理平台設定 > 用戶 > 系統用戶，查看您建立的系統用戶。
2. 點擊該用戶並選擇新增資產。一個新視窗隨即開啟。
3. 在左側面板的選擇資產類型下方，選擇應用程式。在選擇資產下方，選擇您想使用的 Meta 應用程式（您的應用程式必須具有正確的權限）。啟用該應用程式的開發人員應用程式。
4. 選擇儲存變更以儲存設定，然後返回系統用戶主畫面。
5. 現在您已準備好產生憑證。在系統用戶主畫面，點擊產生憑證，然後選擇 Meta 應用程式。選擇應用程式後，畫面即會顯示可用權限的清單。選擇 whatsapp_business_management 和 whatsapp_business_messaging。點擊產生憑證。
6. 新的視窗隨即開啟，當中會顯示系統用戶、獲指派的應用程式和存取憑證。儲存您的憑證。
7. 或者，您也可以點擊該憑證並查看憑證除錯工具。除錯工具會顯示您所選擇的兩項權限。您也可以直接在存取憑證除錯工具貼上憑證。

第 2 步：設定 Webhooks

設定 Webhooks 後，您可以接收來自 WhatsApp Business 平台的即時 HTTP 通知。這就表示，如果您收到顧客的訊息，或是 WhatsApp Business 帳戶有所變更或發生其他情況，系統就會傳送通知。

如要設定 Webhooks，您必須使用符合 Meta 和 WhatsApp 要求的網址來建立連結互聯網的網絡伺服器。如需具體指示，請參閱建立端點。如果需要端點以供測試之用，您可以產生測試 Webhooks 端點。

應用程式設定

準備好端點後，請配置此端點以供 Meta 應用程式使用：

您只需為每個應用程式設定一次 Webhooks。您可以使用相同的 Webhook 接收來自多個 WhatsApp Business 帳戶的多個事件類型。詳情請參閱我們的 Webhooks 部分。

第 3 步：訂閱 WhatsApp Business 帳戶

為確保收到的通知來自正確的帳戶，請訂閱您的應用程式：

curl -X POST \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/subscribed_apps' \
-H 'Authorization: Bearer ACCESS_TOKEN'

如果收到以下回應，此帳戶下的電話號碼的所有 Webhook 事件都將傳送至您已配置的 Webhooks 端點。

{
  "success": true
}

第 4 步：取得電話號碼編號

如要傳送訊息，您必須註冊要使用的電話號碼，即上文準備工作所提及的商家電話號碼。

繼續進行註冊程序前，您必須找出該電話號碼的編號。如要取得電話號碼編號，請發出以下 API 呼叫：

curl -X GET \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/phone_numbers' \
-H 'Authorization: Bearer ACCESS_TOKEN'

如果要求成功，回應中將包含與您 WhatsApp Business 帳戶關聯的所有電話號碼：

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

儲存您想註冊的電話號碼之編號。如欲了解此端點的更多資訊，請參閱讀取電話號碼。

轉移例外情況

第 5 步：註冊電話號碼

取得電話號碼編號後，您便可以註冊號碼。在註冊 API 呼叫中，您需要同時執行以下兩項操作：

1. 註冊電話號碼。
2. 設定一個 6 位數的註冊代碼（此代碼必須由您設定），以啟用雙重驗證功能。儲存並記住此代碼，因為系統日後會要求您提供這項資訊。

必須設定雙重驗證，方能使用雲端 API。如未設定，您會收到入門失敗訊息：

要求範例：

curl -X POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/register' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp","pin": "6_DIGIT_PIN"}'

回應範例：

{
  "success": true
}

內嵌註冊用戶

第 6 步：接收來自消費者應用程式的訊息

當參與互動的顧客向您的商家傳送訊息時，您可以在 24 小時內免費與其互傳訊息，這段期間稱為「顧客服務時段」。出於測試目的，我們建議您啟用這個時段，這樣您就可以按需要傳送多則訊息，不受限制。

使用個人 WhatsApp iOS／Android 應用程式，向您剛才註冊的電話號碼傳送訊息。傳送訊息後，您應該會收到一則傳送至 Webhooks 且附有通知的傳入訊息，此訊息的格式如下：

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "16315551234",
              "phone_number_id": "PHONE_NUMBER_ID"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Kerry Fisher"
                },
                "wa_id": "16315555555"
              }
            ],
            "messages": [
              {
                "from": "16315555555",
                "id": "wamid.ABGGFlA5FpafAgo6tHcNmNjXmuSf",
                "timestamp": "1602139392",
                "text": {
                  "body": "Hello!"
                },
                "type": "text"
                }
            ]
          },
        "field": "messages"
        }
      ]
    }
  ]
}

第 7 步：傳送測試訊息

啟用顧客服務時段後，您可以向上一步所用到的消費者號碼傳送測試訊息。如要執行此操作，請發出以下 API 呼叫：

curl -X  POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp", "to": "16315555555","text": {"body" : "hello world!"}}'

如果呼叫成功，回應中將包含訊息編號。您可以使用這個編號，透過 Webhooks 追蹤訊息進度。編號的長度上限為 128 個字元。

回應範例：

{
  "id":"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o"
}

持續留意每月更新

我們會在每個月的第一個星期二發佈雲端 API 更新，其中包括全新功能和改善項目。由於雲端 API 會自動更新，因此您無需採取任何操作都可使用這些新功能。

常見問題

一般常見問題

技術實施常見問題

What is the architecture of the Cloud API?

The Cloud API architecture significantly simplifies the Solution Partner's operational and infrastructure requirements to integrate with WhatsApp Business Platform. First, it removes the infrastructure requirements to run Business API docker containers (CAPEX savings). Second, it obviates the need of operational responsibilities to manage the deployment (OPEX savings). For details, refer to the architecture diagram comparing the On-Premises and Cloud API deployments.

固定連結

資料私隱和安全常見問題

監管規定常見問題