Referencia del evento de webhook messages

Esta devolución de llamada se producirá cuando se envíe un mensaje a tu página. Los mensajes siempre se envían en orden. Puedes recibir mensajes de texto o mensajes con archivos adjuntos.

Los principales tipos de adjuntos admitidos son image, audio, video, file, reel y ig_reel. También es posible que recibas archivos adjuntos de fallback. Un ejemplo común de este tipo de archivo adjunto se da cuando un usuario comparte una URL con una página y se crea un archivo adjunto en función del uso compartido del enlace. Cuando los usuarios comparten elementos no admitidos con tu página, es posible que se envíe un archivo adjunto de fallback sin carga.

Para suscribirte a esta devolución de llamada, selecciona el campo message durante la configuración de tu webhook.

Ejemplos

Mensaje de texto

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "quick_reply": {
      "payload": "<DEVELOPER_DEFINED_PAYLOAD>"
    }
  }
}    

Mensaje de respuesta

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"m_1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "reply_to": {
      "mid":"m_1fTq8oLumEyIp3Q2MR-aY7IfLZDamVrALniheU"
    }
  }
}    

Mensaje con adjunto

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Mensaje con plantilla de producto

El webhook de mensaje con plantilla de producto solo está disponible en la versión 8.0 y versiones posteriores de la API Graph.

Este webhook se aplica a una situación en la que el usuario comparte productos de otros hilos o cuando se comparte un proceso con la página. Este webhook está limitado solo a los productos que son propiedad de la página. La app deberá tener el permiso catalog_management aprobado para recibir detalles del producto en los webhooks.

