Get Waba Info

Use this API to retrieve comprehensive WhatsApp Business Account (WABA) information and health status for your application. This endpoint provides critical details about account status, messaging capabilities, phone number quality, ownership, and any errors or limitations.

Important Requirements:

  • Valid app ID required
  • App must be WhatsApp Business API enabled
  • Rate limit: 10 requests per 60 seconds
  • PARTNER_APP role mandatory

Common Use Cases:

  • Monitor WABA account health and status
  • Check messaging availability before sending
  • Verify phone number and quality status
  • Diagnose account issues and errors
  • Validate account configuration
  • Track ownership and account type

Note: This endpoint provides real-time status information directly from WhatsApp Business API, including any active restrictions or limitations on the account.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

API Request

curl --location --request GET '{{partner_portal_base_url}}/partner/app/:appId/waba/info' \
--header 'token: {{PARTNER_APP_TOKEN}}' \

API Response

Status CodeResponseComments
Success
200
{
    "status": "success",
    "wabaInfo": {
        "accountStatus": "ACTIVE | BANNED",
        "dockerStatus": "CONNECTED | DISCONNECTED | FLAGGED | PENDING | RESTRICTED | UNKNOWN",
        "messagingLimit": "TIER_50 | TIER_250 | TIER_2K | TIER_10K | TIER_100K | TIER_NOT_SET | TIER_UNLIMITED",
        "mmLiteStatus" : "INELIGIBLE | ELIGIBLE | ONBOARDED"
        "ownershipType":"CLIENT_OWNED | ON_BEHALF_OF | SELF"
        "phone": "{phone}",
        "phoneQuality": "GREEN | YELLOW | RED | UNKNOWN",
        "throughput": "HIGH | STANDARD | NOT_APPLICABLE",
        "verifiedName":"{display name}",
        "wabaId": "{waba_id}" ,
        "canSendMessage" : "AVAILABLE | LIMITED | BLOCKED" ,
        "errors": [
            {
                "error_code": "141014",
                "error_description": "<error description>",
                "possible_solution": "<posible solution>"
            }
        ],
        "additionalInfo": [
            "Your display name has not been approved yet. Your message limit will increase after the display name is approved."
        ]
    }
}
Error
400
{
    "message": "App is not live.",
    "status": "error"
}
If app is not live
400
{
    "message": "Waba id not found for the given App",
    "status": "error"
}
If waba id is not present in DB
400
{
    "message": "WABA id is invalid or given phone is not associated with WABA",
    "status": "error"
}
If waba id present in DB is not correct
400
{
    "message": "Error while getting waba info for given app",
    "status": "error"
}
401
{
    "message": "Authentication Failed",
    "status": "error"
}
429
{
  "status": "error",
  "message": "Too Many Requests"
}
10 Requests per Minute
500
{
  "status": "error",
  "message": "Internal Server Error"
}
For any Internal Error

Request Params

KeyDescriptionConstraints
Headers
PARTNER_APP_TOKENApp Access Token issues post Partner loginShould be a valid Partner app access token belonging to the passed appId
Path Params
APP_IDappId of the appApp Id for the app that is linked to the Partner Account

Response Params


KeyDescription
accountStatusWaba account status - ACTIVE | BANNED
dockerStatusWaba docker status - CONNECTED | DISCONNECTED | FLAGGED | PENDING | RESTRICTED | UNKNOWN
messagingLimit

messaging tier - TIER_50 | TIER_250 | TIER_2K | TIER_10K | TIER_100K | TIER_NOT_SET | TIER_UNLIMITED

This is BM level messaging limit

mmLiteStatusINELIGIBLE| ELIGIBLE| ONBOARD|INELIGIBLE_ON_BEHALF_OF_WABA | INELIGIBLE_INACTIVE_OR_RESTRICTED |INELIGIBLE_COUNTRY_NOT_SUPPORTED |INELIGIBLE_COUNTRY_NOT_SUPPORTED| PENDING_VALID_PAYMENT_METHOD |PENDING_INTERNAL_SETUP"
phonePhone number
phoneQualityPhone number quality - GREEN | YELLOW | RED | UNKNOWN
verifiedNameDisplay name for the WABA
wabaIdWaba Id
canSendMessageMessage sending is allowed or not - AVAILABLE | LIMITED | BLOCKED
errors
{

                "error_code": Meta Error Code,

                "error_description": Meta Error Description,

                "possible_solution": Suggestions on how to solve the error 

}
additionalInfoAdditional information associated with the waba
Path Params
string
required

The unique identifier of the partner application. Should be a valid appId.

Headers
string
required

Your app token, please refer Get access token api to get the token from partner documentation.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json