註冊程序

如要將您的商家手機號碼用於雲端 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,可以更新 PIN


如果您未為已驗證的商家電話號碼啟用雙重認證功能,請將此值設為一個 6 位數號碼。這會是新驗證的商家電話號碼的雙重認證 PIN。

data_localization_region

此為選用項目。


加入後,系統會為商家電話號碼啟用本機儲存空間。值必須是雙字母的 ISO 3166 國碼/區碼(例如 IN),表示您希望儲存靜態資料的國家/地區。


支援的值:


亞太地區

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

歐洲

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

拉丁美洲

  • 巴西:BR

中東和非洲

  • 巴林:BH
  • 南非:ZA
  • 阿拉伯聯合酋長國:AE

北美洲

  • 加拿大:CA

一經啟用,便無法直接停用或變更。相反,您必須取消註冊該號碼,並在不使用此參數的情況下重新註冊(如要停用),或者加入含新國碼/區碼的參數(如要變更)。


如要對已註冊的號碼啟用本機儲存空間,您必須取消註冊該號碼,然後重新註冊並加入此參數。

無本機儲存空間的要求範例

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

有本機儲存空間的要求範例

curl 'https://graph.facebook.com/v19.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,並會停用該號碼的本機儲存空間(如已啟用)。

取消註冊並不會刪除號碼或其訊息記錄。如要刪除號碼及其訊息記錄,請參閱刪除 WhatsApp Business 帳戶中的電話號碼

如要取消註冊某個商家電話號碼,請向 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/v19.0/FROM_PHONE_NUMBER_ID/deregister' \  
 -H 'Authorization: Bearer ACCESS_TOKEN'

成功的回應看起來會是這樣:

{
  "success": true
}