Referensi Peristiwa Webhooks messages

Panggilan balik ini akan terjadi ketika pesan telah dikirim ke Halaman Anda. Pesan selalu dikirim berurutan. Anda mungkin menerima pesan teks atau pesan dengan lampiran.

Jenis lampiran image, audio, video, file, reel, dan ig_reel adalah jenis utama yang didukung. Anda juga dapat menerima lampiran fallback. Contoh umum dari 'fallback' adalah ketika pengguna membagikan URL dengan Halaman, lampiran dibuat berdasarkan pembagian tautan. Untuk pembagian yang tidak didukung yang dilakukan oleh pengguna ke Halaman Anda, fallback tanpa muatan dapat dikirimkan.

Anda dapat berlangganan panggilan balik ini dengan memilih message saat menyiapkan Webhooks Anda.

Contoh

Pesan Teks

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

Pesan Balasan

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

Pesan dengan lampiran

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

Pesan dengan template produk

Webhooks pesan dari template produk hanya tersedia di Graph API v8.0+

Webhooks ini berlaku untuk skenario ketika pengguna membagikan produk dari utas atau alur bagikan lain ke halaman. Webhooks ini terbatas hanya pada produk yang dimiliki oleh halaman. Aplikasi harus memiliki persetujuan izin catalog_management untuk menerima detail produk di Webhooks.

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

Pesan dengan lampiran fallback

Contoh berlaku untuk messages di versi +v6.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"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Pesan dari Halaman Detail Produk di Toko

Webhooks pesan dari halaman detail produk di Toko hanya tersedia di Graph API v8.0+

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

Pesan dengan Informasi Rujukan Iklan

Webhooks ini berlaku untuk skenario ketika pengguna mengeklik iklan CTM (Klik ke Messenger) dan mengirim pesan ke halaman Facebook. Selain detail pesan yang disertakan, aplikasi akan menerima informasi rujukan iklan.

Pesan dengan Informasi Rujukan Iklan mewajibkan aplikasi berlangganan halaman ke kolom messages dan 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>"
      }
    }
  }
}

Pesan dengan perintah

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

Properti

sender

PropertiJenisDeskripsi

id

String

PSID pengguna yang memicu peristiwa webhook.

user_ref

String

User_ref dari pengguna yang memicu peristiwa webhook. Ini hanya tersedia untuk peristiwa webhook dari plugin obrolan.

recipient

PropertiJenisDeskripsi

id

String

ID Halaman Anda.

message

Pengumuman 4 Maret 2020

Untuk v6.0+ sticker_id dipindahkan dari message, ke message.attachments.payload

Properti Jenis Deskripsi

mid

String

ID Pesan

text

String

Teks pesan

quick_reply

Objek

Data khusus opsional yang disediakan oleh aplikasi pengirim

reply_to

Objek

Referensi ke ID pesan (mid) yang dibalas oleh pesan ini

attachments

Array<attachment>

Array berisi data lampiran

referral

Objek

Rujukan pesan dari halaman detail produk di Toko.

message.quick_reply

Muatan quick_reply hanya disediakan dengan pesan teks ketika pengguna mengetuk tombol Balasan Cepat.

Properti Jenis Deskripsi

payload

String

Data khusus yang disediakan oleh aplikasi

message.reply_to

Properti Jenis Deskripsi

mid

String

Referensi ke ID pesan yang dibalas oleh pesan ini

message.attachments

Properti Jenis Deskripsi

type

String

audio, file, image, video, fallback, reel atau ig_reel

payload

String

message.attachments.payload

message.attachments.payload

Properti Jenis Deskripsi

url

String

URL dari jenis lampiran. Berlaku untuk jenis lampiran: audio, file, image, video, fallback, reel, ig_reel

title

String

Judul lampiran. Berlaku untuk jenis lampiran: fallback, reel, dan ig_reel

sticker_id

Angka

Id persisten stiker ini, contoh: 369239263222822 mereferensi stiker Suka. Berlaku untuk jenis lampiran: image hanya jika stiker dikirim.

reel_video_id

Angka

ID video yang terkait dengan reel terlampir. Berlaku untuk jenis lampiran: reel dan ig_reel

message.attachments.payload.product.elements

Properti Jenis Deskripsi

id

String

ID Produk dari katalog produk Facebook

retailer_id

String

ID eksternal yang dikaitkan dengan Produk. (misalnya: SKU / ID Konten)

image_url

String

URL produk

title

String

Judul produk

subtitle

String

Subjudul produk

message.referral

Muatan referral hanya disediakan ketika pengguna mengirim pesan dari halaman detail produk di Toko.

Properti Jenis Deskripsi

product

Objek

Informasi produk

source

String

Sumber rujukan. Nilai yang didukung: ADS (hanya iklan rujukan yang didukung).

type

String

Jenis referal. Saat ini mendukung OPEN_THREAD.

ref

String

Atribut ref opsional yang diatur dalam perujuk. Hanya karakter alfanumerik serta -, _, dan = yang didukung.

ad_id

String

ID Iklan dari Pengelola Iklan.

ads_context_data

Objek

Data konteks iklan dari Pengelola Iklan.

message.referral.product

Properti Jenis Deskripsi

id

String

ID Produk

message.referral.ads_context_data

Properti Jenis Deskripsi

ad_title

String

Judul iklan di Pengelola Iklan.

photo_url

String

[Opsional] URL gambar dari iklan.

video_url

String

[Opsional] URL gambar mini video dari iklan.

post_id

String

ID postingan iklan di Pengelola Iklan.

product_id

String

[Opsional] ID Produk dari iklan.

message.commands

Properti Jenis Deskripsi

name

String

Nama perintah