電話番号を取得する

WhatsApp Business管理APIを使って、ビジネスがWhatsApp Businessアカウントに登録している電話番号を取得します。

開始する前に

以下が必要です。

• 取得対象のビジネスの電話番号に対応するWhatsApp BusinessアカウントID
• 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}"

成功すると、ビジネスの名前、電話番号、電話番号のID、ビジネスに関連する品質評価がすべてリストされている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']"

成功すると、ビジネスの名前、電話番号、電話番号のID、ビジネスに関連する品質評価がすべてリストされている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...'

成功すると、ビジネスの名前、電話番号、電話番号のID、クエリ対象の電話番号の品質評価を含む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日間です。

詳細

各フィールドに指定できるすべての値のリストについては、[電話番号]フィールドのグラフAPIのリファレンスをご覧ください。