註冊

若要透過雲端 API 使用您的商家電話號碼,您必須進行註冊。在下列情況註冊您的商家電話號碼:

  • 帳號建立:實作此 API 時,您需要註冊欲用於傳送訊息的商家電話號碼。我們會在帳號建立期間強制設定雙步驟驗證,為您的帳號新增額外的安全層級。
  • 名稱變更:在此情況下,您的電話號碼已註冊,且您想要變更顯示名稱。首先,您必須在 WhatsApp 管理工具中申請更名。名稱獲得核准後,您必須使用新名稱再次註冊電話號碼。
  • 將您的電話號碼從內部部署 API 移轉至雲端 API。請參閱移轉例外狀況

註冊商家電話號碼之前,必須先驗證其擁有權

移轉例外狀況

如果您要將電話號碼從內部部署 API 移轉至雲端 API,您需要採取額外步驟才能在雲端 API 註冊電話號碼。請查看在內部部署 API 及雲端 API 之間移轉,瞭解完整處理程序。

註冊商家電話號碼

若要註冊已驗證的商家電話號碼,請向 PHONE_NUMBER_ID/register 發出 POST 呼叫。請包含下列參數。

端點驗證

PHONE_NUMBER_ID/register

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

限制

在 72 小時移動期間內,註冊端點的要求限制為每個商家號碼 10 個要求。

當您提出註冊要求時,我們將檢查您在過去 72 小時內為註冊該號碼提出了多少次註冊要求。如果您已發出 10 次要求,API 將傳回錯誤代碼 133016,並將在接下來 72 小時內禁止註冊該號碼。

參數

名稱說明

messaging_product

必要項目。

傳送訊息服務使用。請將此值設為 "whatsapp"

pin

必要項目。

如果已驗證的商家電話號碼已啟用雙步驟驗證,請將此值設為電話號碼的 6 位數雙步驟驗證 PIN 碼。如果您想不起自己的 PIN 碼,可以進行更新


如果已驗證的商家電話號碼未啟用雙步驟驗證,請將此值設為 6 位數字。此數字將是新驗證商家電話號碼的雙步驟驗證 PIN 碼。

data_localization_region

選用項目。


若包含此項目,則會啟用商家電話號碼的本機儲存空間。值必須是 2 個字母的 ISO 3166 國碼/區碼(例如 IN),指出您想要儲存靜態資料的國家/地區。


支援的值:


亞太地區

  • 澳洲:AU
  • 印尼:ID
  • 印度:IN
  • 日本:JP
  • 新加坡:SG
  • 韓國:KR

歐洲

  • 歐盟(德國):DE
  • 瑞士:CH
  • 英國:GB

拉丁美洲

  • 巴西:BR

中東和非洲

  • 巴林:BH
  • 南非:ZA
  • 阿拉伯聯合大公國:AE

北美地區

  • 加拿大:CA

一旦啟用,就無法直接停用或變更。您必須取消註冊該電話號碼,並重新註冊而不包含此參數(以停用),或包含此參數並加上新的國碼/區碼(以變更)。


若要針對已註冊的電話號碼啟用本機儲存空間,您必須取消註冊該電話號碼,然後重新註冊並包含此參數。

不啟用本地儲存空間的要求範例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834"
}

啟用本地儲存空間的要求範例

curl 'https://graph.facebook.com/v21.0/106540352242922/register ' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "messaging_product": "whatsapp",
  "pin": "212834",
  "data_localization_region": "CH"
}

All API calls require authentication with access tokens.

Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup.

Solution Partners must authenticate themselves with an access token with the whatsapp_business_messaging and whatsapp_business_management permissions. See System User Access Tokens for information.

取消註冊商家電話號碼

取消註冊商家電話號碼會使其無法再用於雲端 API,並且會停用該電話號碼的本機儲存空間(如果已啟用)。

取消註冊不會刪除電話號碼或其訊息記錄。若要刪除電話號碼及其記錄,請參閱從 WABA 刪除電話號碼

若要取消註冊商家電話號碼,請向 PHONE_NUMBER_ID/deregister 發出 POST 呼叫:

端點驗證

PHONE_NUMBER_ID/deregister

Solution Partners must authenticate themselves with an access token with the whatsapp_business_management permission.

限制

在 72 小時移動期間內,撤銷註冊端點的要求限制為每個商家號碼 10 個要求。

當您提出撤銷註冊要求時,我們將檢查您在過去 72 小時內為撤銷註冊該號碼提出了多少次撤銷註冊要求。如果您已發出 10 次要求,API 將傳回錯誤代碼 133016,並將在接下來 72 小時內禁止撤銷註冊該號碼。

範例

要求範例:

curl -X POST \  
 'https://graph.facebook.com/v21.0/FROM_PHONE_NUMBER_ID/deregister' \  
 -H 'Authorization: Bearer ACCESS_TOKEN'

成功時的回應如下:

{
  "success": true
}