Messengerプラットフォーム

message_echoes Webhookイベントリファレンス

このコールバックは、メッセージをページが送信すると発生します。textメッセージまたは添付のあるメッセージ(image、video、audio、template、またはfallback)を受け取ります。ペイロードには、送信者からの任意のカスタムmetadataと、対応するapp_idも含まれます。
Webhookを設定する際にmessage_echoesフィールドを選択すると、このコールバックを登録することができます。

次の複数のメッセージのタイプがサポートされます。

一般的なフォーマット

例1

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

例2

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGEID>",
            "time": 1570053170926,
            "standby": [
                {
                    "sender": {
                        "id": "<PAGEID>"
                    },
                    "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
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

プロパティ

sender

プロパティタイプ説明

id

文字列

WebhookイベントをトリガーしたユーザーのPSID。

user_ref

文字列

Webhookイベントをトリガーしたユーザーのuser_ref。これは、チャットプラグインからのWebhookイベントでしか利用できません。

recipient

プロパティタイプ説明

id

文字列

ページのID。

message

フィールド名 型 説明

is_echo

ブーリアン

ページ自体から送信されたメッセージかどうかを示します

app_id

文字列

メッセージ送信元のアプリのID。グラフAPI v12.0以降、メッセージがFacebookページ受信箱を介して送信された場合は常に、app_idフィールドがFacebookページ受信箱アプリID (26390203743090)を返すようになります。

metadata

文字列

送信APIにmetadataフィールドとして渡されたカスタム文字列。metadataプロパティが元のメッセージに設定されている場合にのみ存在します。

mid

文字列

メッセージID

テキストメッセージ

例

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

プロパティ

message

プロパティ 型 説明

text

文字列

メッセージのテキスト

画像、音声、動画、またはファイルが添付されたメッセージ

例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "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>"
        }
      }
    ]
  }
}

プロパティ

message.attachments

プロパティ 型 説明

type

文字列

添付タイプ: image、audio、video、またはfile

payload.url

文字列

添付のURL

テンプレート添付のあるメッセージ

例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "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"
            }
          ]
        }
      }
    ]
  }
}

プロパティ

message.attachments

プロパティ 型 説明

type

文字列

template

payload

文字列

送信APIリファレンスで説明されているテンプレートペイロード

添付があるpayloadの場合は、送信される添付IDは文字列ではなく数字であることに注意してください。例2をご覧ください。

これは、添付IDを文字列で送信する必要がある、送信APIのフォーマットと異なっています。

フォールバック添付のあるメッセージ

フォールバック添付とは、メッセージエコー機能で現在認識されない、またはサポートされていない添付のことです。

例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "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
      }
    ]
  }
}

プロパティ

message.attachments

プロパティ 型 説明

type

文字列

fallback

title

文字列

添付のタイトル(任意)

url

文字列

添付のURL (任意)

payload

文字列

添付のペイロード(任意)

商品が含まれるメッセージ

商品エコーWebhook付きのメッセージは、グラフAPI v8.0以上でのみ利用できます

アプリがWebhooksで商品の詳細情報を受け取るためには、catalog_managementアクセス許可が承認されている必要があります。

例

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<USER_ID>"
  },
  "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",
               },
               {...},
             ]
            }

          ]
        }
      }
    ]
  }
}

プロパティ

product.elements

プロパティ 型 説明

id

文字列

商品カタログの商品ID

retailer_id

文字列

商品に関連付けられている外部ID。(例:SKU/コンテンツID)

image_url

文字列

商品画像のURL

title

文字列

商品のタイトル

subtitle

文字列

商品のサブタイトル