messaging_optins Webhookイベントのリファレンス

メッセージオプトインWebhookイベントは、利用者がマーケティングメッセージの受信をオプトインするか、「Messengerに送信」プラグインをタップするとトリガーされます。

「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

enum { DAILY, WEEKLY, MONTHLY }

値は次のいずれかになります。

  • DAILY - オプトイン日から6か月間、24時間ごとに1件の通知を送信します
  • WEEKLY - オプトイン日から9か月間、週ごとに1件の通知を送信します
  • MONTHLY - オプトイン日から12か月間、月ごとに1件の通知を送信します

(API v16で削除)

notification_messages_timezone

文字列

メッセージ受信側のタイムゾーン

notification_messages_status

enum { STOP NOTIFICATIONS, RESUME NOTIFICATIONS }
このフィールドは、ユーザーがマーケティングメッセージを停止または再開する場合にのみ表示されます。

値は次のいずれかになります。

  • STOP NOTIFICATIONS - ユーザーが[これらのメッセージを停止]をクリックした
  • RESUME NOTIFICATIONS - ユーザーが[これらのメッセージを再開]をクリックした

token_expiry_timestamp

unix timestamp

通知メッセージトークンの期限が切れる日付

type

文字列

値はnotification_messagesでなければなりません

user_token_status

enum { REFRESHED, NOT_REFRESHED }

値は次のいずれかになります。

  • REFRESHED - これは、トークンが期限切れになった後、マーケティングメッセージ受信を再オプトインすることをユーザーが選んだ場合に設定されます
  • NOT_REFRESHED - トークンが期限切れになった後、マーケティングメッセージ受信を再オプトインすることをユーザーが選ばない場合に設定されるデフォルト値