WhatsApp Node Health Status API Reference - Chat App Message Service

Queries the messaging health status of different types of nodes.

Operation description

QPS limit

This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

This operation retrieves data directly from Meta. Meta imposes its own rate limits on the total number of calls. Stay within the specified limit.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
NodeType	string	Yes	The node type. Valid values: template: message template phone: phone number waba: WhatsApp Business Account (WABA) Valid values: template : template phone : phone waba : waba	waba
PhoneNumber	string	No	The phone number of the enterprise.	86138***
TemplateCode	string	No	The template code.	399299***
Language	string	No	The template language.	en
WabaId	string	No	WabaId	299399****
CustSpaceId	string	Yes	The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud.	2993****

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Data	object	The returned data.
CanSendMessage	string	Indicates whether the messages can be sent.	AVAILABLE
Entities	array<object>	The queried entities.
	array<object>	The queried entity.
EntityType	string	The entity type.	PHONE_NUMBER
TemplateCode	string	The template code. This parameter is returned when the NodeType parameter is set to template.	939928****
Errors	array<object>	The reasons why the messages failed to be sent.
	object	The reason why the messages failed to be sent.
ErrorDescription	string	The description of the error.	There is an error with the payment method.
PossibleSolution	string	The possible solution to the error.	There was an error with your payment method. Please add a new payment method to the account.
ErrorCode	string	The error code.	141006
Language	string	The template language.	en
CanSendMessage	string	Indicates whether the messages can be sent.	AVAILABLE
PhoneNumber	string	The phone number to which the messages are sent.	86138****
WabaId	string	The WABA ID. You can view the WABA ID in the Chat App Message Service console after you create the WABA.	39939***
BusinessId	string	The Business Manager ID.	3992****
Code	string	The response code. The value OK indicates that the request was successful. For more information about other response codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575",
  "Data": {
    "CanSendMessage": "AVAILABLE",
    "Entities": [
      {
        "EntityType": "PHONE_NUMBER",
        "TemplateCode": "939928****",
        "Errors": [
          {
            "ErrorDescription": "There is an error with the payment method.",
            "PossibleSolution": "There was an error with your payment method. Please add a new payment method to the account.",
            "ErrorCode": "141006"
          }
        ],
        "Language": "en",
        "CanSendMessage": "AVAILABLE",
        "PhoneNumber": "86138****",
        "WabaId": "39939***",
        "BusinessId": "3992****"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.