ข้อมูลอ้างอิงเกี่ยวกับเหตุการณ์ Webhook message_echoes

การเรียกกลับนี้จะเกิดขึ้นเมื่อมีการส่งข้อความโดยเพจของคุณ คุณอาจได้รับข้อความ text หรือข้อความที่มีไฟล์แนบ (image, video, audio, template หรือ fallback) เพย์โหลดจะรวม metadata ที่กำหนดเองซึ่งเป็นทางเลือกที่ส่งโดยผู้ส่ง และ app_id ที่เกี่ยวข้อง
คุณสามารถสมัครรับข้อมูลจากการเรียกกลับนี้ได้โดยเลือกช่อง message_echoes ในขณะที่ตั้งค่า Webhook ของคุณ

ระบบรองรับข้อความหลากหลายประเภท ดังนี้

รูปแบบที่นิยมใช้

ตัวอย่างที่ 1

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}   

ตัวอย่างที่ 2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGEID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGEID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

คุณสมบัติ

sender

คุณสมบัติประเภทคำอธิบาย

id

สตริง

PSID ของผู้ใช้ที่ทริกเกอร์เหตุการณ์ Webhook

user_ref

สตริง

user_ref ของผู้ใช้ที่ทริกเกอร์เหตุการณ์ Webhook คุณสมบัตินี้ใช้งานได้สำหรับเหตุการณ์ Webhook จากปลั๊กอินแชทเท่านั้น

recipient

คุณสมบัติประเภทคำอธิบาย

id

สตริง

ID เพจของคุณ

message

ชื่อช่อง ประเภท คำอธิบาย

is_echo

บูลีน

ระบุถึงข้อความที่ส่งมาจากเพจเอง

app_id

สตริง

ID ของแอพที่ใช้ส่งข้อความ สำหรับ API กราฟตั้งแต่ v12.0 ขึ้นไป ช่อง app_id จะส่งคืน ID แอพกล่องข้อความของเพจ Facebook (26390203743090) เมื่อใดก็ตามที่ส่งข้อความผ่านทางกล่องข้อความของเพจ Facebook

metadata

สตริง

สตริงที่กำหนดเองส่งผ่านไปยัง API การส่งโดยเป็นช่อง metadata จะแสดงก็ต่อเมื่อมีการตั้งค่าคุณสมบัติ metadata ในข้อความต้นฉบับ

mid

สตริง

ID ข้อความ

ข้อความตัวอักษร

ตัวอย่าง

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}    

คุณสมบัติ

message

คุณสมบัติ ประเภท คำอธิบาย

text

สตริง

เนื้อหาตัวอักษรของข้อความ

ข้อความที่มีรูปภาพ, เสียง, วิดีโอ หรือไฟล์แนบ

ตัวอย่าง

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}    

คุณสมบัติ

message.attachments

คุณสมบัติ ประเภท คำอธิบาย

type

สตริง

ประเภทของไฟล์แนบ: image, audio, video หรือ file

payload.url

สตริง

URL ของไฟล์แนบ

ข้อความที่มีไฟล์แนบเทมเพลต

ตัวอย่าง

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}    

คุณสมบัติ

message.attachments

คุณสมบัติ ประเภท คำอธิบาย

type

สตริง

template

payload

สตริง

เพย์โหลดเทมเพลตตามที่อธิบายไว้ในข้อมูลอ้างอิงเกี่ยวกับ API การส่ง

โปรดทราบว่าในกรณีที่เป็น payload ที่มีไฟล์แนบ ID ของไฟล์แนบที่ส่งจะเป็นตัวเลข ไม่ใช่สตริง โปรดดูตัวอย่างที่ 2

ซึ่งไม่ตรงกับรูปแบบของ API การส่งที่ต้องมี ID ของไฟล์แนบที่จะส่งในรูปของสตริง

ข้อความที่มีไฟล์แนบสำรอง

ไฟล์แนบสำรองคือไฟล์แนบใดๆ ก็ตามที่ฟีเจอร์ Message Echo ไม่รู้จักหรือไม่รองรับในขณะนี้

ตัวอย่าง

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}    

คุณสมบัติ

message.attachments

คุณสมบัติ ประเภท คำอธิบาย

type

สตริง

fallback

title

สตริง

ชื่อไฟล์แนบ (ระบุหรือไม่ก็ได้)

url

สตริง

URL ของไฟล์แนบ (ระบุหรือไม่ก็ได้)

payload

สตริง

เพย์โหลดของไฟล์แนบ (ระบุหรือไม่ก็ได้)

ข้อความที่มีสินค้า

Echo Webhook ข้อความที่มีสินค้าสามารถใช้งานได้ใน API กราฟเวอร์ชั่น 8.0 ขึ้นไปเท่านั้น

แอพจะต้องมีสิทธิ์การอนุญาต catalog_management ที่ผ่านการอนุมัติให้รับรายละเอียดสินค้าใน Webhooks ได้

ตัวอย่าง

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}     

คุณสมบัติ

product.elements

คุณสมบัติ ประเภท คำอธิบาย

id

สตริง

ID สินค้าจากแค็ตตาล็อกสินค้า

retailer_id

สตริง

ID ภายนอกที่เชื่อมโยงกับสินค้า (ตัวอย่าง: SKU/ID เนื้อหา)

image_url

สตริง

URL ของรูปภาพสินค้า

title

สตริง

ชื่อของสินค้า

subtitle

สตริง

ชื่อรองของสินค้า