檢索手機號碼

使用 WhatsApp Business 管理 API，檢索商家用作註冊其 WhatsApp Business 帳戶的手機號碼。

準備工作

您必須使用：

• 要檢索的商家手機號碼所對應的 WhatsApp Business 帳戶編號
• 連結至您 WhatsApp Business 帳戶的系統用戶存取憑證
• whatsapp_business_management 權限

限制

• 此 API 只能檢索已註冊的手機號碼。不可將此 API 用作新增、更新或刪除手機號碼。

取得所有手機號碼

如需取得與某個 WhatsApp Business 帳戶相關的所有手機號碼清單，請向 WhatsApp Business 帳戶 > 手機號碼端點傳送 GET 要求。

此外，手機號碼可以依據 last_onboarded_time 按遞增或遞減方式排列，這取決於用戶何時完成內嵌註冊的設置流程。如未指定，預設排序方式為遞減。

要求範例

curl -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}"

成功的話，系統會傳回一個 JSON 物件，其中列出與該商家相關的所有商家名稱、手機號碼、手機號碼編號和品質評分。系統會根據用戶完成內嵌註冊的日期，按遞減方式排列結果，最近註冊的用戶最先列出。

{
  "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"
    }
  ]
}

要求範例

curl -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}]&sort=['last_onboarded_time_ascending']"

成功的話，系統會傳回一個 JSON 物件，其中列出與該商家相關的所有商家名稱、手機號碼、手機號碼編號和品質評分。系統會根據用戶完成內嵌註冊的時間，按遞增方式排列結果，最近註冊的用戶最後列出。

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

篩選手機號碼

您可以查詢手機號碼，並根據 account_mode 對其進行篩選。目前此篩選選項正在測試版模式中測試，尚未對所有開發人員開放。

參數

要求範例

curl -i -X GET "https://graph.facebook.com/v19.0/{whatsapp-business-account-ID}/phone_numbers?filtering=[{"field":"account_mode","operator":"EQUAL","value":"SANDBOX"}]&access_token=access-token"

回應範例

{
  "data": [
    {
      "id": "1972385232742141",    
      "display_phone_number": "+1 631-555-1111",
      "verified_name": "John’s Cake Shop",
      "quality_rating": "UNKNOWN",
    }
  ],
  "paging": {
	"cursors": {
		"before": "abcdefghij",
		"after": "klmnopqr"
	}
   }
}

取得單一手機號碼

如要取得與單一手機號碼相關的資訊，請向 WhatsApp Business 手機號碼端點傳送 GET 要求：

要求語法

GET https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>

要求範例

curl \
'https://graph.facebook.com/v15.0/105954558954427/' \
-H 'Authorization: Bearer EAAFl...'

成功的話，系統會傳回一個 JSON 物件，其中列出與所查詢手機號碼相關的商家名稱、手機號碼、手機號碼編號和品質評級。

{
  "code_verification_status" : "VERIFIED",
  "display_phone_number" : "15555555555",
  "id" : "105954558954427",
  "quality_rating" : "GREEN",
  "verified_name" : "Support Number"
}

取得顯示名稱狀態（測試版）

將 fields=name_status 作為查詢字串參數，以取得與特定手機號碼相關的顯示名稱狀態。此欄位目前仍在測試中，尚未向所有開發人員開發。

要求範例

curl \
'https://graph.facebook.com/v15.0/105954558954427?fields=name_status' \
-H 'Authorization: Bearer EAAFl...'

回應範例

{
  "id" : "105954558954427",
  "name_status" : "AVAILABLE_WITHOUT_REVIEW"
}

name_status 值可以是以下其中一項：

• APPROVED：名稱已獲批准，您現在可以下載憑證。
• AVAILABLE_WITHOUT_REVIEW：手機憑證已準備就緒，顯示名稱無需審查即可使用。
• DECLINED：名稱未獲批准，您無法下載憑證。
• EXPIRED：您的證書已過期，不可再下載。
• PENDING_REVIEW：您的名稱要求正在接受審查，您無法下載憑證。
• NONE：沒有可用的憑證。

請注意，憑證的有效期為 7 天。

了解詳情

如需查詢每個欄位所有可用值的清單，請參閱有關手機號碼欄位的 Graph API 參考資料。