ข้อมูลอ้างอิงเหตุการณ์ Webhook messaging_referrals

การเรียกกลับนี้จะเกิดขึ้นเมื่อผู้ใช้มีเธรดกับบอทอยู่แล้ว และผู้ใช้เข้ามายังเธรดนั้นจากการทำสิ่งต่อไปนี้

โปรดดูการติดตามการอ้างอิงในเธรดใหม่ๆ ที่เหตุการณ์โพสต์ย้อนกลับ

หากต้องการเริ่มรับเหตุการณ์เหล่านี้ คุณจำเป็นต้องสมัครรับข้อมูล messaging_referrals ในการตั้งค่า Webhook สำหรับแอพของคุณ

เนื้อหา

ตัวอย่าง

ลิงก์ m.me

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

การอ้างอิงโฆษณา

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "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>
    }
  }
}

ปลั๊กอินแชทของลูกค้า

การเปลี่ยนแปลงที่มีผลต่อการทำงาน (5 พฤษภาคม 2020)

เหตุการณ์ Webhook messaging_referrals ของ API กราฟเวอร์ชั่น 7.0 ขึ้นไปจากปลั๊กอินการแชทจะไม่ส่งคืนช่อง sender.id แต่จะส่งคืนช่อง sender.user_ref ใหม่ ตั้งแต่วันที่ 2 พ.ย. 2020 เป็นต้นไป การเปลี่ยนแปลงนี้จะส่งผลกับ API กราฟเวอร์ชั่นก่อนหน้าทั้งหมด

เหตุการณ์ Webhook การอ้างอิงแบบใหม่ (API กราฟเวอร์ชั่น 7.0 ขึ้นไปและ API กราฟทุกเวอร์ชั่นตั้งแต่วันที่ 2 พ.ย. 2020 เป็นต้นไป)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

เหตุการณ์ Webhook การอ้างอิงแบบเก่า (API กราฟเวอร์ชั่น 6.0 ลงมา - ใช้งานได้จนถึงวันที่ 2 พ.ย. 2020)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

คุณสมบัติ

sender

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

id

สตริง

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

user_ref

สตริง

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

recipient

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

id

สตริง

ID เพจของคุณ

referral

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

source

สตริง

แหล่งที่มาของการอ้างอิงนี้ ค่าที่รองรับ ได้แก่

  • ADS
  • SHORTLINK
  • CUSTOMER_CHAT_PLUGIN

type

สตริง

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

ref

สตริง

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

referer_uri

สตริง

URI ของเว็บไซต์ที่มีการส่งข้อความในปลั๊กอินแชทของ Facebook

is_guest_user

สตริง

แฟล็กที่ระบุว่าผู้ใช้เป็นผู้ใช้ภายนอกจากปลั๊กอินแชทของ Facebook หรือไม่

ads_context_data

อ็อบเจ็กต์

ข้อมูลที่ประกอบด้วยข้อมูลต่างๆ เกี่ยวกับโฆษณา CTM ซึ่งเป็นจุดที่ผู้ใช้เริ่มต้นเธรด

ads_context_data

PropertyTypeDescription

ad_title

String

Title of the Ad.

photo_url

String

[Optional] Url of the image from the Ad the user is interested.

video_url

String

[Optional] Thumbnail url of the the video from the ad.

post_id

String

ID of the post.

product_id

String

[Optional] Product ID from the Ad the user is interested.