Referencia de eventos del webhook messaging_optins

Cuando un usuario activa la recepción de mensajes de marketing o toca en un plugin Enviar a Messenger, se activa un evento del webhook de activación de mensajes.

Si se usa el plugin Enviar a Messenger, el parámetro optin.ref se establece mediante el campo data-ref en el plugin correspondiente. El desarrollador puede usar este campo para asociar un evento de clic del plugin a una devolución de llamada.

Notificación del webhook de activación de mensajes

Tu aplicación recibirá una notificación del webhook de activación cuando ocurra lo siguiente:

  • Un usuario activa los mensajes.
  • Un usuario vuelve a activar los mensajes; para ello, hace clic en el botón Seguir recibiendo mensajes que se muestra antes de que caduque el identificador de mensajes de notificación.
  • Un usuario cambia el estado de activación, de modo que se detienen o reanudan las notificaciones.
{
  "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

PropiedadDescripción

payload

Cadena

Información adicional que quieres incluir en la notificación de webhooks.

title

Cadena

Título que se muestra en la plantilla.

notification_messages_token

Cadena

Identificador que representa al usuario que ha activado los mensajes, con la frecuencia de mensajes y el tema específicos, que se usa para enviar mensajes de marketing.

notification_messages_frequency

Enumeración { DAILY, WEEKLY, MONTHLY }

El valor puede ser uno de los siguientes:

  • DAILY: se envía una notificación cada periodo de 24 horas durante los seis meses posteriores a la fecha de activación.
  • WEEKLY: se envía una notificación cada semana durante los nueve meses posteriores a la fecha de activación.
  • MONTHLY: se envía una notificación cada mes durante los 12 meses posteriores a la fecha de activación.

(Se ha eliminado en la versión 16 de la API)

notification_messages_timezone

Cadena

Zona horaria del usuario que va a recibir el mensaje.

notification_messages_status

Enumeración { STOP NOTIFICATIONS, RESUME NOTIFICATIONS }
Este campo solo aparece si el usuario detiene o reanuda los mensajes de marketing.

El valor puede ser uno de los siguientes:

  • STOP NOTIFICATIONS: el usuario ha hecho clic en “Detener estos mensajes”.
  • RESUME NOTIFICATIONS: el usuario ha hecho clic en “Reanudar estos mensajes”.

token_expiry_timestamp

Marca de tiempo UNIX

Fecha de caducidad del identificador de mensajes de notificación.

type

Cadena

El valor debe ser notification_messages.

user_token_status

Enumeración { REFRESHED, NOT_REFRESHED }

El valor puede ser uno de los siguientes:

  • REFRESHED: se establece cuando el usuario elige volver a activar la recepción de mensajes de marketing una vez caducado el identificador.
  • NOT_REFRESHED: es el valor predeterminado y se establece cuando el usuario no vuelve a activar la recepción de mensajes de marketing una vez caducado el identificador.