Sign in
WhatsAppAccounts

Get phone number detail

get/api/v2/whatsapp/{wabaId}/{phoneNumber}/profile

Path parameters

wabaIdstring required

WhatsApp Business Account ID

phoneNumberstring required

Phone number with country code

Response

Get phone number detail success

phoneIdstring

Unique identifier of the WhatsApp phone number in the provider system.

accountModestring

Mode of the account, e.g. LIVE or SANDBOX.

codeVerificationStatusstring

Verification status of the phone number (e.g. VERIFIED, EXPIRED).

displayPhoneNumberstring

Human-readable phone number displayed in WhatsApp.

messagingLimitTierstring

Messaging limit tier for the phone number (e.g. TIER_1K).

nameStatusstring

Status of the display name approval (e.g. APPROVED).

newNameStatusstring

New name status if there is a pending name change, otherwise 'NONE'.

qualityScorestring

Quality score of the phone number (e.g. GREEN, YELLOW, RED).

searchVisibilitystring

Search visibility of the phone number (e.g. VISIBLE, NON_VISIBLE).

statusstring

Connection status of the phone number (e.g. CONNECTED, DISCONNECTED).

verifiedNamestring

Verified business name associated with this phone number.

wabaIdstring

WhatsApp Business Account ID that owns this phone number.

accountReviewStatusstring

Review status of the WhatsApp Business Account (e.g. APPROVED).

businessVerificationStatusstring

Business verification status (e.g. verified, unverified).

wabaUpdatestring

Indicates whether WABA update features are enabled or disabled (e.g. DISABLED_UPDATE).

qualityRatingstring

Overall quality rating: GREEN = high quality, YELLOW = medium quality, RED = low quality, UNKNOWN = unknown quality.

Changes

No recorded changes to this endpoint across all 1 revision of this API.