messaging_optins Webhook 事件參考資料

當用戶選擇接收行銷訊息或點按「傳送到 Messenger」外掛程式時,就會觸發「選擇接收訊息 Webhook 事件」。

使用「傳送到 Messenger」外掛程式時,optin.ref 參數是由「傳送到 Messenger」外掛程式上的 data-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 - 預設值,權杖過期後,若用戶未重新選擇接收行銷訊息,則設定此值