全部產品
Search
文件中心

Chat App Message Service:GetWhatsappHealthStatus - 擷取Whatsapp訊息發送健康狀態

更新時間:Dec 22, 2025

擷取不同類型的節點發送訊息的健康狀態。

介面說明

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>

查詢到的實體資料。

array<object>

查詢到的實體資料。

EntityType

string

實體類型。

PHONE_NUMBER

TemplateCode

string

模板 Code。NodeType 為 template 時此欄位必填。

939928****

Errors

array<object>

錯誤清單。

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 Message Service控制台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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情