messages Webhooks 이벤트 참고 자료

페이지로 메시지가 전송되면 이 콜백이 실행됩니다. 메시지는 항상 순서대로 전송됩니다. 문자 메시지 또는 첨부 파일이 포함된 메시지를 수신할 수 있습니다.

주로 지원되는 유형은 첨부 파일 유형 image, audio, video, file, reelig_reel입니다. fallback 첨부 파일을 수신할 수도 있습니다. '폴백'의 일반적인 예로는 사용자가 페이지에 URL을 공유할 때 링크 공유를 기반으로 첨부 파일이 생성되는 것입니다. 지원되지 않는 공유를 페이지에 수행하는 경우 페이로드가 없는 fallback이 전송될 수 있습니다.

Webhooks를 설정할 때 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": "

제품 템플릿이 포함된 메시지

제품 템플릿이 포함된 Message Webhooks는 그래프 API v8.0 이상에서만 제공됩니다.

이 Webhooks는 사용자가 다른 스레드의 제품을 공유하거나 페이지에 플로를 공유할 경우에 적용됩니다. 이 Webhooks는 페이지에서 소유한 제품으로만 제한됩니다. Webhooks에서 제품 상세 정보를 수신하려면 앱이 catalog_management 권한을 승인받아야 합니다.

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

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

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

Shops 제품 상세 정보 페이지의 메시지

Shops 제품 상세 정보 페이지의 메시지 Webhooks는 그래프 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>"
      }
    }
  }
}    

광고 리퍼럴 정보가 포함된 메시지

이 Webhooks는 사용자가 CTM(Messenger 연결) 광고를 클릭하고 Facebook 페이지에 메시지를 보내는 시나리오에 적용됩니다. 앱은 포함된 메시지 상세 정보 외에도 광고 리퍼럴 정보를 받게 됩니다.

광고 리퍼럴 정보가 포함된 메시지는 앱이 페이지에서 messagesmessaging_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>"
      }
    }
  }
}

명령이 포함된 메시지

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

속성유형설명

id

문자열

Webhook 이벤트를 트리거한 사용자의 PSID입니다.

user_ref

문자열

Webhook 이벤트를 트리거한 사용자의 user_ref입니다. 채팅 플러그인의 Webhook 이벤트에만 사용할 수 있습니다.

recipient

속성유형설명

id

문자열

페이지 ID입니다.

message

2020년 3월 4일 알림

v6.0 이상의 경우 sticker_idmessage에서 message.attachments.payload로 이동되었습니다.

속성 유형 설명

mid

문자열

메시지 ID

text

문자열

메시지의 텍스트

quick_reply

개체

데이터를 전송하는 앱에서 제공하는 선택적 맞춤 데이터

reply_to

개체

이 메시지가 답장하는 메시지 ID(mid)에 대한 참조

attachments

배열<attachment>

첨부 파일 데이터를 포함하는 배열

referral

개체

Shops 제품 상세 정보 페이지의 메시지 리퍼럴

message.quick_reply

quick_reply 페이로드는 사용자가 빠른 답장 버튼을 탭할 때 문자 메시지에만 제공됩니다.

속성 유형 설명

payload

문자열

앱에서 제공하는 맞춤 데이터

message.reply_to

속성 유형 설명

mid

문자열

이 메시지가 답장하는 메시지 ID에 대한 참조

message.attachments

속성 유형 설명

type

문자열

audio, file, image, video, fallback, reel 또는 ig_reel

payload

문자열

message.attachments.payload

message.attachments.payload

속성 유형 설명

url

문자열

첨부 파일 유형의 URL. audio, file, image, video, fallback, reel, ig_reel 첨부 파일 유형에 적용됩니다.

title

문자열

첨부 파일의 제목. fallback, reelig_reel 첨부 파일 유형에 적용됩니다.

sticker_id

번호

이 스티커의 고정 ID. 예를 들어 369239263222822는 좋아요 스티커를 참조합니다. 스티커를 전송하는 경우에만 image 첨부 파일 유형에 적용됩니다.

reel_video_id

번호

첨부된 릴스와 연결된 동영상의 ID. reelig_reel 첨부 파일 유형에 적용됩니다.

message.attachments.payload.product.elements

속성 유형 설명

id

문자열

Facebook 제품 카탈로그의 제품 ID

retailer_id

문자열

제품과 연결된 외부 ID(예: SKU/콘텐츠 ID)

image_url

문자열

제품 URL

title

문자열

제품 제목

subtitle

문자열

제품 부제

message.referral

referral 페이로드는 사용자가 Shops 제품 상세 정보 페이지에서 메시지를 전송하는 경우에만 제공됩니다.

속성 유형 설명

product

개체

제품 정보

source

문자열

리퍼럴의 소스. 지원되는 값: ADS(광고 리퍼럴만 지원함).

type

문자열

리퍼럴 유형. 현재 OPEN_THREAD를 지원합니다.

ref

문자열

리퍼러에 설정된 선택적 ref 속성. 영숫자 및 -, _, =만 지원합니다.

ad_id

문자열

광고 관리자의 광고 ID.

ads_context_data

개체

광고 관리자의 광고 컨텍스트 데이터.

message.referral.product

속성 유형 설명

id

문자열

제품 ID

message.referral.ads_context_data

속성 유형 설명

ad_title

문자열

광고 관리자의 광고 제목.

photo_url

문자열

[선택 사항] 광고 이미지의 URL.

video_url

문자열

[선택 사항] 광고 동영상의 썸네일 URL.

post_id

문자열

광고 관리자의 광고 게시물 ID.

product_id

문자열

[선택 사항] 광고의 제품 ID.

message.commands

속성 유형 설명

name

문자열

명령 이름