Referencia de la plantilla genérica

La plantilla genérica te permite enviar un mensaje estructurado que incluya imagen, texto y botones. Una plantilla genérica con varias plantillas como las que se describen en la matriz elements enviará una secuencia de elementos que se pueden desplazar de manera horizontal, donde cada elemento está compuesto por una imagen, de un texto o de botones. Para obtener detalles sobre la implementación, consulta Plantilla genérica.

Índice

URI de la solicitud

https://graph.facebook.com/v19.0/me/messages?access_token=<PAGE_ACCESS_TOKEN>

Ejemplo de solicitud

curl -X POST -H "Content-Type: application/json" -d '{
  "recipient":{
    "id":"<PSID>"
  },
  "message":{
    "attachment":{
      "type":"template",
      "payload":{
        "template_type":"generic",
        "elements":[
           {
            "title":"Welcome!",
            "image_url":"https://petersfancybrownhats.com/company_image.png",
            "subtitle":"We have the right hat for everyone.",
            "default_action": {
              "type": "web_url",
              "url": "https://petersfancybrownhats.com/view?item=103",
              "messenger_extensions": false,
              "webview_height_ratio": "tall",
              "fallback_url": "https://petersfancybrownhats.com/"
            },
            "buttons":[
              {
                "type":"web_url",
                "url":"https://petersfancybrownhats.com",
                "title":"View Website"
              },{
                "type":"postback",
                "title":"Start Chatting",
                "payload":"DEVELOPER_DEFINED_PAYLOAD"
              }              
            ]      
          }
        ]
      }
    }
  }
}' "https://graph.facebook.com/v2.6/me/messages?access_token=<PAGE_ACCESS_TOKEN>"

Ejemplo de respuesta

{
  "recipient_id": "1254477777772919",
  "message_id": "AG5Hz2Uq7tuwNEhXfYYKj8mJEM_QPpz5jdCK48PnKAjSdjfipqxqMvK8ma6AC8fplwlqLP_5cgXIbu7I3rBN0P"
}  

Propiedades

recipient

Descripción del destinatario del mensaje. Todas las solicitudes deben incluir uno de los siguientes valores: id, phone_number, o user_ref.

PropiedadTipoDescripción

recipient.id

Cadena

Ya sea PSID, phone_number o user_ref del destinatario del mensaje.

recipient.phone_number

Cadena

Opcional. Número de teléfono del destinatario con el formato +1(212)555-2368.


Para enviar mensajes de esta forma, tu bot debe estar aprobado para la segmentación por lista de clientes.

recipient.user_ref

Cadena

Opcional.user_ref del plugin de casilla de verificación.

recipient.name

Object

Opcional. Se usa solo si se configura phone_number. Especifica el nombre de la persona con el formato:


{"first_name":"John", "last_name":"Doe"}

Cuando se proporciona el nombre aumentan las probabilidades de obtener una coincidencia exitosa.

message

Description of the message to be sent.
Property Type Description

message.attachment

Object

An object describing attachments to the message.

message.attachment

Property Type Description

type

String

Value must be template

payload

Object

payload de la plantilla.

message.attachment.payload

Nombre de la propiedad Tipo Descripción

template_type

Cadena

El valor debe ser generic.

elements

Matriz <element>

Una matriz que contiene 1 objeto element que describe el contenido multimedia del mensaje. Se admite un máximo de 1 elemento.

sharable

Booleano

Opcional. Se configura como true para activar el botón "Compartir" nativo en Messenger para el mensaje de plantilla. Adopta false como valor predeterminado.

message.attachment.payload.elements

La plantilla genérica admite un máximo de 10 elementos por mensaje. Asimismo, al menos una de las propiedades debe establecerse en title.

Nombre de la propiedad Tipo Descripción

title

Cadena

El título que se mostrará en la plantilla. Límite de 80 caracteres.

subtitle

Cadena

Opcional. El subtítulo que se mostrará en la plantilla. Límite de 80 caracteres.

image_url

Cadena

Opcional. La URL de la imagen que se muestra en la plantilla.

default_action

Objeto

Opcional. La acción predeterminada que se ejecuta cuando se toca la plantilla. Acepta las mismas propiedades que el botón URL, excepto title.

buttons

Matriz <button>

Opcional. Una matriz de botones que se puede agregar a la plantilla. Se admite un máximo de 3 botones por elemento.