调用GetWhatsappHealthStatus API获取Whatsapp消息发送健康状态-Chat App 消息服务-阿里云

获取不同类型的节点发送消息的健康状态。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

此接口会直接拉取 facebook 的数据，facebook 接口调用总量有限制，请合理使用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
NodeType	string	是	节点类型。枚举值： template：模板。 phone：电话号码。 waba：waba账号ID。	waba
PhoneNumber	string	否	商家号码。	86138***
TemplateCode	string	否	模板编码。	399299***
Language	string	否	模板语言。	en
WabaId	string	否	WabaId。	299399****
CustSpaceId	string	是	ISV 子客户的 SpaceId/直客客户实例 ID。	2993****

返回参数

名称	类型	描述	示例值
	object	返回数据。
AccessDeniedDetail	string	访问被拒绝详细信息。	无
Message	string	错误描述信息。	无
RequestId	string	请求 ID。	DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Data	object	返回数据。
CanSendMessage	string	是否能发送消息。	AVAILABLE
Entities	array<object>	查询到的实体数据。
entities	object	查询到的实体数据。
EntityType	string	实体类型。	PHONE_NUMBER
TemplateCode	string	模板 Code。NodeType 为 template 时此字段必填。	939928****
Errors	array<object>	错误列表。
errors	object	错误信息。
ErrorDescription	string	错误描述。	There is an error with the payment method.
PossibleSolution	string	可能的解决方案。	There was an error with your payment method. Please add a new payment method to the account.
ErrorCode	string	错误码。	141006
Language	string	模板语言。	en
CanSendMessage	string	是否能发送消息。	AVAILABLE
PhoneNumber	string	发送号码。	86138****
WabaId	string	WABA 账号 ID。可在Chat App 消息服务控制台WABA 注册完成后查看 WabaId。	39939***
BusinessId	string	Business 平台 Id。	3992****
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Success	boolean	是否调用成功。 true：调用成功。 false：调用失败。	true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "Message": "无",
  "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
}

错误码

访问错误中心查看更多错误码。