messaging_referrals Webhooks 이벤트 참고 자료

이 콜백은 사용자에게 이미 봇과의 스레드가 있고 사용자가 다음 경로에서 이 스레드로 이동하는 경우에 발생합니다.

새로운 스레드에서 리퍼럴을 추적하는 경우 Postback 이벤트를 참조하세요.

이러한 이벤트를 수신하기 시작하려면 앱의 Webhooks 설정에서 messaging_referrals를 구독해야 합니다.

목차

m.me 링크

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
    "ref": <REF_DATA_PASSED_IN_M.ME_PARAM>,
    "source": "SHORTLINK",
    "type": "OPEN_THREAD",
  }
}

광고 리퍼럴

{
  "sender": {
    "id": "<PSID>"
  },
  "recipient": {
    "id": "<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "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>
    }
  }
}

고객 채팅 플러그인

핵심 변경 사항(2020년 5월 5일)

그래프 API v7.0 이상에서 채팅 플러그인의 messaging_referrals webhook 이벤트는 sender.id 필드를 반환하지 않고 새로운 sender.user_ref 필드를 반환합니다. 이 변경 사항은 2020년 11월 2일부터 모든 기존 그래프 API 버전에 적용됩니다.

새로운 리퍼럴 Webhook 이벤트(2020년 11월 2일부터 그래프 API v7.0 이상 및 모든 그래프 API 버전)

{
  "sender":{
    "user_ref":"<USER_REF>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

기존 리퍼럴 Webhook 이벤트(그래프 API v6.0 이하 - 2020년 11월 2일까지 제공)

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp": 1458692752478,
  "referral": {
     "ref": "<REF_DATA_PASSED_IN_CODE>",
     "source": "CUSTOMER_CHAT_PLUGIN",
     "type": "OPEN_THREAD",
     "referer_uri": "<WEBSITE_URL>"
  }
}

속성

sender

속성유형설명

id

문자열

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

user_ref

문자열

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

recipient

속성유형설명

id

문자열

페이지 ID입니다.

referral

속성유형설명

source

문자열

리퍼럴의 소스입니다. 지원되는 값은 다음과 같습니다.

  • ADS
  • SHORTLINK
  • CUSTOMER_CHAT_PLUGIN

type

문자열

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

ref

문자열

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

referer_uri

문자열

Facebook 채팅 플러그인에서 메시지가 전송된 사이트의 URI입니다.

is_guest_user

문자열

사용자가 Facebook 채팅 플러그인을 통해 접속한 게스트 사용자인지 여부를 나타내는 플래그

ads_context_data

개체

사용자가 스레드를 시작한 CTM 광고에 대한 정보를 포함하는 데이터입니다.

ads_context_data

PropertyTypeDescription

ad_title

String

Title of the Ad.

photo_url

String

[Optional] Url of the image from the Ad the user is interested.

video_url

String

[Optional] Thumbnail url of the the video from the ad.

post_id

String

ID of the post.

product_id

String

[Optional] Product ID from the Ad the user is interested.