Tài liệu tham khảo về sự kiện webhook messaging_referrals

Lệnh gọi lại này sẽ diễn ra khi người dùng đã có chuỗi trò chuyện với bot và người dùng tham gia chuỗi trò chuyện do:

Để theo dõi lượt giới thiệu trong chuỗi trò chuyện mới, hãy tham khảo Sự kiện đăng lại.

Để bắt đầu nhận các sự kiện này, bạn cần đăng ký messaging_referrals trong phần cài đặt webhook cho ứng dụng của mình.

Nội dung

Ví dụ

Liên kết 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",
  }
}

Lượt giới thiệu quảng cáo

{
  "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>
    }
  }
}

Plugin chat với khách hàng

Thay đổi quan trọng (05/05/2020)

Trên API Đồ thị phiên bản 7.0 trở lên, sự kiện webhook messaging_postback từ plugin chat sẽ không trả về trường sender.id. Sự kiện sẽ trả về trường sender.user_ref mới. Kể từ ngày 02/11/2020, thay đổi này sẽ có hiệu lực trên tất cả các phiên bản API Đồ thị cũ hơn.

Sự kiện webhook giới thiệu mới (API Đồ thị phiên bản 7.0 trở lên và mọi phiên bản API Đồ thị kể từ ngày 02/11/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>"
  }
}

Sự kiện webhook giới thiệu cũ (API Đồ thị phiên bản 6.0 trở xuống – Hoạt động cho đến ngày 02/11/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>"
  }
}

Thuộc tính

sender

Thuộc tínhLoạiMô tả

id

Chuỗi

PSID của người dùng đã kích hoạt sự kiện webhook.

user_ref

Chuỗi

user_ref của người dùng đã kích hoạt sự kiện webhook. Thuộc tính này chỉ có sẵn cho sự kiện webhook từ plugin chat.

recipient

Thuộc tínhLoạiMô tả

id

Chuỗi

ID của Trang.

referral

Thuộc tínhLoạiMô tả

source

Chuỗi

Nguồn giới thiệu. Giá trị được hỗ trợ:

  • ADS
  • SHORTLINK
  • CUSTOMER_CHAT_PLUGIN

type

Chuỗi

Loại giới thiệu. Hiện hỗ trợ OPEN_THREAD.

ref

Chuỗi

Thuộc tính ref không bắt buộc được cài đặt trong nguồn giới thiệu. Chỉ hỗ trợ các ký tự chữ và số, cũng như "-", "_" và "=".

referer_uri

Chuỗi

URI của trang web mà tin nhắn được gửi trong plugin chat trên Facebook.

is_guest_user

Chuỗi

Cờ cho biết người dùng có phải là khách truy cập từ Plugin chat trên Facebook hay không

ads_context_data

Đối tượng

Dữ liệu chứa thông tin về quảng cáo CTM mà người dùng đã bắt đầu chuỗi trò chuyện từ đó.

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.