Retrieve WhatsApp Business Phone Number Information
Retrieve comprehensive information about a WhatsApp Business phone number using its unique ID (CSID). This endpoint provides phone number status, verification details, quality metrics, and configuration information.
Core Information Returned:
- Phone number ID and display format
- Verification status and verified business name
- Quality rating based on message delivery performance
- Code verification status for two-step verification
- Display name certification status (when requested)
Quality Rating System: The quality rating reflects how recipients have been receiving messages from this phone number:
- GREEN: High quality - messages are being delivered and engaged with well
- YELLOW: Medium quality - some delivery or engagement issues detected
- RED: Low quality - significant delivery or engagement problems
- NA: Quality rating not yet determined (new phone numbers)
Display Name Status: When requesting the name_status field, you'll receive the current verification status:
- APPROVED: Business display name has been verified and is ready to use
- AVAILABLE_WITHOUT_REVIEW: Display name is ready to use without additional review
- DECLINED: Business display name verification was rejected
- EXPIRED: Display name approval has expired
- PENDING_REVIEW: Display name verification request is under review
- NONE: No display name verification request exists
Code Verification Status: Indicates the two-step verification status:
- VERIFIED: Phone number has completed two-step verification
- UNVERIFIED: Two-step verification is pending or incomplete
Use Cases:
- Monitor phone number quality and delivery performance
- Check verification and display name status
- Validate phone number configuration before sending messages
- Retrieve display information for business profiles
- Audit phone number compliance and status
For more information on quality ratings, see WhatsApp Business Account Message Quality Rating.
Request
- Base URLhttps://graph.facebook.com
- URLhttps://graph.facebook.com/{Version}/{Phone-Number-ID}
- AuthHTTP bearer
Path parameters
Graph API version to use for this request. Determines the API behavior and available features. Use the latest stable version for optimal performance and feature support.
Your WhatsApp Business Account phone number ID (CSID). This unique identifier is assigned when you register the phone number with WhatsApp Business API and can be found in your WhatsApp Business Manager.
Query parameters
Comma-separated list of additional fields to include in the response. If not specified, only default fields (id, display_phone_number, verified_name, quality_rating) are returned.
Available Fields:
- name_status: Display name verification status
- code_verification_status: Two-step verification status for the phone number
Field Values:
name_status values:
- APPROVED: Display name approved and ready to use
- AVAILABLE_WITHOUT_REVIEW: Display name ready without additional review
- DECLINED: Display name verification rejected
- EXPIRED: Display name approval has expired
- PENDING_REVIEW: Display name verification under review
- NONE: No display name verification request exists
code_verification_status values:
- VERIFIED: Phone number has completed two-step verification
- UNVERIFIED: Two-step verification pending or incomplete
Headers
The user agent string identifying the client software making the request.
Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.
Response
Successfully retrieved phone number information. The response includes core phone number details and any additional fields requested via the fields parameter.
Example response
{
"id": "1906385232743451",
"display_phone_number": "+1 631-555-5555",
"verified_name": "Jasper's Market",
"quality_rating": "GREEN",
"code_verification_status": "VERIFIED",
"name_status": "AVAILABLE_WITHOUT_REVIEW"
}Changes
No recorded changes to this operation across all 5 revisions of this API.