‏API داخل المواقع الخاصة بمنصة واتساب للأعمال‏

Health

/v1/health

استخدم العقدة health للتحقق من حالة عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال.

قبل البدء

تدعم العقدة healthرمز Bearer ومصادقة مفاتيح API.

مفاتيح API

If you wish to monitor the health, metrics, and stats nodes from an orchestrator, Bearer tokens are not the best option for ongoing checks as they expire every 7 days. To mediate this, you can use an API key, which can be set using the WA_API_KEY environment variable in the waweb environment section in the .yml file of your installation setup. 
services:
...
  waweb:
  ...
    environment:
    ...
    WA_API_KEY: your-api-key-token
The API key you set must have a minimum of 12 characters and a maximum of 128 characters. The Webapp must be restarted whenever you change the API key.

القيود

يجب أن يكون مفتاح واجهة API الذي يتم تعيينه مكونًا من 12 حرفًا بحد أدنى و128 حرفًا بحد أقصى.

الاسترداد

يمكنك إجراء استدعاء GET إلى هذه العقدة لاسترداد حالة عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال.

المثال

الطلب:

GET /v1/health
{
  Authorization: Bearer your-auth-token | Apikey your-api-key-token
}

توفر الاستجابة حالة سلامة أداء البوابة لخادم واتساب. إذا لم يكن العنوان Authorization موجودًا أو كان غير صالح، فسيتم إرجاع رمز الخطأ 401.

المثيل المنفرد

{
    "health": {
       "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered"
    }
}

التوفّر العالي/الاتصال المتعدد

{
    "health": {
      "your-hostname1:your-container-id1": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
      "your-hostname2:your-container-id2": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
    }
}

في وضع التوفّر العالي، لن يتم ربط سوى عقدة Coreapp واحدة فقط بخادم واتساب، وستتوفر لدى جميع العُقد الأخرى بما في ذلك عقدة Master الرئيسية الحالة disconnected لـ gateway_status. وفي وضع الاتصال المتعدد ذي X من الأقسام، سيتم ربط X من عُقد Coreapp بخادم واتساب، كما سيتم ربط عقدة Master الرئيسية بخادم واتساب.

المعلمات

الاسمالوصف

health

النوع: Object (كائن)

يحتوي على الحقول التي توضح سلامة أداء عميل واجهة API الخاصة بتطبيق WhatsApp للأعمال.

gateway_status

النوع: String (سلسلة)

تمثل حالة الاتصال بين خوادم Coreapp وWhatsApp.


القيم المدعومة:

  • connected، connecting — مستوى سلامة الأداء جيد.
  • uninitialized — قد يكون التطبيق قيد ترقية مخطط قاعدة البيانات أو تهيئته. حاول مرة أخرى خلال بضع دقائق واتصل بدعم واتساب إذا كنت لا تزال ترى هذه الحالة.
  • unregistered — تحتاج إلى تسجيل عميل API الخاصة بواتساب للأعمال. لمزيد من المعلومات، يمكنك الرجوع إلى وثائق التسجيل.
  • disconnected — عقدة Coreapp غير متصلة بخوادم واتساب.

role

النوع: String (سلسلة)

يمثل دور الحاوية في عمليات إعداد التوفّر العالي/الاتصال المتعدد. لمزيد من المعلومات حول عمليات الإعداد هذه، راجع وثائق التوّفر وتوسيع النطاق.


القيم المدعومة: primary_master، secondary_master، coreapp