Plataforma de Messenger

Referencia de webhooks messaging_postbacks

En este documento se explica la carga útil JSON que el servidor de webhooks recibirá cuando se active un evento del webhook de postback de mensajes. Se activa un evento del webhook de postback cuando un usuario hace clic en un botón de postback, un botón “Empezar” o un elemento de un menú persistente.

Notificación de ejemplo

A continuación se incluye un ejemplo de la carga útil JSON que se enviará al 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

Identificador del mensaje.

postback.payload

Información definida en el parámetro payload de la llamada a la acción. Solo se incluye en la notificación de webhook que se envía a la aplicación que envió el mensaje al usuario.

postback.referral

Información sobre la acción que el usuario llevó a cabo para entrar en una conversación.

La información de la propiedad referral se incluye en la notificación de webhook solo cuando un usuario inicia una conversación con uno de los siguientes elementos y, a continuación, hace clic en una llamada a la acción, como un botón “Empezar”:

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

postback.referral.ref

Datos arbitrarios que se pasaron originalmente en el parámetro ref añadido al enlace m.me. Solo se admiten caracteres alfanuméricos, “-”, “_” y “=”.

postback.referral.source

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

postback.referral.type

Identificador de la referencia. En el caso de referencias procedentes de enlaces m.me, será siempre "OPEN_THREAD".

postback.title

Título de llamada a la acción en la que un usuario hizo clic.

recipient.id

Identificador de la página de Facebook.

sender.user_ref

Identificador de la referencia de un usuario que llevó a cabo una acción, como hacer clic en un botón “Empezar”, un plugin de chat o un elemento de un menú persistente, que envió un mensaje.

timestamp

Marca de tiempo Unix de la fecha en que se envió la notificación de webhook al servidor.

Más información

Documentación adicional para desarrolladores para profundizar en la comprensión de los conceptos que se mencionan en esta guía de webhooks de postbacks de mensajes.