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

การเรียกกลับนี้จะเกิดขึ้นเมื่อมีการส่งข้อความไปยังเพจของคุณ ระบบจะส่งข้อความตามลำดับเสมอ คุณอาจได้รับข้อความตัวอักษรหรือข้อความที่มีไฟล์แนบ

ระบบรองรับไฟล์แนบประเภท image, audio, video, file, reel และ ig_reel เป็นหลัก ทั้งนี้ คุณอาจได้รับไฟล์แนบประเภท fallback ด้วยเช่นกัน ซึ่งตัวอย่างประเภท “fallback (สำรอง)” ที่ใช้ทั่วไป คือ เมื่อผู้ใช้แชร์ URL กับเพจ ระบบจะสร้างไฟล์แนบขึ้นตามการแชร์ลิงก์ ในกรณีที่ผู้ใช้ทำการแชร์ในรูปแบบที่ไม่รองรับไปยังเพจของคุณ ระบบอาจส่ง fallback โดยไม่มีเพย์โหลด

คุณสามารถสมัครรับข้อมูลการเรียกกลับนี้ได้ โดยเลือก message เมื่อตั้งค่า Webhook ของคุณ

ตัวอย่าง

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

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

ข้อความตอบกลับ

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

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

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

ข้อความที่มีเทมเพลตสินค้า

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

Webhook นี้จะใช้ในสถานการณ์ที่ผู้ใช้แชร์สินค้าจากเธรดอื่นๆ หรือขั้นตอนการแชร์มายังเพจ ซึ่ง Webhook ดังกล่าวจะจำกัดไว้สำหรับสินค้าที่เพจเป็นเจ้าของเท่านั้น แอพจะต้องมีสิทธิ์การอนุญาต catalog_management ที่ผ่านการอนุมัติให้รับรายละเอียดสินค้าใน Webhooks ได้

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

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

ตัวอย่างใช้ได้กับ messages บนเวอร์ชั่น 6.0 ขึ้นไป

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

ข้อความจากหน้ารายละเอียดสินค้าของร้านค้า

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

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

ข้อความที่มีข้อมูลการอ้างอิงจากโฆษณา

Webhook นี้จะใช้ในสถานการณ์ที่ผู้ใช้คลิกโฆษณาแบบ CTM (คลิกไปยัง Messenger) และส่งข้อความไปยังเพจ Facebook นอกจากจะมีรายละเอียดข้อความแล้ว แอพพลิเคชั่นจะได้รับข้อมูลการอ้างอิงจากโฆษณาด้วย

ข้อความที่มีข้อมูลการอ้างอิงจากโฆษณากำหนดให้แอพพลิเคชั่นต้องสมัครรับข้อมูลเพจทั้งในช่อง messages และ messaging_referrals

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "product_id": "<PRODUCT_ID>"
      }
    }
  }
}

ข้อความที่มีคำสั่ง

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

คุณสมบัติ

sender

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

id

สตริง

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

user_ref

สตริง

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

recipient

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

id

สตริง

ID เพจของคุณ

message

ประกาศของวันที่ 4 มีนาคม 2020

สำหรับเวอร์ชั่น 6.0 ขึ้นไป sticker_id ได้ย้ายจาก message ไปยัง message.attachments.payload แล้ว

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

mid

สตริง

ID ข้อความ

text

สตริง

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

quick_reply

อ็อบเจ็กต์

ข้อมูลแบบกำหนดเองที่ระบุหรือไม่ก็ได้ ซึ่งได้มาจากแอพที่เป็นผู้ส่ง

reply_to

อ็อบเจ็กต์

การอ้างอิงถึง ID ข้อความ (mid) ที่ข้อความนี้ตอบกลับถึง

attachments

อาร์เรย์ <attachment>

อาร์เรย์ที่มีข้อมูลไฟล์แนบ

referral

อ็อบเจ็กต์

การอ้างอิงของข้อความจากหน้ารายละเอียดสินค้าของร้านค้า

message.quick_reply

จะมีการระบุเพย์โหลด quick_reply พร้อมข้อความตัวอักษรก็ต่อเมื่อผู้ใช้แตะที่ปุ่มข้อความตอบกลับด่วนเท่านั้น

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

payload

สตริง

ข้อมูลแบบกำหนดเองซึ่งได้มาจากแอพ

message.reply_to

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

mid

สตริง

การอ้างอิงถึง ID ข้อความที่ข้อความนี้ตอบกลับถึง

message.attachments

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

type

สตริง

audio, file, image, video, fallback, reel หรือ ig_reel

payload

สตริง

message.attachments.payload

message.attachments.payload

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

url

สตริง

URL ของประเภทไฟล์แนบ ใช้ได้กับไฟล์แนบประเภท audio, file, image, video, fallback, reel, ig_reel

title

สตริง

ชื่อของไฟล์แนบ ใช้ได้กับไฟล์แนบประเภท fallback, reel และ ig_reel

sticker_id

ตัวเลข

ID ถาวรของสติกเกอร์นี้ ตัวอย่างเช่น 369239263222822 หมายถึงสติกเกอร์ถูกใจ ใช้ได้กับไฟล์แนบประเภท image ในกรณีที่มีการส่งสติกเกอร์เท่านั้น

reel_video_id

ตัวเลข

ID ของวิดีโอที่เกี่ยวข้องกับคลิป Reels ที่แนบ ใช้ได้กับไฟล์แนบประเภท reel และ ig_reel

message.attachments.payload.product.elements

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

id

สตริง

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

retailer_id

สตริง

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

image_url

สตริง

URL ของสินค้า

title

สตริง

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

subtitle

สตริง

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

message.referral

จะมีการระบุเพย์โหลด referral ก็ต่อเมื่อผู้ใช้ส่งข้อความจากหน้ารายละเอียดสินค้าของร้านค้าเท่านั้น

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

product

อ็อบเจ็กต์

ข้อมูลสินค้า

source

สตริง

แหล่งที่มาของการอ้างอิงนี้ ค่าที่รองรับ: ADS (รองรับเฉพาะการอ้างอิงจากโฆษณา)

type

สตริง

ประเภทการอ้างอิง ปัจจุบันรองรับ OPEN_THREAD

ref

สตริง

แอตทริบิวต์ ref ที่จะระบุหรือไม่ก็ได้ซึ่งตั้งค่าไว้ในผู้อ้างอิง รองรับเฉพาะอักขระที่เป็นตัวอักษรและตัวเลข และ -, _ และ =

ad_id

สตริง

ID โฆษณาจากตัวจัดการโฆษณา

ads_context_data

อ็อบเจ็กต์

ข้อมูลบริบทของโฆษณาจากตัวจัดการโฆษณา

message.referral.product

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

id

สตริง

ID สินค้า

message.referral.ads_context_data

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

ad_title

สตริง

ชื่อโฆษณาในตัวจัดการโฆษณา

photo_url

สตริง

[ระบุหรือไม่ก็ได้] URL รูปภาพจากโฆษณา

video_url

สตริง

[ระบุหรือไม่ก็ได้] URL ภาพขนาดย่อของวิดีโอจากโฆษณา

post_id

สตริง

ID โพสต์โฆษณาในตัวจัดการโฆษณา

product_id

สตริง

[ระบุหรือไม่ก็ได้] ID สินค้าจากโฆษณา

message.commands

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

name

สตริง

ชื่อของคำสั่ง