This API provides an overview of WABA health.
Request Parameters
Key | Description | Value | Constraints |
---|---|---|---|
PARTNER_APP_TOKEN | App Access Token issues post Partner login | {{PARTNER_APP_TOKEN}} | Should be a valid Partner app access token belonging to the passed appId |
appId | App Id for the app that is linked to the Partner Account | {{APP_ID}} |
Sample Request
curl --location --request GET '{{partner_portal_base_url}}/partner/app/:appId/waba/info' \
--header 'token: {{PARTNER_APP_TOKEN}}' \
Sample Response
{
"status": "success",
"wabaInfo":
{
"accountStatus":"ACTIVE | BANNED",
"dockerStatus":"CONNECTED | DISCONNECTED |FLAGGED | PENDING | RESTRICTED| UNKNOWN",
"messagingLimit":"TIER_50 | TIER_250 | TIER_1K |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": "<posiblesolution>"
}
],
"additionalInfo":
[
"Your display name has not been approved yet. Your message limit will increase after the display name is approved."
]
}
}
Status Codes
Status Code | Response | Comments |
---|---|---|
Success | ||
200 | { "wabaInfo":{"accountStatus": "ACTIVE","dockerStatus": "CONNECTED","messagingLimit": "TIER_1K","mmLiteStatus" :"ELIGIBLE","ownershipType":"CLIENT_OWNED","phone": "917835039205","phoneQuality": "GREEN", "wabaId": "116676371511027", "canSendMessage": "LIMITED", "additionalInfo": [ "Your display name has not been approved yet. Your message limit will increase after the display name is approved." ] }, "status": "success" } | if canSendMessage is LIMITED |
200 | { "wabaInfo":{ | if canSendMessage is AVAILABLE |
200 | { "wabaInfo":{ | if canSendMessage is BLOCKED |
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 |