Messaging Health Status
The Health Messaging Status feature allows you to monitor the status of the WhatsApp Business Account (WABA) and phone number within the Cloud API messaging system.
By making a request to the /health_status endpoint, you can receive the operational condition of the messaging service.
API Reference
The health_status endpoint returns the status of both the phone number and WABA account in the same response.
Please use this endpoint
Messaging Health Status Details
When you attempt to send a message, it involves several parts (nodes or entities), such as a WhatsApp Business Account (WABA), a business phone number, and sometimes a message template. Each node has a "health status" assigned to the can_send_message property to show if it can send messages:
AVAILABLE: Indicates that the node meets all messaging requirements.LIMITED: Indicates that the node meets messaging requirements, but has some limitations. If a given node has this value, additional info will be included.BLOCKED: Indicates that the node does not meet one or more messaging requirements. If a given node has this value, the errors property will be included which describes the error and a possible solution.
Overall Status
The overall health status property can_send_message will be set as follows:
If one or more nodes is blocked, it will be set to
BLOCKED.If no nodes are blocked, but one or more nodes is limited, it will be set to
LIMITED.If all nodes are available, it will be set to
AVAILABLE.
Additional Info Property
If a given node's can_send_message property is set to LIMITED, the additional_info property will be included, which provides additional context for the limitation.
Errors Property
If a given node's can_send_message property is set to BLOCKED, the errors property will be included, which describes the reason for the status and a possible solution.
Last updated
Was this helpful?