Facebook · Schema

WhatsAppPhoneNumber

A WhatsApp Business phone number.

Fortune 500AdvertisingContent PublishingMessagingSocial MediaSocial Networking

Properties

Name Type Description
id string Phone number ID.
display_phone_number string Display phone number.
verified_name string Verified business name.
quality_rating string Quality rating.
status string Phone number status.
View JSON Schema on GitHub

JSON Schema

whatsapp-api-whatsapp-phone-number-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/facebook/refs/heads/main/json-schema/whatsapp-api-whatsapp-phone-number-schema.json",
  "title": "WhatsAppPhoneNumber",
  "description": "A WhatsApp Business phone number.",
  "type": "object",
  "properties": {
    "id": { "type": "string", "description": "Phone number ID." },
    "display_phone_number": { "type": "string", "description": "Display phone number." },
    "verified_name": { "type": "string", "description": "Verified business name." },
    "quality_rating": { "type": "string", "description": "Quality rating.", "enum": ["GREEN", "YELLOW", "RED"] },
    "status": { "type": "string", "description": "Phone number status." }
  }
}