Plataforma de Messenger

Referencia de los webhooks messaging_postbacks

Este documento explica la carga JSON que recibirá tu servidor de webhooks cuando se active un evento de webhook de postback de mensajes. Se activa un evento de webhook de postback cuando una persona hace clic en el botón "Postback", en el botón "Empezar" o en un elemento del menú persistente.

Ejemplo de notificación

El siguiente es un ejemplo de la carga JSON que se enviará a tu servidor de webhooks.

{
  "field": "messaging_postbacks",
  "value": {
    "sender": {
      "user_ref": "USER-REF-ID"
    },
    "recipient": {
      "id": "PAGE-ID"
    },
    "timestamp": "1527459824",
    "postback": {
      "mid": "m_MESSAGE-ID",
      "title": "TITLE-FOR-THE-CTA",
      "payload": "USER-DEFINED-PAYLOAD",
      "referral": {
        "ref": "USER-DEFINED-REFERRAL-PARAM",
        "source": "SHORT-URL",
        "type": "OPEN_THREAD"
      }
    }
  }
}

Propiedades JSON

Todas las propiedades JSON de una notificación de webhook son cadenas.

PropiedadDescripción

postback.mid

El identificador del mensaje.

postback.payload

La información definida en el parámetro payload de la llamada a la acción. Dicha información solo se incluye en la notificación de webhook enviada a la app que envió el mensaje a la persona.

postback.referral

Información sobre la acción que realizó la persona para entrar en una conversación.

La información de la propiedad referral se incluye en la notificación de webhook únicamente si una persona inicia una conversación usando uno de los siguientes elementos y, luego, pulsa una llamada a la acción, como el botón "Empezar":

  • Un plugin de chat
  • Un enlace m.me
  • Un clic al anuncio de Messenger
  • Un código QR de Messenger
  • Una pantalla de bienvenida

postback.referral.ref

Los datos arbitrarios que se pasaron originalmente en el parámetro ref agregado al enlace m.me. Solo se admiten caracteres alfanuméricos, además de -, _ y =.

postback.referral.source

La URL de esta referencia. Para enlaces m.me, el valor del origen es “SHORTLINK”. El valor del origen de las referencias de anuncios de conversaciones de Messenger es "ADS".

postback.referral.type

El identificador de la referencia. Para referencias que provengan de enlaces m.me, dicho identificador siempre será "OPEN_THREAD".

postback.title

El título de la llamada a la acción (CTA) en el que hace clic una persona.

recipient.id

El identificador de tu página de Facebook.

sender.user_ref

El identificador de la referencia de una persona que realizó una acción, como hacer clic en el botón "Empezar", el plugin de chat o un elemento de menú persistente, que envió un mensaje.

timestamp

La marca de tiempo de UNIX de la fecha en que se envió la notificación de webhook a tu servidor.

Más información

Documentación adicional para desarrolladores que tiene como objetivo ayudar a mejorar la comprensión de los conceptos mencionados en esta guía sobre webhooks de postbacks de mensajes.