مرجع القالب العام

يسمح لك القالب العام بإرسال رسالة ذات بنية محددة تتضمن صورة ونصًا وأزرار. سيرسل القالب العام الذي يتضمن عدة قوالب موضحة في المصفوفة elements إعلانًا دوّارًا قابلًا للتمرير أفقيًا للعناصر المكوّنة من صورة ونص وأزرار. لتفاصيل التنفيذ الكاملة، راجع القالب العام.

المحتويات

محدد URI للطلب

https://graph.facebook.com/v19.0/me/messages?access_token=<PAGE_ACCESS_TOKEN>

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

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment":{
      "type":"template",
      "payload":{
        "template_type":"generic",
        "elements":[
           {
            "title":"Welcome!",
            "image_url":"https://petersfancybrownhats.com/company_image.png",
            "subtitle":"We have the right hat for everyone.",
            "default_action": {
              "type": "web_url",
              "url": "https://petersfancybrownhats.com/view?item=103",
              "messenger_extensions": false,
              "webview_height_ratio": "tall",
              "fallback_url": "https://petersfancybrownhats.com/"
            },
            "buttons":[
              {
                "type":"web_url",
                "url":"https://petersfancybrownhats.com",
                "title":"View Website"
              },{
                "type":"postback",
                "title":"Start Chatting",
                "payload":"DEVELOPER_DEFINED_PAYLOAD"
              }              
            ]      
          }
        ]
      }
    }
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

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

{
  "recipient_id": "1254477777772919",
  "message_id": "AG5Hz2Uq7tuwNEhXfYYKj8mJEM_QPpz5jdCK48PnKAjSdjfipqxqMvK8ma6AC8fplwlqLP_5cgXIbu7I3rBN0P"
}  

الخصائص

recipient

وصف مستلم الرسالة. يجب أن تتضمن كل الطلبات واحدًا من id أو phone_number أو user_ref.

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

recipient.id

String (سلسلة)

إما PSID أو phone_number أو user_ref لمستلم الرسالة.

recipient.phone_number

String (سلسلة)

اختياري. رقم هاتف المستلم بتنسيق +1(212)555-2368.


يجب أن تتم الموافقة على البرنامج التلقائي في مطابقة العملاء لإرسال رسائل بهذه الطريقة.

recipient.user_ref

String (سلسلة)

اختياري.user_refمن المكون الإضافي "مربع الاختيار"

recipient.name

كائن (Object)

اختياري. يُستخدم فقط في حالة تعيين phone_number. يحدد اسم الشخص في التنسيق:


{"first_name":"John", "last_name":"Doe"}

يساعد تقديم الاسم في زيادة احتمالات حدوث مطابقة ناجحة.

message

Description of the message to be sent.
Property Type Description

message.attachment

Object

An object describing attachments to the message.

message.attachment

Property Type Description

type

String

Value must be template

payload

Object

يمثل payload للقالب.

message.attachment.payload

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

template_type

String (سلسلة)

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

elements

Array<element>

مصفوفة تحتوي على كائن عنصر واحد يصف الوسائط في الرسالة. يتم دعم عنصر واحد كحد أقصى.

sharable

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

اختياري. قم بالتعيين على true لتمكين زر "مشاركة" الأصلي في Messenger لرسالة القالب. علمًا بأنه يتم تعيين القيمة افتراضيًا على false.

message.attachment.payload.elements

يدعم القالب العام 10 عناصر لكل رسالة كحد أقصى. ويجب تعيين خاصية واحدة على الأقل، بالإضافة إلى title.

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

title

String (سلسلة)

يمثل العنوان المطلوب عرضه في القالب. علمًا بأن الحد الأقصى لعدد الأحرف هو 80 حرفًا.

subtitle

String (سلسلة)

اختياري. يمثل العنوان الفرعي المطلوب عرضه في القالب. علمًا بأن الحد الأقصى لعدد الأحرف هو 80 حرفًا.

image_url

String (سلسلة)

اختياري. يمثل عنوان URL الخاص بالصورة المطلوب عرضها في القالب.

default_action

Object (كائن)

اختياري. يمثل الإجراء الافتراضي الذي تم تنفيذه عند الضغط على القالب. ويقبل الخصائص نفسها باعتبارها زر عنوان URL، باستثناء title.

buttons

المصفوفة<button>

اختياري. يمثل مصفوفة من الأزرار المطلوب إلحاقها بالقالب. علمًا بأنه يتم دعم 3 أزرار لكل عنصر كحد أقصى.