Use the phone number management API operations to retrieve your registered sending phone numbers with their statuses and quality ratings, and to query your bound WhatsApp Business Account (WABA) details.
Operations
Query all sending phone numbers and their statuses - QueryChatappPhoneNumbers
Returns the full list of phone numbers registered under your account, along with their current status, quality rating, and messaging capacity tier.
Each phone number in the response includes:
PhoneNumber — the registered number
VerifiedName — the business display name approved by Meta
Status — current operational state (
CONNECTED,FLAGGED,RATE_LIMITED,PENDING,OFFLINE,PAUSED,DELETED)QualityRating — message quality score based on recent user feedback:
GREEN(high),YELLOW(medium),RED(low). Numbers with aREDrating for an extended period may be downgraded or disabled.MessagingLimitTier — the 24-hour conversation capacity:
TIER_10(1K),TIER_50(10K),TIER_1000(100K),UNLIMITED. Tier upgrades happen automatically as your quality rating and volume meet Meta's thresholds.CodeVerificationStatus — whether the number has completed two-step verification:
VERIFIEDorNOT_VERIFIEDNameStatus / NewNameStatus — review status of the verified name or a pending name change:
Approval(approved),Pending_Review,RejectedStatusCallbackUrl — endpoint that receives delivery status notifications
UpCallbackUrl — endpoint that receives inbound (mobile originated) messages
StatusQueue / UpQueue — internal Alibaba Cloud MQ queues backing each callback
API documentation
Query all sending phone numbers and their statuses
Example
Sample success response (JSON format):
{
"RequestId": "90E63D28-E31D-1EB2-8939-A948664****",
"Code": "OK",
"Message": "SUCCESS",
"PhoneNumbers": [
{
"UpQueue": "Alicom-Queue-****-ChatAppInbound",
"PhoneNumber": "8613800000",
"StatusQueue": "Alicom-Queue-****-ChatAppStatus",
"VerifiedName": "Alibaba",
"StatusCallbackUrl": "https://ali.com/status",
"UpCallbackUrl": "https://ali.com/inbound",
"QualityRating": "GREEN",
"Status": "CONNECTED",
"CodeVerificationStatus": "VERIFIED",
"NameStatus": "Approval",
"MessagingLimitTier": "TIER_10",
"NewNameStatus": "Approval"
}
]
}
Query the bound WABA - QueryChatappBindWaba
Returns metadata for the WhatsApp Business Account (WABA) bound to your Alibaba Cloud Chatapp instance.
The response includes:
Id — the WABA ID assigned by Meta
Name — the registered business name
Currency — the billing currency for conversation charges (for example,
USD)AccountReviewStatus — Meta's review decision for the WABA:
APPROVED,PENDING, orREJECTED. OnlyAPPROVEDWABAs can send messages.MessageTemplateNamespace — the namespace used to reference approved message templates in API requests
API documentation
Example
Sample success response (JSON format):
{
"RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
"Code": "OK",
"Message": "SUCCESS",
"Data": {
"Name": "Alibaba",
"Currency": "USD",
"Id": "20393988393993***",
"MessageTemplateNamespace": "90E63D28-E31D-1EB2-8939-A9486641****",
"AccountReviewStatus": "APPROVED"
}
}