مرجع حدث Webhook لـ messages

سيحدث هذا الاستدعاء عند إرسال رسالة إلى صفحتك. ويتم دائمًا إرسال الرسائل بالترتيب. قد تتلقى رسائل نصية أو رسائل تتضمن مرفقات.

أنواع المرفقات image، audio، video، file، reel وig_reel هي الأنواع المدعومة الرئيسية. قد تستلم أيضًا مرفقات fallback. وكمثال شائع على "الاستدعاء"، عندما يشارك المستخدم عنوان URL مع صفحة ويتم إنشاء مرفق بناءً على مشاركة الرابط. بالنسبة للمشاركات غير المدعومة التي تم إجراؤها بواسطة المستخدمين على صفحتك، قد يتم إرسال fallback بدون حمولة بيانات.

يمكنك الاشتراك في هذا الاستدعاء بتحديد message عند إعداد حدث webhook.

أمثلة

الرسالة النصية

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

رسالة الرد

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

رسالة تتضمن مرفقًا

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

رسالة تتضمن قالب منتج

يتوفر حدث webhook للرسالة التي تتضمن قالب المنتج فقط في واجهة Graph API بالإصدار 8.0 والإصدارات الأحدث

ينطبق حدث webhook هذا على السيناريو عندما يشارك المستخدم المنتجات من سلاسل المنشورات الأخرى أو تدفق المشاركة في الصفحة. ولا يقتصر حدث webhook هذا سوى على المنتجات المملوكة للصفحة. سيحتاج التطبيق إلى الحصول على الإذن catalog_management المعتمد لاستلام تفاصيل المنتجات في أحداث webhooks.

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

رسالة تتضمن مرفقًا احتياطيًا

ينطبق المثال على messages في الإصدار 6.0 والإصدارات الأحدث

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

رسالة من صفحة تفاصيل المنتج في المتاجر

يكون حدث webhook للرسائل من صفحة تفاصيل المنتج في المتاجر متوفرًا فقط في Graph API بالإصدار 8.0 والإصدارات الأحدث

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

رسالة تحتوي على معلومات إحالة الإعلانات

ينطبق حدث webhook هذا على السيناريو عندما ينقر المستخدم على إعلان CTM (النقر لفتح محادثة في Messenger) ويرسل رسالة إلى صفحة فيسبوك. بالإضافة إلى تفاصيل الرسالة المضمنة، سيتلقى التطبيق معلومات إحالة الإعلانات.

تتطلب الرسالة التي تحتوي على معلومات إحالة الإعلانات أن يكون لدى التطبيق اشتراكات صفحة في كل من الحقلين messages وmessaging_referrals.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "product_id": "<PRODUCT_ID>"
      }
    }
  }
}

رسالة تحتوي على أوامر

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

الخصائص

sender

الخاصيةالنوعالوصف

id

String (سلسلة)

المعرف الخاص بالصفحة لدى المستخدم والذي شغّل الحدث webhook.

user_ref

String (سلسلة)

المعلمة user_ref لدى المستخدم والتي شغّلت الحدث webhook. ويتوفر هذا فقط لحدث webhook من المكون الإضافي للدردشة.

recipient

الخاصيةالنوعالوصف

id

String (سلسلة)

معرف صفحتك.

message

إعلام بتاريخ 4 مارس 2020

بالنسبة للإصدار 6.0 والإصدارات الأحدث، تم نقل sticker_id من message إلى message.attachments.payload

الخاصية النوع الوصف

mid

String (سلسلة)

تمثل معرف الرسالة

text

String (سلسلة)

تمثل نص الرسالة

quick_reply

Object (كائن)

تمثل البيانات المخصصة الاختيارية المتوفرة بواسطة تطبيق الإرسال

reply_to

Object (كائن)

تمثل مرجعًا إلى معرف الرسالة (mid) الذي يتم إرسال رد هذه الرسالة إليه

attachments

Array (مصفوفة)<attachment>

تمثل مصفوفة تحتوي على بيانات المرفق

referral

Object (كائن)

تمثل إحالة الرسالة من صفحة تفاصيل المنتج في المتاجر.

message.quick_reply

لا يتم توفير حمولة البيانات quick_reply إلا مع رسالة نصية عندما يضغط المستخدم على الزر الردود السريعة.

الخاصية النوع الوصف

payload

String (سلسلة)

تمثل البيانات المخصصة التي يوفرها التطبيق

message.reply_to

الخاصية النوع الوصف

mid

String (سلسلة)

تمثل مرجعًا إلى معرف الرسالة الذي يتم إرسال رد هذه الرسالة إليه

message.attachments

الخاصية النوع الوصف

type

String (سلسلة)

audio أو file أو image أو video أو fallback أو reel أو ig_reel

payload

String (سلسلة)

message.attachments.payload

message.attachments.payload

الخاصية النوع الوصف

url

String (سلسلة)

عنوان URL لنوع المرفق. تنطبق على نوع المرفق: audio، file، image، video، fallback، reel، ig_reel

title

String (سلسلة)

عنوان المرفق. تنطبق على نوع المرفق: fallback وreel وig_reel

sticker_id

الرقم

تمثل المعرف الدائم لهذا الملصق، على سبيل المثال يشير 369239263222822 إلى ملصق الإعجاب. تنطبق على نوع المرفق: image فقط إذا تم إرسال ملصق.

reel_video_id

الرقم

معرف الفيديو المرتبط بمقطع ريلز المرفق. تنطبق على نوع المرفق: reel وig_reel

message.attachments.payload.product.elements

الخاصية النوع الوصف

id

String (سلسلة)

تمثل معرف المنتج من كتالوج منتجات فيسبوك

retailer_id

String (سلسلة)

تمثل المعرف الخارجي المرتبط بالمنتج. (على سبيل المثال: وحدة حفظ المخزون (SKU)/ معرف المحتوى)

image_url

String (سلسلة)

تمثل عنوان URL المنتج

title

String (سلسلة)

تمثل عنوان المنتج

subtitle

String (سلسلة)

تمثل العنوان الفرعي للمنتج

message.referral

لا يتم توفير حمولة بيانات referral إلا عندما يرسل المستخدم رسالة من صفحة تفاصيل المنتج في المتاجر.

الخاصية النوع الوصف

product

Object (كائن)

معلومات المنتج

source

String (سلسلة)

مصدر الإحالة. القيم المدعومة: ADS (تدعم إحالة الإعلانات فقط).

type

String (سلسلة)

نوع الإحالة. تدعم حاليًا OPEN_THREAD.

ref

String (سلسلة)

السمة الاختيارية ref المُعيّنة في جهة الإحالة. يتم دعم الأحرف الأبجدية الرقمية فقط و- و_ و=.

ad_id

String (سلسلة)

معرف الإعلان من مدير الإعلانات.

ads_context_data

Object (كائن)

بيانات سياق الإعلان من مدير الإعلانات.

message.referral.product

الخاصية النوع الوصف

id

String (سلسلة)

معرف المنتج

message.referral.ads_context_data

الخاصية النوع الوصف

ad_title

String (سلسلة)

عنوان الإعلان في مدير الإعلانات.

photo_url

String (سلسلة)

[اختياري] عنوان URL للصورة من الإعلان.

video_url

String (سلسلة)

[اختياري] عنوان URL للصورة المصغرة للفيديو من الإعلان.

post_id

String (سلسلة)

معرف منشور الإعلان في مدير الإعلانات.

product_id

String (سلسلة)

[اختياري] معرف المنتج من الإعلان.

message.commands

الخاصية النوع الوصف

name

String (سلسلة)

اسم الأمر