สถานะประสิทธิภาพการส่งข้อความ

เอกสารนี้อธิบายวิธีการพิจารณาว่าคุณสามารถส่งข้อความโดยใช้ทรัพยากร 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: ระบุว่าโหนดเป็นไปตามข้อกำหนดการส่งข้อความทั้งหมด แต่มีข้อจำกัดบางประการ หากโหนดที่กำหนดไว้มีค่านี้ จะมีการระบุข้อมูลเพิ่มเติม
• BLOCKED: ระบุว่าโหนดไม่เป็นไปตามข้อกำหนดการส่งข้อความ หากโหนดที่กำหนดไว้มีค่านี้ จะมีการระบุพร็อพเพอร์ตี้ข้อผิดพลาด ซึ่งอธิบายข้อผิดพลาดและวิธีที่อาจแก้ไขปัญหาได้

สถานะโดยรวม

พร็อพเพอร์ตี้สถานะประสิทธิภาพโดยรวม (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"
}

พร็อพเพอร์ตี้ข้อมูลเพิ่มเติม

หากพร็อพเพอร์ตี้ 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"
}

พร็อพเพอร์ตี้ข้อผิดพลาด

หากพร็อพเพอร์ตี้ 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"
}