Platform Messenger

Referensi Peristiwa Webhook message_echoes

Panggilan balik ini akan terjadi ketika pesan telah dikirim oleh halaman Anda. Anda dapat menerima pesan text atau pesan dengan lampiran (image, video, audio, template, atau fallback). Payload juga akan mencakup metadata khusus opsional yang dikirimkan oleh pengirim, dan app_id yang sesuai.
Anda dapat berlangganan panggilan balik ini dengan memilih kolom message_echoes saat menyiapkan webhook.

Beberapa jenis pesan didukung:

Format Umum

Contoh 1

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    ...
  }
}

Contoh 2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGE_ID>"
                    },
                    "recipient": {
                        "id": "<PSID>"
                    },
                    "timestamp": 1570053170673,
                    "message": {
                        "mid": "qT7ywaKpO9kkQR7Gv-nM8LIfLZDamVrALniheUYEDdHJXjDXEAyaS1xxONzb2Iv-DFzmTihfWJV012P5pK0AhQ",
                        "is_echo": true,
                        "app_id": <APPID>,
                        "attachments": [
                            {
                                "title": "",
                                "url": "https:\/\/www.facebook.com\/commerce\/update\/",
                                "type": "template",
                                "payload": {
                                    "template_type": "media",
                                    "elements": [
                                        {
                                            "media_type": "image",
                                            "attachment_id": 2457235337685388
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Properti

sender

Kolom senderDeskripsi

id

string

ID Halaman untuk Facebook Anda

recipient

Kolom recipientDeskripsi

id

string

ID lingkup Halaman untuk orang yang menerima pesan dari bisnis Anda

message

Nama Kolom Jenis Deskripsi

is_echo

Boolean

Menandai pesan dikirim dari halaman itu sendiri

app_id

String

ID aplikasi yang mengirim pesan. Memulai Graph API kolom v12.0+, app_id akan mengembalikan id aplikasi kotak masuk Halaman Facebook (26390203743090) setiap kali pesan dikirim melalui kotak masuk Halaman Facebook.

metadata

String

String khusus diteruskan ke Send API sebagai kolom metadata. Hanya ada jika properti metadata diatur di pesan asli.

mid

String

ID Pesan

Pesan teks

Contoh

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1457764197627,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!"
  }
}

Properti

message

Properti Jenis Deskripsi

text

String

Teks pesan

Pesan dengan gambar, audio, video, atau lampiran file

Contoh

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"image",
        "payload":{
          "url":"<IMAGE_URL>"
        }
      }
    ]
  }
}

Properti

message.attachments

Properti Jenis Deskripsi

type

String

Jenis lampiran: image, audio, video, atau file

payload.url

String

URL lampiran

Pesan dengan lampiran template

Contoh

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "template_type":"button",
          "buttons":[
            {
              "type":"web_url",
              "url":"https:\/\/www.messenger.com\/",
              "title":"Visit Messenger"
            }
          ]
        }
      }
    ]
  }
}

Properti

message.attachments

Properti Jenis Deskripsi

type

String

template

payload

String

Payload template seperti yang dijelaskan dalam Referensi Send API

Perhatikan bahwa dalam kasus payload dengan lampiran, id lampiran yang dikirim adalah angka, bukan string. Lihat contoh 2

Ini tidak cocok dengan formatSend API yang membutuhkan id lampiran untuk dikirim sebagai string.

Pesan dengan lampiran fallback

Lampiran fallback adalah lampiran apa pun yang saat ini tidak dikenali atau didukung oleh fitur Pesan Echo.

Contoh

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "title":"Legacy Attachment",
        "url":"https:\/\/www.messenger.com\/",
        "type":"fallback",
        "payload":null
      }
    ]
  }
}

Properti

message.attachments

Properti Jenis Deskripsi

type

String

fallback

title

String

Judul lampiran (opsional)

url

String

URL lampiran (opsional)

payload

String

Payload lampiran (opsional)

Pesan dengan produk

Pesan dengan webhook echo produk hanya tersedia pada Graph API v8.0+

Aplikasi harus memiliki persetujuan izin catalog_management untuk menerima detail produk di webhooks.

Contoh

{
  "sender":{
    "id":"<PAGE_ID>"
  },
  "recipient":{
    "id":"<PSID>"
  },
  "timestamp":1458696618268,
  "message":{
    "is_echo":true,
    "app_id":1517776481860111,
    "metadata": "<DEVELOPER_DEFINED_METADATA_STRING>",
    "mid":"mid.1458696618141:b4ef9d19ec21086067",
    "attachments":[
      {
        "type":"template",
        "payload":{
          "product":{
             "elements":[ // multiple elements for Hscroll
               {
                 "id":"<PRODUCT_ID>",
                 "retailer_id":"<EXTERNAL_ID>",
                 "image_url":"https://fb.cdn.com/sdsd",
                 "title":"Some product title",
                 "subtitle": "40",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}

Properti

product.elements

Properti Jenis Deskripsi

id

String

ID Produk dari katalog produk

retailer_id

String

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

image_url

String

URL gambar produk

title

String

Judul produk

subtitle

String

Subjudul produk