Messenger 플랫폼

message_echoes Webhooks 이벤트 참고 자료

페이지에서 메시지를 전송하면 이 콜백이 실행됩니다. text 메시지 또는 첨부 파일이 포함된 메시지(image, video, audio, template 또는 fallback)를 받아볼 수 있습니다. 페이로드에는 보낸 사람이 전송한 선택적 맞춤 설정 metadata와 해당하는 app_id도 포함됩니다.
Webhooks를 설정할 때 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부터 app_id 필드는 Facebook 페이지 받은 메시지함을 통해 메시지를 전송할 때마다 Facebook 페이지 받은 메시지함 앱 ID(26390203743090)를 반환합니다.

metadata

문자열

metadata 필드로 Send API에 전달된 맞춤 문자열입니다. 원본 메시지에 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

문자열

Send API 참고 자료에 설명된 템플릿 페이로드

첨부 파일이 포함된 payload의 경우, 첨부 파일 ID는 문자열이 아니라 숫자로 전송됩니다. 예시 2를 참조하세요.

이는 첨부 파일 ID를 문자열로 전송해야 하는 Send API의 형식과 일치하지 않습니다.

폴백 첨부 파일이 포함된 메시지

폴백 첨부 파일은 현재 Message Echo 기능에서 인식하거나 지원하지 않는 모든 첨부 파일입니다.

예

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

문자열

첨부 파일 페이로드(선택 사항)

제품을 포함한 메시지

제품이 포함된 메시지 에코 Webhooks는 그래프 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

문자열

제품 부제