إصدار ‏‎Graph API‎‏

API الملف الشخصي في Messenger

الملف الشخصي لصفحتك في Messenger هو المكان الذي تقوم فيه بتعيين الخصائص التي تحدد الجوانب المختلفة لميزات منصة Messenger التالية. لمزيد من المعلومات، راجع جدول خصائص الملف الشخصي في Messenger أدناه.

تتيح لك API الملف الشخصي في Messenger تعيين الخصائص وتحديثها واستردادها وحذفها من صفحة الملف الشخصي في Messenger.

الأذونات

يلزم توفير رمز وصول الصفحة مع الإذن pages_messaging للتفاعل مع نقطة النهاية هذه.

بالنسبة للتطبيقات في وضع التطوير، ستكون إعدادات الملف الشخصي في Messenger مرئية فقط للأشخاص الذين لديهم دور في التطبيق.

محدد URI للطلب

https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>

خصائص الملف الشخصي في Messenger

يمكن تضمين الخصائص التالية في الملف الشخصي لصفحتك في Messenger. راجع الأوصاف في الجدول أدناه للتعرف على نوع كل خاصية والغرض منها.

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

get_started

Object (كائن)

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


لمزيد من المعلومات، راجع مرجع الزر "بدء الاستخدام".

greeting

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

تمثل مصفوفة من رسائل الترحيب بلغة محلية محددة لعرضها على شاشة الترحيب الخاصة بصفحتك على Messenger.


لمزيد من المعلومات، راجع مرجع نص الترحيب.

ice_breakers

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

تمثل مصفوفة تتضمن كائنًا لتشجيع التفاعل.


لمزيد من المعلومات، راجع مرجع أدوات تشجيع التفاعل.

persistent_menu

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

تمثل مصفوفة أزرار الدعوة لاتخاذ إجراء التي يمكن تمضينها في القائمة الثابتة.


لمزيد من المعلومات، راجع مرجع القائمة الثابتة.

whitelisted_domains

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

تمثل قائمة بالنطاقات التي تمت إضافتها إلى القائمة البيضاء. مطلوبة للصفحات التي تستخدم مجموعة SDK ملحقات Messenger والمكون الإضافي مربع الاختيار.


لمزيد من المعلومات، راجع مرجع إضافة النطاق إلى القائمة البيضاء.

account_linking_url

String (سلسلة)

تمثل عنوان URL لاستدعاء المصادقة. يجب استخدام بروتوكول https.


لمزيد من المعلومات، راجع مرجع عنوان URL ربط الحساب.

home_url

Object (كائن)

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


تم إيقاف الاستخدام لكل العمليات (GET وPOST وDELETE) في الإصدار 7.0 والإصدارات الأحدث.

commands

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

وسيطة اختيارية. إذا كانت متوفرة، فلا يمكن أن تكون بقيمة فارغة.


لمزيد من المعلومات، راجع مرجع الأوامر.

target_audience (تم إيقاف الاستخدام)

Object (كائن)

تمثل مجموعة من المعايير التي تحدد الجمهور الذي سيظهر له Messenger في علامة التبويب "استكشاف".


لمزيد من المعلومات، راجع مرجع إعدادات الجمهور المستهدف.

subject_to_new_eu_privacy_rules

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

تمثل تمييزًا بتنسيق boolean (قيمة منطقية) يحدد ما إذا كانت الصفحة قد تأثرت بتحديثات Messenger API في أوروبا. علمًا بأن هذه الخاصية غير متوفرة إلا لطلب GET.

استرداد الخصائص

يمكن استرداد القيمة الحالية لواحدة من خصائص الملف الشخصي في Messenger أو أكثر حسب الاسم.

معلمات الطلب

يتم تضمين المعلمات التالية في سلسلة الاستعلام الخاصة بالطلب:

المعلمةالوصف

fields (حقول)

تمثل قائمة مفصولة بفاصلة لخصائص الملف الشخصي في Messenger المطلوب استردادها.

مثال على الطلب

curl -X GET "https://graph.facebook.com/v21.0/me/messenger_profile?fields=whitelisted_domains,greeting&access_token=<PAGE_ACCESS_TOKEN>"

مثال على الاستجابة

سيتم إرجاع القيمة الحالية للخصائص المطلوبة ضمن مصفوفة data:

{
   "data": [
        {
          "whitelisted_domains": [
            "https://facebook.com/"
          ],
          "greeting": [
            {
               "locale": "default",
               "text": "Hello!"
            },
            {
               "locale": "en_US",
               "text": "Timeless apparel for the masses."
            }
         ]
      }
   ]
}

تعيين/تحديث الخصائص

يمكن تعيين القيم لواحدة من خصائص الملف الشخصي في Messenger أو أكثر. وسيتم استبدال الخصائص التي تم تعيينها في نص الطلب فقط.

مثال على الطلب

curl -X POST -H "Content-Type: application/json" -d '{
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  "<PROPERTY_NAME>": "<NEW_PROPERTY_VALUE>",
  ...
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

مثال على الاستجابة

{
    "result": "success"
}

حذف الخصائص

يمكن حذف واحدة من خصائص الملف الشخصي في Messenger أو أكثر. وسيتم حذف الخصائص المحددة ضمن مصفوفة fields فقط.

مثال على الطلب

curl -X DELETE -H "Content-Type: application/json" -d '{
  "fields": [
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    "<PROPERTY_NAME>",
    ...
  ]
}' "https://graph.facebook.com/v21.0/me/messenger_profile?access_token=<PAGE_ACCESS_TOKEN>"

مثال على الاستجابة

{
    "result": "success"
}

تقييد معدلات الاستدعاء

استدعاءات واجهة API الملف الشخصي في Messenger مقيدة إلى 10 استدعاءات واجهة API لكل فاصل زمني لمدة 10 دقائق. يتم تطبيق تقييد معدلات الاستدعاء هذا لكل صفحة.