Phone numbers

Last update: 6 hours ago by Irais Aguirre

Integration summary
Base URL: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: admin token, in the Authorization: Bearer {{admin-token}} header (how to generate it)
Endpoints on this page:
GET /v1/wba/{{waba_id}}/phone_numbers: List WABA phone numbers
GET /v1/wba/{{waba_id}}/phone-numbers-status: Get phone number quality

List your WABA's phone numbers and check each one's quality rating.

List WABA phone numbers

Request

List WABA phone numbers request:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/wba/{{waba_id}}/phone_numbers
Method	GET

Headers

List WABA phone numbers headers:

Name	Description	Type	Requirements
Authorization	Admin token. See Generate authentication token.	String	Required

Parameters

List WABA phone numbers parameters:

Name	Description	Type	Requirements
waba_id	WhatsApp Business Account ID.	String	Required

Example

Complete List WABA phone numbers example:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/wba/{{waba_id}}/phone_numbers' \
--header 'Authorization: Bearer {{admin-token}}'

Response

List WABA phone numbers response:

Name	Description	Type
-	List of the WABA's phone numbers (phone_number_id). These are the values other admin endpoints ask for, such as Block users.	Array

[
    "5215500000001",
    "5215500000002"
]

Get phone number quality

Request

Get phone number quality request:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/wba/{{waba_id}}/phone-numbers-status
Method	GET

Headers

Get phone number quality headers:

Name	Description	Type	Requirements
Authorization	Admin token. See Generate authentication token.	String	Required

Parameters

Get phone number quality parameters:

Name	Description	Type	Requirements
waba_id	WhatsApp Business Account ID.	String	Required

Example

Complete Get phone number quality example:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/wba/{{waba_id}}/phone-numbers-status' \
--header 'Authorization: Bearer {{admin-token}}'

Response

Get phone number quality response:

Name	Description	Type
data	List with the quality of each phone number in the WABA.	Array
wabaId	WABA ID.	String
fbPhoneNumberId	Phone number ID in Meta.	String
displayPhoneNumber	Phone number.	String
qualityRating	Phone number quality rating. Possible values: GREEN YELLOW RED UNKNOWN	String
status	Status of the number in Meta, in line with its quality. For example, CONNECTED.	String
messagingLimitTier	The number's messaging limit tier. For example, TIER_1K.	String
processedAt	Date and time the information was obtained from Meta; the 12-hour period counts from here.	String (ISO 8601 date)

{
    "data": [
        {
            "wabaId": "173276950931742",
            "fbPhoneNumberId": "101422592747549",
            "displayPhoneNumber": "+57 310 6576307",
            "qualityRating": "GREEN",
            "status": "CONNECTED",
            "messagingLimitTier": "TIER_1K",
            "processedAt": "2025-07-25T00:40:20.236Z"
        },
        {
            "wabaId": "173276950931742",
            "fbPhoneNumberId": "105303135793776",
            "displayPhoneNumber": "+52 1 649 118 0000",
            "qualityRating": "GREEN",
            "status": "CONNECTED",
            "messagingLimitTier": "TIER_1K",
            "processedAt": "2025-07-25T00:40:20.235Z"
        }
    ]
}

WhatsApp — Previous

Quality monitoring

Templates