检索电话号码

使用 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/v21.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/v21.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/v21.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"
}

获取显示名状态（Beta 测试版）

加入 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 天。

详细了解

如需各字段所有可用值的列表，请参阅图谱 API 参考文档的“电话号码”字段。