Number health: can it send, quality, limit, name status
https://api.app2email.com/v1/{number}/health WhatsApp's health_status and the number's fields (quality, messaging limit, throughput, display name review, account mode). Kept 60 s.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- e.g.
true - e.g.
k3x9a -
15 fields
- can_send_message string
WhatsApp's verdict for the number, its WABA, business and app together.
AVAILABLELIMITEDBLOCKED - entities object[]
Meta's health_status.entities: one per PHONE_NUMBER, WABA, BUSINESS, APP, with errors and how to fix them.
5 item fields
- entity_type string
- id string
- can_send_message string
- errors object[]
- additional_info string[]
- display_phone_number string
- verified_name string
- quality_rating string
GREENYELLOWREDNAUNKNOWN - messaging_limit string
The business portfolio's limit of contacts outside the service window per 24 h, eg TIER_2K, TIER_UNLIMITED.
- throughput string
STANDARD (80 messages/s), HIGH (1,000 messages/s) or NOT_APPLICABLE.
- status string
CONNECTED, DISCONNECTED, PENDING, FLAGGED, RESTRICTED, RATE_LIMITED ...
- name_status string
Review of verified_name: APPROVED, AVAILABLE_WITHOUT_REVIEW, DECLINED, EXPIRED, PENDING_REVIEW, NONE.
- new_display_name string
A requested display name under review (PUT /profile/display-name).
- new_name_status string
- code_verification_status string
VERIFIEDUNVERIFIEDEXPIRED - account_mode string
SANDBOXLIVE - is_official_business_account boolean
- coexistence boolean
true: the number also runs in the WhatsApp Business app (20 messages/s at most).
- fetched_at string (date-time)
When WhatsApp was asked (answers are kept 60 s).
Errors
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.