messages Webhookイベントのリファレンス

このコールバックは、メッセージがページに送信されると発生します。メッセージは、常に順番に送信されます。テキストメッセージまたは添付ファイルのあるメッセージを受け取ることができます。

image、audio、video、file、reel、ig_reelが、サポートされる主な添付ファイルのタイプです。fallback添付も受け取ることができます。「fallback」の一般的な例として、ユーザーがURLをページにシェアすると、添付がリンクのシェアに基づいて作成されます。ユーザーがサポートされていないシェアをページにした場合、ペイロードのないfallbackが送信される可能性があります。

このコールバックをサブスクリプション登録するには、Webhookの設定時にmessage選択します。

例

テキストメッセージ

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

返信メッセージ

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

添付のあるメッセージ

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

商品テンプレートを使ったメッセージ

このWebhookは、ユーザーが商品を他のスレッドや共有フローからページにシェアする場合に適用されます。このWebhookは、ページが所有している商品だけに限定されます。アプリがWebhooksで商品の詳細情報を受け取るためには、catalog_managementアクセス許可が承認されている必要があります。

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

fallback添付のメッセージ

バージョンv6.0以上のmessagesに該当する例

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

ショップの商品詳細ページからのメッセージ

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

広告リファーラル情報を含むメッセージ

このwebhookは、ユーザーがCTM(メッセージ誘導)広告をクリックし、Facebookページにメッセージを送信するシナリオに適用されます。アプリはメッセージの詳細に加えて、広告リファーラル情報を受け取ります。

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

コマンドが含まれるメッセージ

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

プロパティ

sender

recipient

message

message.quick_reply

quick_replyペイロードは、[クイック返信]ボタンをユーザーがタップしたときのテキストメッセージでのみ提供されます。

message.reply_to

message.attachments

message.attachments.payload

message.attachments.payload.product.elements

message.referral

referralペイロードは、ユーザーがメッセージをショップの商品詳細ページから送信している場合にのみ提供されます。

message.referral.product

message.referral.ads_context_data

message.commands