مرجع حدث Webhook لـ message_echoes

سيحدث هذا الاستدعاء عند إرسال رسالة من جانب صفحتك. قد تتلقى رسائل text أو رسائل تتضمن مرفقات من النوع (image أو video أو audio أو template أو fallback). ستتضمن حمولة البيانات أيضًا metadata مخصصة اختيارية يتم إرسالها من جانب المُرسل app_id المقابل.
يمكنك الاشتراك في هذا الاستدعاء عن طريق تحديد الحقل message_echoes عند إعداد حدث webhook الذي تستخدمه.

يتم دعم أنواع متعددة من الرسائل:

التنسيق الشائع

المثال الأول

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}   

المثال الثاني

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGEID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGEID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

الخصائص

sender

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

id

String (سلسلة)

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

user_ref

String (سلسلة)

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

recipient

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

id

String (سلسلة)

معرف صفحتك.

message

اسم الحقل النوع الوصف

is_echo

Boolean (قيمة منطقية)

تشير إلى الرسالة المُرسلة من الصفحة نفسها

app_id

String (سلسلة)

معرف التطبيق الذي تم إرسال الرسالة منه. بدءًا من الإصدار v12.0 والإصدارات الأحدث في Graph API، سيقوم الحقل app_id بإرجاع معرف تطبيق البريد الوارد لصفحة فيسبوك (26390203743090) عندما يتم إرسال الرسالة عبر البريد الوارد لصفحة فيسبوك.

metadata

String (سلسلة)

سلسلة مخصصة يتم إرسالها إلى Send API في صورة حقل metadata. لا يتوفر إلا في حالة تعيين الخاصية metadata في الرسالة الأصلية.

mid

String (سلسلة)

معرف الرسالة

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

مثال

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}    

الخصائص

message

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

text

String (سلسلة)

نص الرسالة

رسالة تتضمن صورة أو مقطعًا صوتيًا أو فيديو أو ملفًا مرفقًا

مثال

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}    

الخصائص

message.attachments

الخصائص النوع الوصف

type

String (سلسلة)

نوع المرفق: image أو audio أو video أو file

payload.url

String (سلسلة)

عنوان URL للمرفق

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

مثال

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}    

الخصائص

message.attachments

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

type

String (سلسلة)

template

payload

String (سلسلة)

حمولة بيانات القالب كما هو موضح في مرجع Send API

لاحظ أنه في حالة وجود payload تتضمن مرفقات، يكون معرف المرفق المُرسل رقمًا وليس سلسلة. راجع المثال 2

لا يتطابق هذا مع تنسيق Send API التي تتطلب إرسال معرف المرفق كسلسلة.

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

المرفق الاحتياطي هو أي مرفق لم يتم تحديده حاليًا أو دعمه بواسطة ميزة Message Echo.

مثال

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}    

الخصائص

message.attachments

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

type

String (سلسلة)

fallback

title

String (سلسلة)

عنوان المرفق (اختياري)

url

String (سلسلة)

عنوان URL للمرفق (اختياري)

payload

String (سلسلة)

حمولة بيانات المرفق (اختياري)

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

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

سيحتاج التطبيق إلى الحصول على إذن catalog_management المعتمد لاستلام تفاصيل المنتجات في أحداث webhooks.

مثال

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}     

الخصائص

product.elements

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

id

String (سلسلة)

معرف المنتج من كتالوج المنتجات

retailer_id

String (سلسلة)

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

image_url

String (سلسلة)

عنوان URL لصورة المنتج

title

String (سلسلة)

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

subtitle

String (سلسلة)

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