Promo Center

50% off for new user

Direct Mail-46% off

Learn More

GetWhatsappHealthStatus

Updated at: 2024-11-18 02:13

Queries the messaging health status of different types of nodes.

Operation description

QPS limit

You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

This operation will directly obtain data from Facebook, which sets an upper limit on the total number of calls for operations. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
NodeTypestringYes

The node type.

Valid values:

  • template: message template
  • phone: phone number
  • waba: WhatsApp Business Account (WABA)
waba
PhoneNumberstringNo

The phone number of the enterprise.

86138***
TemplateCodestringNo

The template code.

399299***
LanguagestringNo

The template language.

en
WabaIdstringNo

WabaId

299399****
CustSpaceIdstringYes

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 parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object
AccessDeniedDetailstring

The details about the access denial.

None
Messagestring

The error message.

None
RequestIdstring

The request ID.

DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Dataobject

The returned data.

CanSendMessagestring

Indicates whether the messages can be sent.

AVAILABLE
Entitiesarray<object>

The queried entities.

entitiesobject

The queried entity.

EntityTypestring

The entity type.

PHONE_NUMBER
TemplateCodestring

The template code. This parameter is returned when the NodeType parameter is set to template.

939928****
Errorsarray<object>

The reasons why the messages failed to be sent.

errorsobject

The reason why the messages failed to be sent.

ErrorDescriptionstring

The description of the error.

There is an error with the payment method.
PossibleSolutionstring

The possible solution to the error.

There was an error with your payment method. Please add a new payment method to the account.
ErrorCodestring

The error code.

141006
Languagestring

The template language.

en
CanSendMessagestring

Indicates whether the messages can be sent.

AVAILABLE
PhoneNumberstring

The phone number to which the messages are sent.

86138****
WabaIdstring

The WABA ID. You can view the WABA ID in the Chat App Message Service console after you create the WABA.

39939***
BusinessIdstring

The Business Manager ID.

3992****
Codestring

The response code.

  • The value OK indicates that the request was successful.
  • For more information about other response codes, see Error codes.
OK
Successboolean

Indicates whether the call was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

  • On this page (1)
  • Operation description
  • QPS limit
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
Feedback
phone Contact Us

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare