أحداث Webhooks في منصة واتساب للأعمال

مدونة واتساب للأعمال

تتيح لك أحداث Webhooks تلقي إشعارات HTTP فورية تتضمن التغييرات التي تطرأ على كائنات محددة. على سبيل المثال، يمكننا إرسال إشعار إليك عندما يرسل لك المستخدم رسالة أو عند تغير حالة قالب الرسالة. وسيوفر عليك هذا الاضطرار إلى إرسال الاستعلامات إلى واجهات API التي نوفرها لمعرفة التغييرات التي تطرأ على الكائنات التي قد حدثت أو لم تحدث، ويساعدك في تجنب الوصول إلى حد تقييد معدلات الاستدعاء لديك.

يوفر هذا المستند نظرة عامة على أحداث Webhooks وتنطبق هذه الأحداث على API إدارة حساب واتساب للأعمال وAPI السحابة الخاصة بمنصة واتساب للأعمال وAPI داخل المواقع الخاصة بمنصة واتساب للأعمال.

الكائنات والحقول والقيم

يمكن أن تحتوي كل API على عدة أنواع من الكائنات، لذا كلما تقوم بتكوين حدث Webhook، يجب أولاً اختيار نوع كائن. نظرًا لأن الكائنات المختلفة لديها حقول مختلفة، يجب الاشتراك في حقول محددة لنوع الكائن هذا. عند وجود تغيير في القيمة الخاصة بحقل أي كائن قمت بالاشتراك فيه، ستتلقى إشعارًا.

يتم إرسال الإشعارات إليك كطلبات HTTP POST وتحتوي على حمولة بيانات JSON تصف التغيير.

أحداث Webhooks المتوفرة

يوضح الجدول التالي المعلومات التي يمكنك تلقيها من جانب أحداث Webhooks.

APIالكائنات

API السحابة

  • يتخذ العميل إجراءً مثل الرد على رسالة نشاط تجاري
  • يقوم العميل بتحديث رقم هاتفه
  • يتم إرسال رسالة بواسطة نشاط تجاري أو تسليمها إلى العميل أو قراءتها بواسطة العميل، وتتضمن معلومات حول التسعير
  • حدث خطأ في الرسالة

API داخل المواقع

  • يتخذ العميل إجراءً مثل الرد على رسالة نشاط تجاري
  • يقوم العميل بتحديث رقم هاتفه
  • يتم إرسال رسالة بواسطة نشاط تجاري أو تسليمها إلى العميل أو قراءتها بواسطة العميل، وتتضمن معلومات حول التسعير
  • حدث خطأ في الرسالة

API إدارة حساب واتساب للأعمال

  • تغييرات على حالة الحساب التجاري الرسمي وحالة اسم العرض
  • تغيير حالة مراجعة حساب واتساب للأعمال
  • تم تحديث معلومات حساب واتساب للأعمال، بما في ذلك المعلومات الخاصة بانتهاكات السياسة
  • تم تغيير إمكانات حساب واتساب للأعمال، مثل التغيير في عدد المحادثات لكل رقم هاتف
  • تم اعتماد قالب الرسالة أو رفضه أو تعطيله
  • تم اعتماد اسم العرض المرتبط برقم الهاتف أو رفضه
  • تم تغيير الحالة المتعلقة بالجودة لرقم الهاتف

مثال على إشعار رسالة نصية

تمثل الأمثلة التالية إشعار Webhook يتم إرساله إليك عندما يرسل لك مستخدم رسالة نصية.

API السحابة

بالنسبة لواجهة API السحابة، دائمًا ما يكون الكائن whatsapp_business_account، لكن الحقل field سيشير إلى نوع المعلومات التي يتم إرسالها.

{
  "object": "whatsapp_business_account",
  "entry": [{
    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "metadata": {
          "display_phone_number": PHONE_NUMBER,
          "phone_number_id": PHONE_NUMBER_ID
        },
        "contacts": [{
          "profile": {
            "name": "NAME"
          },
          "wa_id": PHONE_NUMBER
        }],
        "messages": [{
          "from": PHONE_NUMBER,
          "id": "wamid.ID",
          "timestamp": TIMESTAMP,
          "text": {
            "body": "MESSAGE_BODY"
          },
          "type": "text"
        }]
      },
      "field": "messages"
    }]
  }]
}

API داخل المواقع

بالنسبة لواجهة API داخل المواقع، نظرًا لأن عميلك هو الذي يرسل حدث Webhook بدلاً من Meta، فسيكون الكائن contacts وmessages وerrors أو statuses وpricing.

{
  "contacts": [{
    "profile": {
      "name": "NAME"
    },
    "wa_id": "WHATSAPP_BUSINESS_ACCOUNT_ID"
  }],
  "messages":[{
    "from": "PHONE_NUMBER",
    "id": "wamid.ID",
    "timestamp": "TIMESTAMP",
    "text": {
      "body": "MESSAGE_BODY"
    },
    "type": "text"
  }]
} 

خادم HTTPS

يتم إرسال كل أحداث Webhooks باستخدام HTTPS، لذلك يجب أن يكون خادمك قادرًا على تلقي طلبات HTTPS ومعالجتها، ويجب أن يكون مثبتًا عليه شهادة TLS/SSL صالحة. علمًا بأن الشهادات الموقّعة ذاتيًا غير مدعومة.

الخطوات التالية

  • بدء الاستخدام - حدّد API المناسبة لنشاطك التجاري.
  • اسم العرض - يمكنك إعداد اسم النشاط التجاري الذي يتم عرضه في رسائل واتساب.
  • أرقام الهواتف - يمكنك ربط رقم هاتف بحساب واتساب للأعمال
  • التسعير - تعرف على التسعير وكيفية إعداد عمليات الدفع.