{
  "id": "682498302938465",
  "time": 1518479195594,
  "messaging": [
    {
      "sender": {
        "id": "

Mensaje con archivo adjunto de "fallback"

Ejemplo aplicable a messages en las versiones 6.0 y posteriores

{
    "object": "page",
    "entry": [
        {
            "id": "<PAGE_ID>",
            "time": 1583173667623,
            "messaging": [
                {
                    "sender": {
                        "id": "<PSID>"
                    },
                    "recipient": {
                        "id": "<PAGE_ID>"
                    },
                    "timestamp": 1583173666767,
                    "message": {
                        "mid": "m_toDnmD...",
                        "text": "This is where I want to go: https:\/\/youtu.be\/bbo_fZAjIhg",
                        "attachments": [
                            {
                                "type": "fallback",
                                "payload": {
                                    "url": "<ATTACHMENT_URL >",
                                    "title": "TAHITI - Heaven on Earth"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    ]
}

Mensaje de la página de detalles del producto de las tiendas

El webhook de mensaje de la página de detalles del producto de las tiendas solo está disponible en la versión 8.0 y posteriores de la API Graph.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "product": {
        "id":"<PRODUCT_ID>"
      }
    }
  }
}    

Mensaje con información de referencia de anuncios

Este webhook se aplica al caso en que un usuario hace clic en un anuncio de CTM (clic a Messenger) y envía un mensaje a una página de Facebook. Además de los detalles del mensaje incluidos, la aplicación recibirá información de referencia de anuncios.

Un mensaje con información de referencia de anuncios requiere que la app tenga suscripciones a páginas en los campos messages y messaging_referrals.

{
  "sender":{
    "id":"<PSID>"
  },
  "recipient":{
    "id":"<PAGE_ID>"
  },
  "timestamp":1458692752478,
  "message":{
    "mid":"mid.1457764197618:41d102a3e1ae206a38",
    "text":"hello, world!",
    "referral": {
      "ref": "<REF_DATA_IF_SPECIFIED_IN_THE_AD>",
      "ad_id": "<ID_OF_THE_AD>",
      "source": "ADS",
      "type": "OPEN_THREAD",
      "ads_context_data": {
        "ad_title": "<TITLE_OF_THE_AD>",
        "photo_url": "<URL_OF_THE_IMAGE_FROM_AD_THE_USER_IS_INTERESTED_IN>",
        "video_url": "<THUMBNAIL_URL_OF_THE_VIDEO_FROM_THE_AD>",
        "post_id": "<ID_OF_THE_POST>",
        "product_id": "<PRODUCT_ID>"
      }
    }
  }
}

Mensajes con comandos

{
  "object": "page",
  "entry": [
    {
      "id": "<PAGE_ID>",
      "time": 1697643211842,
      "messaging": [
        {
          "sender": {
            "id": "<PSID>"
          },
          "recipient": {
            "id": "<PAGE_ID>"
          },
          "timestamp": 1697643027400,
          "message": {
            "mid": "m_3vs...",
            "text": "find flights from SFO to LAX next Thursday",
            "commands": [
              {
                "name": "flights"
              }
            ]
          }
        }
      ]
    }
  ]
}

Propiedades

sender

PropiedadTipoDescripción

id

Cadena

El PSID del usuario que activó el evento de webhook.

user_ref

Cadena

La user_ref del usuario que activó el evento de webhook. Esto está disponible solamente para el evento de webhook del plugin de chat.

recipient

PropiedadTipoDescripción

id

Cadena

El identificador de la página.

message

Anuncio del 4 de marzo de 2020

En las versiones 6.0 y posteriores, sticker_id se transfirió de message a message.attachments.payload

Propiedad Tipo Descripción

mid

Cadena

El identificador del mensaje.

text

Cadena

El texto del mensaje.

quick_reply

Objeto

Datos personalizados opcionales proporcionados por la app que realiza el envío.

reply_to

Objeto

Referencia al identificador del mensaje (mid) al que responde este mensaje.

attachments

Matriz de <attachment>

La matriz que contiene datos del archivo adjunto.

referral

Objeto

La referencia del mensaje de la página de detalles del producto de las tiendas.

message.quick_reply

Solo se proporciona una carga quick_reply con un mensaje de texto cuando el usuario toca el botón Respuestas rápidas.

Propiedad Tipo Descripción

payload

Cadena

Datos personalizados opcionales proporcionados por la app.

message.reply_to

Propiedad Tipo Descripción

mid

Cadena

Referencia al identificador del mensaje al que responde este mensaje.

message.attachments

Propiedad Tipo Descripción

type

Cadena

audio, file, image, video, fallback, reel o ig_reel

payload

Cadena

message.attachments.payload

message.attachments.payload

Propiedad Tipo Descripción

url

Cadena

La URL del tipo de archivo adjunto. Aplicable al tipo de archivo adjunto: audio, file, image, video, fallback, reel, ig_reel

title

Cadena

El título del archivo adjunto. Aplicable al tipo de archivo adjunto: fallback, reel y ig_reel

sticker_id

Número

El identificador persistente de este sticker, por ejemplo 369239263222822, hace referencia al sticker de Me gusta. Aplicable al tipo de archivo adjunto image solo si se envía un sticker.

reel_video_id

Número

Identificador del video asociado al reel adjunto. Aplicable al tipo de archivo adjunto: reel y ig_reel

message.attachments.payload.product.elements

Propiedad Tipo Descripción

id

Cadena

Identificador de producto del catálogo de productos de Facebook

retailer_id

Cadena

Identificador externo asociado al producto. (p. ej.: identificador de contenido/SKU)

image_url

Cadena

La URL del producto.

title

Cadena

Título del producto

subtitle

Cadena

Subtítulo del producto

message.referral

Solo se proporciona la carga referral cuando el usuario envía un mensaje desde la página de detalles del producto de las tiendas.

Propiedad Tipo Descripción

product

Objeto

Información del producto.

source

Cadena

La fuente de la referencia. Valores admitidos: ADS (solo se admite referencia de anuncios).

type

Cadena

El tipo de referencia. Actualmente admite OPEN_THREAD.

ref

Cadena

El atributo ref opcional configurado en la referencia. Solo se admiten caracteres alfanuméricos y -, _ y =.

ad_id

Cadena

ID de anuncios del administrador de anuncios.

ads_context_data

Objeto

Datos de contexto de anuncios del administrador de anuncios.

message.referral.product

Propiedad Tipo Descripción

id

Cadena

ID del producto.

message.referral.ads_context_data

Propiedad Tipo Descripción

ad_title

Cadena

Título del anuncio en el administrador de anuncios.

photo_url

Cadena

[Opcional] URL de la imagen del anuncio.

video_url

Cadena

[Opcional] URL de miniatura del video del anuncio.

post_id

Cadena

ID de la publicación del anuncio del administrador de anuncios.

product_id

Cadena

Identificador del producto del anuncio [opcional].

message.commands

Propiedad Tipo Descripción

name

Cadena

El nombre del comando