مرجع حدث Webhook لـ messaging_referrals

سيتم إجراء هذه الاستعادة عندما يكون لدى المستخدم بالفعل سلسلة منشورات باستخدام البرنامج التلقائي، ويأتي المستخدم إلى تلك السلسلة عن طريق:

لتتبع الإحالات في سلاسل المنشورات الجديدة، راجع حدث الرد الجاهز.

لبدء تلقي هذه الأحداث، يجب عليك الاشتراك في messaging_referrals في إعدادات حدث webhook لتطبيقك.

المحتويات

أمثلة

رابط m.me

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

إحالة إعلان

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "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>
    }
  }
}

المكون الإضافي "دردشة العملاء"

تغيير عاجل (5 مايو 2020)

لن يتم إرجاع الحقل sender.id من المكون الإضافي للدردشة في حدث messaging_referrals webhook في الإصدار 7.0 والإصدارات الأحدث لواجهة Graph API. وسيتم إرجاع حقل sender.user_ref جديد. وستسري هذه التغييرات على جميع إصدارات واجهة Graph API السابقة اعتبارًا من 2 نوفمبر 2020.

حدث Webhook جديد للإحالة (واجهة Graph API بالإصدار 7.0 والإصدارات الأحدث وجميع إصدارات واجهة Graph API اعتبارًا من 2 نوفمبر 2020)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

حدث Webhook قديم للإحالة (واجهة Graph API بالإصدار 6.0 والإصدارات الأقدم منه أو المساوية له ومتوفر حتى 2 نوفمبر 2020)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

الخصائص

sender

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

id

String (سلسلة)

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

user_ref

String (سلسلة)

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

recipient

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

id

String (سلسلة)

معرف صفحتك.

referral

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

source

String (سلسلة)

مصدر الإحالة. علمًا بأن القيم المدعومة هي:

  • ADS
  • SHORTLINK
  • CUSTOMER_CHAT_PLUGIN

type

String (سلسلة)

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

ref

String (سلسلة)

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

referer_uri

String (سلسلة)

عنوان URL للموقع الذي تم إرسال الرسالة إليه في المكون الإضافي "دردشة" على فيسبوك.

is_guest_user

String (سلسلة)

تمييز يشير إلى ما إذا كان المستخدم ضيفًا من المكون الإضافي "دردشة" على فيسبوك

ads_context_data

Object (كائن)

البيانات التي تحتوي على معلومات حول إعلان يؤدي النقر عليه إلى فتح محادثة في Messenger، والذي بدأ المستخدم سلسلة المنشورات منه.

ads_context_data

PropertyTypeDescription

ad_title

String

Title of the Ad.

photo_url

String

[Optional] Url of the image from the Ad the user is interested.

video_url

String

[Optional] Thumbnail url of the the video from the ad.

post_id

String

ID of the post.

product_id

String

[Optional] Product ID from the Ad the user is interested.