حالة أداء المراسلة

يصف هذا المستند كيف تحدد ما إذا كان بإمكانك إرسال الرسائل بنجاح باستخدام مورد API محدد.

يتوفر الحقل health_status في العقد التالية:

• حساب واتساب للأعمال
• رقم هاتف حساب واتساب للأعمال
• قالب رسائل واتساب

إذا طلبت الحقل 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>"
}

محتوى الاستجابة

حالة أداء المراسلة

عند محاولة إرسال رسالة، يتم تضمين عُقد متعددة، بما في ذلك التطبيق وحافظة الأعمال التي تملكها أو تطالب بها وحساب واتساب للأعمال ورقم هاتف النشاط التجاري والقالب (إذا تم إرسال رسالة قالب).

يمكن أن تحتوي كل من هذه العقد على إحدى حالات الأداء التالية للخاصية 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"
}