> For the complete documentation index, see [llms.txt](https://docs.360dialog.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.360dialog.com/docs/messaging-api/api-reference/health.md).

# Health

Health check and status endpoints

## Get Meta Stack Health Status

> Retrieve health status information for the Meta stack including connectivity and service availability.\
> The \`health\_status\` field is always requested. Additional fields (e.g. \`display\_phone\_number\`) can be requested via the \`fields\` query parameter and are concatenated with \`health\_status\` into a single \`fields\` param.

```json
{"openapi":"3.1.0","info":{"title":"Messaging API","version":"1.56.1"},"tags":[{"name":"Health","description":"Health check and status endpoints"}],"servers":[{"description":"Production server","url":"https://waba-v2.360dialog.io"}],"security":[{"D360-API-KEY":[]}],"components":{"securitySchemes":{"D360-API-KEY":{"description":"API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.","in":"header","name":"D360-API-KEY","type":"apiKey"}},"schemas":{"health_status.GetHealthStatusResponse":{"description":"Response payload containing health status information for messaging and calling. `health_status` is always returned. The remaining fields are only returned when explicitly requested via the `fields` query parameter and mirror the corresponding fields on the Meta Graph WhatsApp Business phone number node.","properties":{"account_mode":{"description":"Account mode of the phone number: LIVE or SANDBOX","type":"string"},"certificate":{"description":"Current certificate of the phone number","type":"string"},"code_verification_status":{"description":"Phone number code verification status: VERIFIED, NOT_VERIFIED, or EXPIRED","type":"string"},"country_code":{"description":"ISO country code of the phone number","type":"string"},"country_dial_code":{"description":"Country dial code of the phone number","type":"string"},"display_phone_number":{"description":"Display phone number","type":"string"},"health_status":{"$ref":"#/components/schemas/health_status.HealthStatus"},"host_platform":{"description":"Platform hosting the phone number","type":"string"},"id":{"description":"Node ID","type":"string"},"is_official_business_account":{"description":"Whether the phone number belongs to an official business account","type":"boolean"},"is_on_biz_app":{"description":"Whether the phone number is on the WhatsApp Business app","type":"boolean"},"is_preverified_number":{"description":"Whether the phone number is a pre-verified number","type":"boolean"},"last_onboarded_time":{"description":"Timestamp when the phone number was last onboarded","type":"string"},"messaging_limit_tier":{"description":"Current messaging limit tier of the phone number","type":"string"},"name_status":{"description":"Status of the display name review","type":"string"},"new_certificate":{"description":"New certificate of the phone number when a name change is pending","type":"string"},"new_display_name":{"description":"New display name pending review","type":"string"},"new_name_status":{"description":"Status of the pending new display name review","type":"string"},"platform_type":{"description":"Platform the phone number is registered on: CLOUD_API, ON_PREMISE, or NOT_APPLICABLE","type":"string"},"quality_rating":{"description":"Quality rating of the phone number: GREEN, YELLOW, or RED","type":"string"},"status":{"description":"Operating status of the phone number (e.g. CONNECTED, PENDING, FLAGGED)","type":"string"},"verified_name":{"description":"Approved verified name of the business","type":"string"}},"type":"object"},"health_status.HealthStatus":{"description":"Health status details","properties":{"can_send_message":{"description":"Overall messaging health status: AVAILABLE, LIMITED, or BLOCKED","type":"string"},"entities":{"description":"Individual entity health statuses","items":{"$ref":"#/components/schemas/health_status.HealthEntity"},"type":"array","uniqueItems":false}},"type":"object"},"health_status.HealthEntity":{"properties":{"additional_info":{"description":"Additional context when status is LIMITED","items":{"type":"string"},"type":"array","uniqueItems":false},"can_receive_call_sip":{"description":"Entity's ability to receive calls over SIP: AVAILABLE or BLOCKED","type":"string"},"can_send_message":{"description":"Entity's messaging health status: AVAILABLE, LIMITED, or BLOCKED","type":"string"},"entity_type":{"description":"Type of entity: PHONE_NUMBER, WABA, BUSINESS, APP, or MESSAGE_TEMPLATE","type":"string"},"errors":{"description":"Errors when status is BLOCKED","items":{"$ref":"#/components/schemas/health_status.HealthError"},"type":"array","uniqueItems":false},"id":{"description":"Entity ID","type":"string"}},"type":"object"},"health_status.HealthError":{"properties":{"error_code":{"description":"Error code","type":"integer"},"error_description":{"description":"Error description","type":"string"},"possible_solution":{"description":"Suggested solution","type":"string"}},"type":"object"},"utils.ErrorResp":{"properties":{"error":{"type":"string"}},"type":"object"}}},"paths":{"/health_status":{"get":{"description":"Retrieve health status information for the Meta stack including connectivity and service availability.\nThe `health_status` field is always requested. Additional fields (e.g. `display_phone_number`) can be requested via the `fields` query parameter and are concatenated with `health_status` into a single `fields` param.","operationId":"get-health-status","parameters":[{"description":"Comma-separated list of additional fields to return alongside health_status (e.g. display_phone_number)","in":"query","name":"fields","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/health_status.GetHealthStatusResponse"}}},"description":"Health status retrieved successfully"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Unauthorized"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/utils.ErrorResp"}}},"description":"Internal server error"}},"summary":"Get Meta Stack Health Status","tags":["Health"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.360dialog.com/docs/messaging-api/api-reference/health.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
