messaging_optins Webhook 事件參考資料

當用戶選擇接收營銷訊息或點按「傳送至 Messenger」附加程式時,就會觸發選擇接收訊息的 Webhook 事件。

使用「傳送至 Messenger」附加程式時,會由「傳送至 Messenger」附加程式的 data-ref 欄位設定 optin.ref 參數。開發人員可以使用這個欄位,以回呼關連附加程式上的點擊事件。

選擇接收訊息的 Webhook 通知

應用程式會在以下情況收到有關選擇接收訊息的 Webhook 通知:

  • 用戶選擇接收訊息
  • 用戶點擊系統在通知訊息憑證到期前所顯示的「繼續接收訊息」按鈕,以重新選擇接收訊息
  • 用戶變更其選擇接收訊息的狀態、停止接收通知或重新選擇接收通知
{
  "sender": {
    "id": "PSID",
  },
  "recipient": {
    "id": "PAGE-ID",
  },
  "timestamp": "TIMESTAMP",
  "optin": {
    "type": "notification_messages", 
    "payload": "ADDITIONAL-INFORMATION",
    "notification_messages_token": "NOTIFICATION-MESSAGES-TOKEN", 
    "notification_messages_frequency": "FREQUENCY",  
    "notification_messages_timezone": "TIMEZONE-ID",
    "token_expiry_timestamp": "TIMESTAMP",
    "user_token_status": "TOKEN-STATUS",  
    "notification_messages_status": "NOTIFICATION-STATUS",
    "title": "TITLE" 
    }
}

optin

屬性說明

payload

字串

您想在 Webhooks 通知加入的其他資訊

title

字串

範本中顯示的標題

notification_messages_token

字串

用作傳送營銷訊息、代表選擇接收訊息的用戶之憑證,其中包括特定主題和訊息頻率

notification_messages_frequency

列舉 { DAILY, WEEKLY, MONTHLY }

值可以是下列其中一項:

  • DAILY:自選擇接收之日起 6 個月內,每 24 小時傳送 1 則通知
  • WEEKLY:自選擇接收之日起 9 個月內,每週傳送 1 則通知
  • MONTHLY :自選擇接收之日起 12 個月內,每月傳送 1 則通知

(已在 API v16 中移除)

notification_messages_timezone

字串

接收訊息的用戶之時區

notification_messages_status

列舉 { STOP NOTIFICATIONS, RESUME NOTIFICATIONS }
只有當用戶停止或重新選擇接收營銷訊息時,才會展示此欄位。

值可以是下列其中一項:

  • STOP NOTIFICATIONS:用戶已點擊「停止接收這些訊息」
  • RESUME NOTIFICATIONS:用戶已點擊「恢復這些訊息」

token_expiry_timestamp

UNIX 時戳

通知訊息憑證的過期日期

type

字串

值必須為 notification_messages

user_token_status

列舉 { REFRESHED, NOT_REFRESHED }

值可以是下列其中一項:

  • REFRESHED:當用戶選擇在憑證過期後重新選擇接收營銷訊息,系統便會設定此值
  • NOT_REFRESHED:此為預設值;當用戶不選擇在憑證過期後重新接收營銷訊息,系統便會設定此值