مرجع حدث Webhook لـ messaging_optins

يتم بدء حدث Webhook للاشتراك في المراسلة عندما يشترك شخص ما لتلقي الرسائل التسويقية أو يضغط على المكون الإضافي "إرسال إلى Messenger".

عند استخدام المكون الإضافي "إرسال إلى Messenger"، يتم تعيين المعلمة optin.ref بواسطة الحقل data-ref في المكون الإضافي "إرسال إلى Messenger". يمكن استخدام هذا الحقل بواسطة المطور لربط حدث النقر على المكون الإضافي باستجابة الاستدعاء.

إشعار Webhook للاشتراك في المراسلة

سيتلقى تطبيقك إشعار webhook للاشتراك عند حدوث ما يلي:

  • يشترك شخص ما
  • يعيد شخص ما الاشتراك بواسطة النقر على الزر متابعة الرسائل الذي يظهر قبل انتهاء صلاحية رمز رسالة الإشعار
  • يغير شخص ما حالة الاشتراك الخاصة به، سواء بإيقاف الإشعارات أو استئنافها
{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "payload": "ADDITIONAL-INFORMATION",
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_frequency": "FREQUENCY",  
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS",  
    "notification_messages_status": "NOTIFICATION-STATUS",
    "title": "TITLE" 
    }
}

optin

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

payload

string (سلسلة)

المعلومات الإضافية التي ترغب في تضمينها في إشعار webhooks

title

string (سلسلة)

العنوان المعروض في القالب

notification_messages_token

string (سلسلة)

الرمز الذي يمثل الشخص المشترك، ويحتوي على الموضوع المحدد ومعدل تكرار الرسالة، والذي يُستخدم لإرسال الرسائل التسويقية

notification_messages_frequency

enum (تعداد) { DAILY, WEEKLY, MONTHLY }

يمكن أن تكون القيمة واحدة مما يلي:

  • DAILY - إرسال إشعار واحد كل 24 ساعة لمدة 6 أشهر من تاريخ الاشتراك
  • WEEKLY - إرسال إشعار واحد كل أسبوع لمدة 9 أشهر من تاريخ الاشتراك
  • MONTHLY - إرسال إشعار واحد كل شهر لمدة 12 شهرًا من تاريخ الاشتراك

(تمت الإزالة في الإصدار 16 من API)

notification_messages_timezone

string (سلسلة)

المنطقة الزمنية للشخص الذي يستلم الرسالة

notification_messages_status

enum (تعداد) { STOP NOTIFICATIONS, RESUME NOTIFICATIONS }
يظهر هذا الحقل فقط عندما يقوم المستخدم بإيقاف الرسائل التسويقية مؤقتًا أو استئنافها.

يمكن أن تكون القيمة واحدة مما يلي:

  • STOP NOTIFICATIONS - نقر المستخدم على "إيقاف هذه الرسائل"
  • RESUME NOTIFICATIONS - نقر المستخدم على "استئناف هذه الرسائل"

token_expiry_timestamp

unix timestamp (طابع زمني بتنسيق unix)

التاريخ الذي تنتهي فيه صلاحية رمز رسالة الإشعار

type

string (سلسلة)

يجب أن تكون القيمة notification_messages

user_token_status

enum (تعداد) { REFRESHED, NOT_REFRESHED }

يمكن أن تكون القيمة واحدة مما يلي:

  • REFRESHED - يتم تعيينه عندما يختار المستخدم إعادة الاشتراك في تلقي الرسائل التسويقية بعد انتهاء صلاحية الرمز
  • NOT_REFRESHED - قيمة افتراضية ويتم تعيينها عندما لا يختار المستخدم إعادة الاشتراك في تلقي الرسائل التسويقية بعد انتهاء صلاحية الرمز