واجهة API التحويلات هي إحدى أدوات Meta للأعمال التي تتيح لشركاء مراسلات الأعمال مشاركة بيانات عملائهم، بشرط أن تتوفر لديهم الأذونات اللازمة لذلك، مباشرة من خوادمهم وهي مصممة للالتزام بضوابط خصوصية المستخدم في Meta تلقائيًا. يسمح هذا لشركاء مراسلات الأعمال بإرسال بيانات موثوقة حول تفاعلات العملاء القيمة في الدردشات مع الأنشطة التجارية لفهم أداء إعلانات العملاء التي يتم النقر عليها على واتساب أو Messenger أو Instagram وتحسينه، ما يؤدي إلى رفع الكفاءة التشغيلية وتنمية الأنشطة التجارية.
تم تصميم هذا الدليل لدعم شركاء مراسلات الأعمال فيما يتعلق بإكمال الدمج الفني لواجهة API التحويلات في تطبيق واتساب أو Messenger أو Instagram نيابة عن عملائهم. يتناول الدليل:
ملاحظة: تمكن واجهة API التحويلات أيضًا المعلنين من إرسال أحداث موقع الويب والتطبيق والأحداث بلا اتصال (بما في ذلك المتجر الفعلي) وأحداث إدارة علاقات العملاء إلى Meta. حاليًا، لا يزال شركاء مراسلة الأعمال الذين دمجوا واجهة API التحويلات لحالات الاستخدام الأخرى بحاجة إلى اتباع الخطوات التالية لدمج واجهة API التحويلات لمراسلة الأعمال.
قبل بدء أي عملية دمج، من الضروري ضمان إنشاء الأسس الفنية المناسبة ومنح الوصول المناسب لأصول ومنصات محددة.
إذا لم يتوفر لديك تطبيق بالفعل، فيمكنك اتباع التعليمات لإنشاء واحد.
page_events
page_events
في قسم "الأذونات والميزات" ضمن لوحة معلومات تطبيق المطوّر. إذا توفرت لديك بالفعل صلاحية الوصول المتقدم إلى الإذن pages_messaging
، فيجب أن تتم الموافقة تلقائيًا على تطبيقك للحصول على إذن page_events
بعد تقديم طلب.1. الحصول على رمز الوصول
لاستدعاء API مجموعة البيانات وواجهة API التحويلات، تحتاج إلى رمز وصول مع الأذونات اللازمة:
page_events
أعد استخدام الرمز الذي تم إنشاؤه من تسجيل دخول فيسبوك للأعمال.
2. الحصول على page_id
تأكد من وجود معرف الصفحة التي تريد الإبلاغ عن الأحداث الخاصة بها.
3. إعداد مجموعة البيانات
عند مشاركة بيانات الحدث مع Meta عبر واجهة API التحويلات، ستحتاج Meta إلى معرفة المصدر المرتبط بتلك الأحداث. تسمح لك مجموعات البيانات بالاتصال ببيانات الأحداث وإدارتها من مصادر مختلفة، مثل موقعك على الويب أو تطبيق الهواتف المحمولة أو موقع المتجر الفعلي أو الدردشات مع النشاط التجاري، في مكان واحد. يمكنك التعرف على المزيد حول مجموعات البيانات هنا.
يتم إنشاء مجموعات البيانات إما من خلال منصة شريكة أو مباشرة في مدير الأحداث. يمتلك النشاط التجاري مجموعة البيانات، وإذا كان النشاط التجاري يعمل مع شريك، فسيتم منح الوصول إلى مجموعة البيانات للشريك أيضًا.
استخدم page_id
وaccess_token
لإنشاء مجموعة بيانات عن طريق إرسال استدعاء POST
إلى API مجموعة البيانات. إذا كان هناك dataset_id
مرتبطًا بالفعل بالصفحة، فسيتم إرجاع هذا المعرف. تتوفر عينة من الاستدعاء أدناه:
https://graph.facebook.com/v16.0/{PAGE_ID}/dataset?access_token={TOKEN}
ستكون الاستجابة عبارة عن معرف يمثل dataset_id
. باستخدام هذا المعرف ورمز الوصول الذي تم استلامه من تسجيل دخول فيسبوك للأعمال، يمكنك الآن استدعاء واجهة API التحويلات لإرسال أحداث المراسلة إلى Meta.
ملاحظة: إذا كانت الصفحة مرتبطة بحساب أعمال وتم منح إذن business_management
في حساب الأعمال، فستظهر مجموعة البيانات ضمن حساب الأعمال. بخلاف ذلك، فسيتم إخفاؤها عن المعلن.
4. استرداد المعرف على مستوى الصفحة (PSID)
المعرف على مستوى الصفحة (PSID
) هو معرف يمثل المستخدم في المحادثات التي تتم بين المستخدم والنشاط التجاري. يتم عرض هذا المعرف عبر حدث webhook للرسائل ويتم استخدامه في API الإرسال/الاستلام. يتم استخدام هذا أيضًا في واجهة API التحويلات عند إرسال أحداث تحويل تم تعيينها إلى مستخدم معين (PSID
).
تأكد من وجود المعرف على مستوى الصفحة للصفحة التي تريد الإبلاغ عن الإشارات الخاصة بها.
في المرحلة النهائية من الدمج، أصبح من الممكن الآن إرسال الأحداث عبر واجهة API التحويلات مع جميع المعلومات (waba_id
، dataset_id
، ctwa_clid
، access_token
) التي تم الحصول عليها في الخطوات السابقة.
خلال فترة الحملة، وبما أن الأحداث تقع في الوقت الفعلي، أبلغ Meta بهذه الأحداث عبر واجهة API التحويلات باستخدام dataset_id
وaccess_token
. أرسل طلب POST
إلى API هذه:
https://graph.facebook.com/v16.0/{DATASET_ID}/events?access_token={TOKEN}
فيما يلي عينة من استدعاء API لحدث شراء واحد.
{ "data": [ { "event_name": "Purchase", "event_time": 1675999999, "action_source": "business_messaging", "messaging_channel": "messenger", "user_data": { "page_id": <PAGE_ID>, "page_scoped_user_id": <PSID> }, "custom_data": { "currency": "USD", "value": 123 } } ], "partner_agent": "<PARTNER_NAME>" }
بعد إرسال حدث إلى Meta عبر واجهة API التحويلات بنجاح، يجب أن تكون قادرًا على رؤية هذا الحدث المعروض في مدير الأحداث لمجموعة البيانات المحددة. يمكنك معرفة المزيد حول مدير الأحداث واستخدامه هنا.
ملاحظة: إذا كنت شريكًا، فستحتاج إلى توجيه المعلن حول كيفية الوصول إلى مجموعة البيانات الخاصة به في مدير الأحداث للتحقق من استلام الأحداث.
قبل بدء أي عملية دمج، من الضروري ضمان إنشاء الأسس الفنية المناسبة ومنح الوصول المناسب لأصول ومنصات محددة.
إذا لم يتوفر لديك تطبيق بالفعل، فيمكنك اتباع التعليمات لإنشاء واحد.
whatsapp_business_manage_events
whatsapp_business_manage_events
في قسم "الأذونات والميزات" ضمن لوحة معلومات تطبيق المطوّر. إذا توفرت لديك بالفعل صلاحية الوصول المتقدم إلى الإذن whatsapp_business_messaging
، فيجب أن تتم الموافقة تلقائيًا على تطبيقك للحصول على إذن whatsapp_business_manage_events
بعد تقديم طلب.ctwa_clid
، وهو حقل مطلوب لإرسال الأحداث عبر واجهة API التحويلات، ومتوفر فقط في حدث webhook للرسائل فيإصدارات 2.45.1 من Biz API والإصدارات الأحداث. ملاحظة: ستنتقل منصة واتساب للأعمال بالكامل إلى API السحابة من الجيل التالي خلال العامين المقبلين. ستنتهي صلاحية آخر إصدار مدعوم من عميل API داخل المواقع في 23 أكتوبر 2025. معرفة المزيد.1. الحصول على رمز الوصول
لاستدعاء API مجموعة البيانات وواجهة API التحويلات، تحتاج إلى رمز وصول مع الإذن اللازم:
whatsapp_business_management
whatsapp_business_manage_events
إذا تم الدمج مع التسجيل المضمن، فنوصي بإعادة استخدام الرمز الذي تم إنشاؤه من دفق التسجيل المضمن. وكإجراء بديل، يمكنك استخدام رمز وصول مستخدم نظام دمج الأعمال أو رمز وصول مستخدم النظام أو رمز وصول المستخدم طالما أنه يحتوي على الأذونات اللازمة.
2. استرداد معرف حساب واتساب للأعمال
يمكن الحصول على معرف حساب واتساب للأعمال (waba_id
) عند إكمال دفق التسجيل المضمن. عرض التفاصيل.
3. إعداد API مجموعة البيانات
عند مشاركة بيانات الحدث مع Meta عبر واجهة API التحويلات، ستحتاج Meta إلى معرفة المصدر المرتبط بتلك الأحداث. تسمح مجموعات البيانات لشركاء حلول الأعمال في Meta بالاتصال ببيانات الأحداث وإدارتها من مصادر مختلفة، مثل موقع الويب أو تطبيق الهواتف المحمولة أو موقع المتجر الفعلي أو الدردشات مع النشاط التجاري لدى العميل، في مكان واحد. يمكنك التعرف على المزيد حول مجموعات البيانات هنا. تُعد مجموعات البيانات مملوكة للعميل، ويمكن الوصول إليها من قبل شركاء حلول الأعمال في Meta مع وجود الأذونات اللازمة.
يمكنك استخدام whatsapp_business_account_id
وaccess_token
لإنشاء مجموعة بيانات عن طريق إرسال استدعاء POST
إلى API مجموعة البيانات. إذا كان هناك dataset_id
مرتبطًا بالفعل بحساب واتساب للأعمال، فسيتم إرجاع هذا المعرف. تتوفر عينة من الاستدعاء أدناه:
https://graph.facebook.com/v16.0/{WHATSAPP_BUSINESS_ACCOUNT_ID}/dataset?access_token={TOKEN}
لاسترداد dataset_id، يمكنك تنفيذ استدعاء GET
في API مجموعة البيانات مع توفير page_id
وaccess_token
. تتوفر عينة من الاستدعاء أدناه:
https://graph.facebook.com/v16.0/{WHATSAPP_BUSINESS_ACCOUNT_ID}/dataset?access_token={TOKEN}
ستكون الاستجابة عبارة عن معرف يمثل dataset_id
. أصبحت الآن مجموعة البيانات جاهزة للاستخدام. بعد ذلك، ستحتاج إلى استرداد ctwa_clid
المطلوب لإجراء استدعاء واجهة API التحويلات وإرسال حدث.
4. استرداد معرف النقر لإعلانات النقر لفتح محادثة في واتساب
معرف النقر لإعلانات النقر لفتح محادثة في واتساب (ctwa_clid
) هو معرف شخصي فريد لكل نقرة، يتم عرضه للنشاط التجاري عندما يدخل المستخدم إلى المحادثة من خلال إعلان النقر لفتح محادثة في واتساب. يجب إعادة إرسال هذا المعرف إلى Meta عبر استدعاء واجهة API التحويلات (راجع القسم أدناه للحصول على مرجع).
يتم الحصول على حقل ctwa_cli
من كائن الإحالة ضمن حدث webhook للرسائل (API السحابة | API داخل المواقع).
عند استلام ctwa_clid
، قم بتخزينه مع المحادثة. عندما يحدث التحويل داخل محادثة، أرسل ctwa_clid
المقابل عبر واجهة API التحويلات. فيما يلي عينة من رسالة تم استلامها مع كائن إحالة يحتوي على ctwa_clid
:
{ "data": [ { "contacts": [ { "profile": { "name": "Kerry Fisher " }, "wa_id": "16315551234" } ], "messages": [ { "from": "12345678", "id": "ABGGFlA5FpafAgo6tHcNmNjXmuSf", "referral": { "body": "This is a great product", "ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO2E4Nx0-eM-GABDLOPaOdRMv-_zfUQ2a", // <CLICK_TO_WHATSAPP_CLICK_ID> "headline": "Our new product", "image": { "id": "e144be57-12b1-4035-a520-703fcc87ef45" }, "source_id": "1234567890", "source_type": "ad", "source_url": "https://fb.me/AAAAA" }, "text": { "body": "Can I learn more about your business?" }, "timestamp": "1678189586", "type": "text" } ] }
في المرحلة النهائية من الدمج، أصبح من الممكن الآن إرسال الأحداث عبر واجهة API التحويلات مع جميع المعلومات (waba_id
، dataset_id
، ctwa_clid
) التي تم الحصول عليها في الخطوات السابقة.
أثناء فترة حملة المعلن، تحدث الأحداث في الوقت الفعلي. أبلغ Meta بهذه الأحداث عبر واجهة API التحويلات باستخدام dataset_id
ورمز الوصول. أرسل طلب POST
إلى API هذه:
https://graph.facebook.com/v16.0/{DATASET_ID}/events?access_token={TOKEN}
فيما يلي عينة من استدعاء API لحدث شراء واحد.
{ "data": [ { "data": [ { "event_name": "Purchase", "event_time": 1675999999, "action_source": "business_messaging", "messaging_channel": "whatsapp", "user_data": { "whatsapp_business_account_id": <WHATSAPP_BUSINESS_ACCOUNT_ID>, "ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO2E4Nx0-eM-GABDLOPaOdRMv-_zfUQ2a", // <CLICK_TO_WHATSAPP_CLICK_ID> }, "custom_data": { "currency": "USD", "value": 123 } } ], "partner_agent": "<PARTNER_NAME>" }
بعد إرسال حدث إلى Meta عبر واجهة API التحويلات بنجاح، يجب أن تكون قادرًا على رؤية هذا الحدث المعروض في مدير الأحداث لمجموعة البيانات المحددة. يمكنك معرفة المزيد حول مدير الأحداث واستخدامه هنا.
ملاحظة: إذا كنت شريكًا، فستحتاج إلى توجيه المعلن حول كيفية الوصول إلى مجموعة البيانات الخاصة به في مدير الأحداث للتحقق من استلام الأحداث.
قبل بدء أي عملية دمج، من الضروري ضمان إنشاء الأسس الفنية المناسبة ومنح الوصول المناسب لأصول ومنصات محددة.
إذا لم يتوفر لديك تطبيق بالفعل، فيمكنك اتباع التعليمات لإنشاء واحد.
instagram_manage_events
instagram_manage_events
في قسم "الأذونات والميزات" ضمن لوحة معلومات تطبيق المطوّر. إذا توفرت لديك بالفعل صلاحية الوصول المتقدم إلى الإذن instagram_manage_messages
، فيجب أن تتم الموافقة تلقائيًا على تطبيقك للحصول على إذن instagram_manage_events
.1. الحصول على رمز الوصول
لاستدعاء API مجموعة البيانات وواجهة API التحويلات، تحتاج إلى رمز وصول مع الأذونات اللازمة:
instagram_manage_events
أعد استخدام الرمز الذي تم إنشاؤه من تسجيل دخول فيسبوك للأعمال.
2. الحصول على `instagram_user_id`
تأكد من وجود instagram_user_id
لحساب Instagram الذي تريد الإبلاغ عن الأحداث الخاصة بها.
3. إعداد مجموعة البيانات
عند مشاركة بيانات الحدث مع Meta عبر واجهة API التحويلات، ستحتاج Meta إلى معرفة المصدر المرتبط بتلك الأحداث. تسمح لك مجموعات البيانات بالاتصال ببيانات الأحداث وإدارتها من مصادر مختلفة، مثل موقعك على الويب أو تطبيق الهواتف المحمولة أو موقع المتجر الفعلي أو الدردشات مع النشاط التجاري، في مكان واحد. يمكنك التعرف على المزيد حول مجموعات البيانات هنا.
يتم إنشاء مجموعات البيانات إما من خلال منصة شريكة أو مباشرة في مدير الأحداث. يمتلك النشاط التجاري مجموعة البيانات، وإذا كان النشاط التجاري يعمل مع شريك، فسيتم منح الوصول إلى مجموعة البيانات للشريك أيضًا.
استخدم instagram_user_id
وaccess_token
لإنشاء مجموعة بيانات عن طريق إرسال استدعاء POST
إلى API مجموعة البيانات. إذا كان هناك dataset_id
مرتبطًا بالفعل بمستخدم IG، فسيتم إرجاع هذا المعرف. تتوفر عينة من الاستدعاء أدناه:
https://graph.facebook.com/v16.0/{IG_USER_ID}/dataset?access_token={TOKEN}
ستكون الاستجابة عبارة عن معرف يمثل dataset_id
. باستخدام هذا المعرف ورمز الوصول الذي تم استلامه من تسجيل دخول فيسبوك للأعمال، يمكنك الآن استدعاء واجهة API التحويلات لإرسال أحداث المراسلة إلى Meta.
4. استرداد المعرف على مستوى Instagram (IGSID)
المعرف على مستوى Instagram IGSID
هو معرف يمثل المستخدم في المحادثات التي تتم بين المستخدم والنشاط التجاري. يتم عرض هذا المعرف عبر حدث webhook للرسائل ويتم استخدامه في API الإرسال/الاستلام. يتم استخدام هذا أيضًا في واجهة API التحويلات عند إرسال أحداث تحويل تم تعيينها إلى مستخدم معين (IGSID
) (راجع القسم التالي لمزيد من التفاصيل).
تأكد من وجود IGSID
لحساب Instagram الذي تريد الإبلاغ عن الأحداث الخاصة بها.
في المرحلة النهائية من الدمج، يمكنك الآن إرسال الأحداث عبر واجهة API التحويلات مع جميع المعلومات (dataset_id
، رمز الوصول، instagram_user_id
، IGSID
) التي تم الحصول عليها في الخطوات السابقة.
خلال فترة الحملة، وبما أن الأحداث تقع في الوقت الفعلي، أبلغ Meta بهذه الأحداث عبر واجهة API التحويلات باستخدام dataset_id
ورمز الوصول. أرسل طلب POST
إلى API هذه:
https://graph.facebook.com/v16.0/{DATASET_ID}/events?access_token={TOKEN}
فيما يلي عينة من استدعاء API لحدث شراء واحد.
{ "data": [ { "event_name": "Purchase", "event_time": 1675999999, "action_source": "business_messaging", "messaging_channel": "instagram", "user_data": { "instagram_business_account_id": <instagram_business_account_id>, "ig_sid": <IGSID> }, "custom_data": { "currency": "USD", "value": 123 } } ], "partner_agent": "<PARTNER_NAME>" }
بعد إرسال حدث إلى Meta عبر واجهة API التحويلات بنجاح، يجب أن تكون قادرًا على رؤية هذا الحدث المعروض في مدير الأحداث لمجموعة البيانات المحددة. يمكنك معرفة المزيد حول مدير الأحداث واستخدامه هنا.
ملاحظة: إذا كنت شريكًا، فستحتاج إلى توجيه المعلن حول كيفية الوصول إلى مجموعة البيانات الخاصة به في مدير الأحداث للتحقق من استلام الأحداث.
ما نوع أحداث المراسلة التي تدعمها واجهة API التحويلات لمراسلة الأعمال؟
ج: تدعم واجهة API التحويلات لمراسلات الأعمال الآن أنواع الأحداث التالية بالنسبة لمراسلات الأعمال:
يرجى ملاحظة أن أحداث المراسلة يجب أن تمثل فقط تفاعلات العملاء التي تحدث في سلسلة الرسائل، وليس التحويلات التي تحدث في القنوات الأخرى مثل مواقع الويب. يمكنك تمييز الأحداث بسهولة عن طريق اختيار مصدر الإجراء المقابل أثناء عملية الدمج
هل هناك إرشادات من Meta تنص على استخدام التطبيق نفسه أو استخدام تطبيقات مختلفة لعمليات دمج واجهة API التحويلات المختلفة؟
ج: من ضمن أفضل الممارسات أن يستخدم الشريك تطبيقًا واحدًا، حتى تتمكن Meta من التعرف على جميع الأحداث المرسلة من جانب الشريك. إذا كنت شريكًا ولديك بالفعل تطبيقات متعددة، فتأكد من تعيين partner_agent على اسم وكيل الشريك الذي تم تعيينه لك. تحدث مع ممثل Meta إذا كنت غير متأكد.
إذا حدث تحويل خارج سلسلة الرسائل (على موقع الويب أو التطبيق، على سبيل المثال)، فكيف يمكننا إرسال الأحداث إلى Meta؟
ج: إذا حدث تحويل خارج سلسلة الرسائل، فيجب إعادة إرسال هذا الحدث إلى Meta باستخدام منتج واجهة API التحويلات ذي الصلة. على سبيل المثال، إذا حدث تحويل على موقعك على الويب، فاستخدم واجهة API التحويلات للويب. إذا حدث التحويل على تطبيقك، فاستخدم واجهة API التحويلات لأحداث التطبيق. وسيظل الحدث منسوبًا إلى معرف النقر في واجهة API التحويلات للويب. يمكن العثور على قائمة كاملة بالمعلمات هنا.
هل تعمل واجهة API التحويلات على تمكين تحسين إعلانات النقر للمراسلة؟
ج: تتيح واجهة API التحويلات الوصول إلى تحسين الشراء لإعلانات النقر لفتح محادثة في Messenger وإعلانات النقر لفتح محادثة في واتساب فقط، ولكنها غير متوفرة لتحسين الإعلانات على Instagram في الوقت الحالي. بالنسبة لإعلانات النقر لفتح محادثة في Instagram، يمكنك تحسين حملاتك الإعلانية للحصول على المزيد من المحادثات.
هل يمكنني إعادة استخدام مجموعة البيانات الحالية في واجهة API التحويلات لمراسلة الأعمال؟
ج: نعم، ندعم الربط مع مجموعة البيانات الحالية، يمكنك الرجوع إلى الخيارات المتوفرة لتحديد الخيار المناسب لنشاطك التجاري.
إذا كنت أستخدم واجهة API التحويلات لموقع الويب حاليًا، فهل تتداخل إضافة مراسلات الأعمال إلى الدمج نفسه مع الدمج الحالي لدي؟
ج: لا يوجد أي خطر من إضافة رسائل الأعمال إلى دمج واجهة API التحويلات الحالي لديك. يعتمد الإسناد على معرف الصفحة/مجموعة البيانات ولا يرتبط بمعرف التطبيق.
كم عدد مجموعات البيانات التي يمكن ربطها بالصفحة؟
ج: يمكنك ربط مجموعة بيانات واحدة فقط بالصفحة.
هل أحتاج إلى إلغاء تكرار الأحداث قبل إرسالها عبر واجهة API التحويلات لمراسلة الأعمال؟
ج: لا تساعد Meta في إلغاء تكرار الأحداث في واجهة API التحويلات لمراسلة الأعمال، لذا نشجع المعلنين بشدة على إلغاء تكرار البيانات قبل إرسالها عبر واجهة API تحويلات لمراسلة الأعمال.