訊息傳送健康狀態

本文件說明如何使用給定的 API 資源來判斷是否可以成功傳送訊息。

以下節點具有 health_status 欄位：

• WhatsApp Business 帳號
• WhatsApp Business 電話號碼
• WhatsApp 訊息範本

如果您在上述任一節點中要求 health_status 欄位，API 將傳回訊息傳送要求中涉及之所有節點的訊息傳送健康狀態摘要（如果使用鎖定節點）。此摘要指示您是否能夠使用 API 成功傳送訊息、您是否因一或多個節點中的某些限制而使成功傳送受限，或者系統是否將完全阻止您傳送訊息。

要求語法

GET /<NODE_ID>?fields=health_status

回應

{
  "health_status": {
    "can_send_message": "<OVERALL_MESSAGING_STATUS>",
    "entities": [
    
      /* Only included if targeting a business phone number */
      {
        "entity_type": "PHONE_NUMBER",
        "id": "<BUSINESS_PHONE_NUMBER_ID>",
        "can_send_message": "<BUSINESS_PHONE_NUMBER_MESSAGING_STATUS>"
      },
      
      /* Only included if targeting a template */
      {
        "entity_type": "MESSAGE_TEMPLATE",
        "id": "<TEMPLATE_ID>",
        "can_send_message": "<TEMPLATE_MESSAGING_STATUS>"
      },
      
      /* WABA, business, and app always included */
      {
        "entity_type": "WABA",
        "id": "<WABA_ID>",
        "can_send_message": "<WABA_MESSAGING_STATUS>"
      },
      {
        "entity_type": "BUSINESS",
        "id": "<BUSINESS_PORTFOLIO_ID>",
        "can_send_message": "<BUSINESS_PORTFOLIO_MESSAGING_STATUS>"
      },
      {
        "entity_type": "APP",
        "id": "<APP_ID>",
        "can_send_message": "<APP_MESSAGING_STATUS>"
      }
    ]
  },
  "id": "<NODE_ID>"
}

回應內容

訊息傳送健康狀態

當您嘗試傳送訊息時，會涉及多個節點，包括應用程式、擁有或已認領該訊息的商家資產管理組合、WABA、商家電話號碼以及範本（如果傳送範本訊息）。

這些節點中每一個都可以將以下任一健康狀態指派給 can_send_message 屬性：

• AVAILABLE：表示節點符合所有訊息傳送必備條件。
• LIMITED：表示節點符合訊息傳送必備條件，但存在一些限制。如果給定的節點具有此值，將包含 additional info。
• BLOCKED：表示節點不符合一或多個訊息傳送必備條件。如果給定的節點具有此值，將包含 errors 屬性，該屬性描述錯誤和可能的解決方案。

整體狀態

整體健康狀態屬性（health_status.can_send_message）將依下列方式設定：

• 如果一或多個節點遭到封鎖，則設為 BLOCKED。
• 如果沒有節點遭到封鎖，但有一或多個節點受到限制，則設為 LIMITED。
• 如果所有節點都可使用，則設為 AVAILABLE。

要求範例

curl 'https://graph.facebook.com/v21.0/106540352242922?fields=health_status' \
-H 'Authorization: Bearer EAAJB'

回應範例

{
  "health_status": {
    "can_send_message": "AVAILABLE",
    "entities": [
      {
        "entity_type": "PHONE_NUMBER",
        "id": "106540352242922",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "106540352242922"
}

Additional Info 屬性

如果給定節點的 can_send_message 屬性設為 LIMITED，將包含 additional_info 屬性，該屬性為限制提供額外的內容。

限制的回應範例

此回應範例是針對可用於傳送訊息之商家電話號碼的要求，其顯示名稱尚未獲得核准，因此可傳送的號碼受到限制。

{
  "health_status": {
    "can_send_message": "LIMITED",
    "entities": [
      {
        "entity_type": "PHONE_NUMBER",
        "id": "106540352242922",
        "can_send_message": "LIMITED",
        "additional_info": [
          "Your display name has not been approved yet. Your message limit will increase after the display name is approved."
        ]
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "105154286024403"
}

Errors 屬性

如果給定節點的 can_send_message 屬性設為 BLOCKED，將包含 errors 屬性，該屬性描述狀態的原因和可能的解決方案。

封鎖的回應範例

此回應範例是針對無法在範本訊息中傳送的範本要求，因其仍為處理中狀態。

{
  "health_status": {
    "can_send_message": "BLOCKED",
    "entities": [
      {
        "entity_type": "MESSAGE_TEMPLATE",
        "id": "2632273056924580",
        "can_send_message": "BLOCKED",
        "errors": [
          {
            "error_code": 141002,
            "error_description": "Message templates can only be sent out if they are approved.",
            "possible_solution": "Edit or appeal the message template review decision."
          }
        ]
      },
      {
        "entity_type": "WABA",
        "id": "102290129340398",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "BUSINESS",
        "id": "506914307656634",
        "can_send_message": "AVAILABLE"
      },
      {
        "entity_type": "APP",
        "id": "634974688087057",
        "can_send_message": "AVAILABLE"
      }
    ]
  },
  "id": "2632273056924580"
}