messaging_optins
WebhookイベントのリファレンスメッセージオプトインWebhookイベントは、利用者がマーケティングメッセージの受信をオプトインするか、「Messengerに送信」プラグインをタップするとトリガーされます。
「Messengerに送信」プラグインを使用する場合、optin.ref
パラメーターは、「Messengerに送信」プラグインのdata-ref
フィールドによって設定されます。開発者はこのフィールドを使用して、プラグインのクリックイベントをコールバックに関連付けることができます。
アプリは、以下のイベントの発生時にオプトインの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
プロパティ | 説明 |
---|---|
| Webhooks通知に含めたい追加情報 |
| テンプレートに表示されるタイトル |
| マーケティングメッセージの送信に使われる、特定のトピックとメッセージの頻度でオプトインした人を表すトークン |
DAILY, WEEKLY, MONTHLY } | 値は次のいずれかになります。
(API v16で削除) |
| メッセージ受信側のタイムゾーン |
STOP NOTIFICATIONS, RESUME NOTIFICATIONS } | このフィールドは、ユーザーがマーケティングメッセージを停止または再開する場合にのみ表示されます。 値は次のいずれかになります。
|
| 通知メッセージトークンの期限が切れる日付 |
| 値は |
REFRESHED, NOT_REFRESHED } | 値は次のいずれかになります。
|