Referência da APINumbers

Obter um número do WhatsApp

Retorna um único número do WhatsApp pelo seu ID interno.

Authentication

AuthorizationBearer

API Key in the format mk_live_<43-chars>. Obtain from the Dashboard or POST /auth/api-keys.

Path parameters

idstringRequired
Unique identifier of the WhatsApp number

Response

Default Response
idstring
Unique identifier of the WhatsApp number
wabaIdstring or null
WhatsApp Business Account ID from Meta
phoneNumberIdstring or null
Phone number ID registered with the WhatsApp Business API
displayNumberstring
Phone number in international display format
qualityRatingstring or null

Meta quality rating for the phone number (e.g., GREEN, YELLOW, RED)

verifiedNamestring or null
Business name verified by Meta for this phone number
nameStatusstring or null
Approval status of the verified business name
messagingLimitTierstring or null

Current messaging limit tier (e.g., TIER_1K, TIER_10K, TIER_100K, UNLIMITED)

accountModestring or null

WhatsApp Business Account mode (e.g., LIVE, SANDBOX)

isOfficialBusinessAccountboolean or null

Whether the number has Official Business Account (green badge) status

codeVerificationStatusstring or null
Status of the phone number verification code
statusstring

Connection status of the number (PENDING, ACTIVE, FAILED, DISCONNECTED, SUSPENDED)

tokenExpiresAtstring or null
ISO 8601 timestamp when the Meta access token expires
createdAtstring
ISO 8601 timestamp when the number was connected
updatedAtstring
ISO 8601 timestamp when the number was last updated

Errors

401
Unauthorized Error
404
Not Found Error