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

Lệnh gọi lại này sẽ diễn ra khi ai đó gửi tin nhắn đến Trang của bạn. Tin nhắn luôn được gửi theo thứ tự. Bạn có thể nhận được tin nhắn văn bản hoặc tin nhắn có file đính kèm.

Các loại file đính kèm chính được hỗ trợ bao gồm image, audio, video, file, reelig_reel. Bạn cũng có thể nhận được file đính kèm fallback. Ví dụ thường gặp về file đính kèm "fallback'' là khi người dùng chia sẻ URL với một Trang, file đính kèm sẽ được tạo dựa trên tính năng chia sẻ liên kết. Đối với những nội dung không được hỗ trợ mà người dùng chia sẻ lên Trang của bạn, hệ thống có thể gửi file đính kèm fallback không có phần tải dữ liệu.

Bạn có thể đăng ký nhận lệnh gọi lại này bằng cách chọn message khi thiết lập webhook của mình.

Ví dụ

Tin nhắn văn bản

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

Tin nhắn trả lời

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

Tin nhắn có file đính kèm

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

Tin nhắn có mẫu sản phẩm

Webhook tin nhắn có mẫu sản phẩm chỉ có trên API Đồ thị v8.0 trở lên

Webhook này áp dụng cho trường hợp khi người dùng chia sẻ sản phẩm lên trang từ chuỗi trò chuyện khác hoặc qua quy trình chia sẻ. Webhook này chỉ dành cho những sản phẩm thuộc sở hữu của trang đó. Ứng dụng sẽ cần được phê duyệt quyền catalog_management thì mới nhận được chi tiết sản phẩm trong webhook.

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

Tin nhắn có file đính kèm dự phòng

Ví dụ áp dụng cho messages trên phiên bản 6.0 trở lên

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

Tin nhắn từ trang chi tiết sản phẩm trong Cửa hàng

Webhook tin nhắn từ trang chi tiết sản phẩm trong Cửa hàng chỉ có trên API Đồ thị v8.0 trở lên

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

Tin nhắn có thông tin giới thiệu quảng cáo

Webhook này áp dụng cho trường hợp người dùng nhấp vào quảng cáo CTM (Click đến Messenger) và gửi tin nhắn đến trang Facebook. Ngoài chi tiết tin nhắn đi kèm, ứng dụng sẽ nhận được thông tin giới thiệu quảng cáo.

Tin nhắn có Thông tin giới thiệu quảng cáo yêu cầu ứng dụng phải đăng ký trang cho cả trường messages và trường 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>"
      }
    }
  }
}

Tin nhắn có chứa lệnh

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

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.

message

Thông báo ngày 04/03/2020

Đối với v6.0 trở lên, sticker_id đã được chuyển từ message sang message.attachments.payload

Thuộc tính Loại Mô tả

mid

Chuỗi

ID tin nhắn

text

Chuỗi

Nội dung tin nhắn

quick_reply

Đối tượng

Dữ liệu tùy chỉnh không bắt buộc do ứng dụng gửi cung cấp

reply_to

Đối tượng

Nội dung tham chiếu đến ID tin nhắn (mid) mà tin nhắn này đang trả lời

attachments

Mảng<attachment>

Mảng chứa dữ liệu file đính kèm

referral

Đối tượng

Thông tin tham chiếu của tin nhắn từ trang chi tiết sản phẩm trong Cửa hàng.

message.quick_reply

Phần tải dữ liệu quick_reply chỉ được cung cấp cùng tin nhắn văn bản khi người dùng nhấn vào nút Câu trả lời nhanh.

Thuộc tính Loại Mô tả

payload

Chuỗi

Dữ liệu tùy chỉnh do ứng dụng cung cấp

message.reply_to

Thuộc tính Loại Mô tả

mid

Chuỗi

Nội dung tham chiếu đến ID tin nhắn mà tin nhắn này đang trả lời

message.attachments

Thuộc tính Loại Mô tả

type

Chuỗi

audio, file, image, video, fallback, reel hoặc ig_reel

payload

Chuỗi

message.attachments.payload

message.attachments.payload

Thuộc tính Loại Mô tả

url

Chuỗi

URL của loại file đính kèm. Áp dụng cho loại file đính kèm: audio, file, image, video, fallback, reel, ig_reel

title

Chuỗi

Tên của file đính kèm. Áp dụng cho loại file đính kèm: fallback, reelig_reel

sticker_id

Số

ID cố định của nhãn dán này, ví dụ như 369239263222822 tham chiếu đến nhãn dán Thích. Áp dụng cho loại file đính kèm: chỉ image nếu gửi nhãn dán.

reel_video_id

Số

ID của video được liên kết với thước phim đính kèm. Áp dụng cho loại file đính kèm: reelig_reel

message.attachments.payload.product.elements

Thuộc tính Loại Mô tả

id

Chuỗi

ID sản phẩm trong danh mục sản phẩm trên Facebook

retailer_id

Chuỗi

ID bên ngoài được liên kết với Sản phẩm. (Ví dụ: ID nội dung/SKU)

image_url

Chuỗi

URL của sản phẩm

title

Chuỗi

Tên của sản phẩm

subtitle

Chuỗi

Tên phụ của sản phẩm

message.referral

Phần tải dữ liệu referral chỉ được cung cấp khi người dùng gửi tin nhắn từ trang chi tiết sản phẩm trong Cửa hàng.

Thuộc tính Loại Mô tả

product

Đối tượng

Thông tin sản phẩm

source

Chuỗi

Nguồn giới thiệu. Giá trị được hỗ trợ: ADS (chỉ hỗ trợ thông tin giới thiệu quảng cáo).

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ố, -, _=.

ad_id

Chuỗi

ID quảng cáo từ Trình quản lý quảng cáo.

ads_context_data

Đối tượng

Dữ liệu ngữ cảnh quảng cáo từ Trình quản lý quảng cáo.

message.referral.product

Thuộc tính Loại Mô tả

id

Chuỗi

ID sản phẩm

message.referral.ads_context_data

Thuộc tính Loại Mô tả

ad_title

Chuỗi

Tiêu đề quảng cáo trong Trình quản lý quảng cáo.

photo_url

Chuỗi

[Không bắt buộc] URL của hình ảnh trong quảng cáo.

video_url

Chuỗi

[Không bắt buộc] URL hình thu nhỏ của video trong quảng cáo.

post_id

Chuỗi

ID bài viết quảng cáo trong Trình quản lý quảng cáo.

product_id

Chuỗi

[Không bắt buộc] ID sản phẩm trong quảng cáo.

message.commands

Thuộc tính Loại Mô tả

name

Chuỗi

Tên lệnh