Referencia de eventos del webhook messages

Esta devolución de llamada se producirá cuando se haya enviado un mensaje a tu página. Los mensajes siempre se envían en orden. Es posible que recibas mensajes de texto o mensajes con archivos adjuntos.

Los archivos adjuntos de tipo image, audio, video, file, reel e ig_reel son los tipos admitidos principales. También puedes recibir archivos adjuntos de tipo fallback. Un ejemplo habitual de un archivo adjunto de este tipo es una situación en que un usuario comparte una URL con una página y se crea un archivo adjunto basado en el uso compartido de enlaces. Si los usuarios comparten contenido con la página de un modo que no se admite, es posible que se envíe un archivo adjunto de tipo fallback sin ninguna carga útil.

Para suscribirte a esta devolución de llamada, selecciona message al configurar 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 un archivo adjunto

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

Mensaje con una plantilla de producto

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

Este webhook se aplica al escenario en el cual un usuario comparte productos de otras conversaciones o procesos de uso compartido en la página. Este webhook se limita únicamente a los productos que pertenecen a la página. La aplicación necesitará tener aprobado el permiso catalog_management para recibir los detalles del producto en los webhooks.

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

Mensaje con un archivo adjunto de tipo fallback

Ejemplo aplicable a messages para la versión 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 tiendas

El webhook de mensaje de la página de detalles del producto de tiendas solo está disponible para 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 a la situación en la que un usuario hace clic en un anuncio de clic a Messenger (CTM) 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.

Los mensajes con información de referencia de anuncios requieren que la aplicación tenga suscripciones de la página a 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>"
      }
    }
  }
}

Mensaje 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

PSID del usuario que activó el evento del webhook.

user_ref

Cadena

Valor user_ref del usuario que activó el evento del webhook. Solo está disponible para eventos del webhook del plugin de chat.

recipient

PropiedadTipoDescripción

id

Cadena

Identificador de la página.

message

Aviso del 4 de marzo de 2020

Para la versión 6.0 y posteriores, sticker_id se movió de message a message.attachments.payload.

Propiedad Tipo Descripción

mid

Cadena

Identificador del mensaje.

text

Cadena

Texto del mensaje.

quick_reply

Objeto

Datos personalizados opcionales que proporciona la aplicación que lleva a cabo el envío.

reply_to

Objeto

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

attachments

Matriz<attachment>

Matriz con datos de los archivos adjuntos.

referral

Objeto

Referencia del mensaje de la página de detalles del producto de tiendas.

message.quick_reply

Una carga útil de quick_reply solo se proporciona con un mensaje de texto cuando el usuario toca un botón de respuestas rápidas.

Propiedad Tipo Descripción

payload

Cadena

Datos personalizados que proporciona la aplicación.

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

URL del tipo de archivo adjunto. Aplicable a los archivos adjuntos de tipo audio, file, image, video, fallback, reel e ig_reel.

title

Cadena

Título del archivo adjunto. Aplicable a los archivos adjuntos de tipo fallback, reel e ig_reel.

sticker_id

Número

Identificador persistente de este sticker (por ejemplo, 369239263222822 hace referencia al sticker de Me gusta). Aplicable a los archivos adjuntos de tipo image solo si se envía un sticker.

reel_video_id

Número

Identificador del vídeo asociado al reel adjunto. Aplicable a los archivos adjuntos de tipo reel e ig_reel.

message.attachments.payload.product.elements

Propiedad Tipo Descripción

id

Cadena

Identificador del producto del catálogo de productos de Facebook.

retailer_id

Cadena

Identificador externo asociado con el producto (p. ej.: el SKU o el identificador del contenido).

image_url

Cadena

URL del producto.

title

Cadena

Título del producto.

subtitle

Cadena

Subtítulo del producto.

message.referral

La carga útil de referral solo se proporciona cuando el usuario envía un mensaje desde la página de detalles del producto de tiendas.

Propiedad Tipo Descripción

product

Objeto

Información sobre el producto.

source

Cadena

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

type

Cadena

Tipo de referencia. Actualmente admite OPEN_THREAD.

ref

Cadena

Atributo opcional ref establecido en la referencia. Solo se admiten caracteres alfanuméricos, -, _ y =.

ad_id

Cadena

Identificador del anuncio del Administrador de anuncios.

ads_context_data

Objeto

Datos de contexto del anuncio del Administrador de anuncios.

message.referral.product

Propiedad Tipo Descripción

id

Cadena

Identificador 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 la miniatura del vídeo del anuncio.

post_id

Cadena

Identificador de la publicación publicitaria en el Administrador de anuncios.

product_id

Cadena

[Opcional] Identificador del producto del anuncio.

message.commands

Propiedad Tipo Descripción

name

Cadena

Nombre del comando.