Справка по событию Webhooks messaging_optins

Это событие Webhooks происходит, если человек дает согласие на получение маркетинговых сообщений или нажимает плагин "Отправить в Messenger".

Если используется плагин "Отправить в Messenger", параметр optin.ref задается полем data-ref в этом плагине. Разработчики могут использовать это поле, чтобы связать событие нажатия плагина с обратным звонком.

Уведомление Webhooks о согласии на получение сообщений

Ваше приложение будет получать уведомления Webhooks о согласии в следующих случаях:

  • человек соглашается получать регулярные уведомления;
  • человек дает повторное согласие, нажав кнопку Получать уведомления до истечения срока действия маркера сообщений с уведомлением;
  • человек меняет статус согласия, отказывается от получения уведомлений или возобновляет его.
{
  "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

Строка

Дополнительная информация, которую вы хотите добавить в уведомление.

title

Строка

Заголовок, отображаемый в шаблоне.

notification_messages_token

Строка

Маркер, представляющий человека, который предоставил согласие, с определенной темой и частотой сообщений. Этот маркер используется для отправки маркетинговых сообщений.

notification_messages_frequency

enum { DAILY, WEEKLY, MONTHLY }

Может иметь одно из следующих значений:

  • DAILY — 1 уведомление в 24 часа в течение 6 месяцев после предоставления согласия;
  • WEEKLY — 1 уведомление в неделю в течение 9 месяцев после предоставления согласия;
  • MONTHLY — 1 уведомление в месяц в течение 12 месяцев после предоставления согласия.

(Удалено в API версии 16.)

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 — это значение по умолчанию, которое устанавливается, когда пользователь не дает повторного согласия на получение маркетинговых сообщений по истечении срока действия маркера.