Skip to main content
GET
/
whatsapp
/
phone_numbers
/
{phone_number_id}
/
health
Check phone health
curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/phone_numbers/{phone_number_id}/health \
  --header 'X-API-Key: <api-key>'
{
  "status": "healthy",
  "timestamp": "2025-01-20T14:25:30Z",
  "checks": {
    "phone_number_access": {
      "passed": true,
      "details": {
        "verified_name": "My Business",
        "display_phone_number": "+1 555-123-4567",
        "quality_rating": "GREEN",
        "status": "CONNECTED",
        "throughput_tier": "TIER_10K",
        "id": "123456789012345"
      }
    },
    "messaging_health": {
      "passed": true,
      "overall_status": "AVAILABLE",
      "details": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "123456789012345",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "WABA",
            "id": "987654321098765",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "BUSINESS",
            "id": "456789012345678",
            "can_send_message": "AVAILABLE"
          },
          {
            "entity_type": "APP",
            "id": "789012345678901",
            "can_send_message": "AVAILABLE"
          }
        ]
      }
    },
    "webhook_subscription": {
      "passed": true,
      "details": {
        "app_id": "789012345678901",
        "subscribed": true,
        "subscribed_fields": [
          "messages",
          "message_template_status_update"
        ]
      }
    },
    "webhook_verified": {
      "passed": true,
      "details": {
        "verified_at": "2025-01-15T10:30:00Z",
        "message": "Webhook successfully verified at 2025-01-15 10:30:00 UTC"
      }
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
phone_number_id
string
required

Response

Health status

​
status
enum<string>
required
Available options:
healthy,
degraded,
unhealthy,
error
​
timestamp
string<date-time>
required
​
error
string | null
​
checks
object

Individual check results. Typical checks:

  • phone_number_access: Meta API connectivity
  • messaging_health: Send/receive capability (AVAILABLE/LIMITED/BLOCKED)
  • webhook_subscription: WABA app subscription status
  • webhook_verified: Webhook verification status
  • token_validity: Access token validity (coexistence only)