Referencia de la plantilla genérica

Con la plantilla genérica, puedes enviar un mensaje estructurado en el que se incluya una imagen, texto y botones. Una plantilla genérica con diversas plantillas descritas en la matriz elements enviará una secuencia de elementos por los que los usuarios pueden desplazarse horizontalmente. Cada secuencia se compone de una imagen, texto y botones. Para obtener toda la información sobre la implementación, consulta Plantilla genérica.

URI de solicitud

https://graph.facebook.com/v21.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

Valor correspondiente al elemento 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.


Si quieres enviar mensajes de esta forma, debe haberse aprobado tu bot para usar la función de coincidencia de clientes.

recipient.user_ref

Cadena

(Opcional) Valor user_ref del plugin “Checkbox”

recipient.name

Objeto

Opcional. Solo se utiliza si se establece la propiedad phone_number. Especifica el nombre de la persona siguiendo el formato:


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

Facilitar un nombre aumenta las probabilidades de conseguir una coincidencia.

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

Objeto payload de la plantilla.

message.attachment.payload

Nombre de la propiedad Tipo Descripción

template_type

Cadena

El valor debe ser generic.

elements

Matriz de <element>

Matriz que contiene un objeto element que describe el contenido multimedia del mensaje. Solo se admite un máximo de un elemento.

sharable

Booleano

Opcional. Se establece en 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 diez elementos por mensaje. Debe establecerse como mínimo una propiedad, además de title.

Nombre de la propiedad Tipo Descripción

title

Cadena

Título que se muestra en la plantilla. Límite de 80 caracteres.

subtitle

Cadena

Opcional. Subtítulo que se muestra en la plantilla. Límite de 80 caracteres.

image_url

Cadena

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

default_action

Objeto

Opcional. Acción predeterminada que se ejecuta cuando alguien toca la plantilla. Acepta las mismas propiedades que el botón de URL, a excepción de title.

buttons

Matriz de <button>

Opcional. Matriz de botones que se anexarán a la plantilla. Se admite un máximo de tres botones por elemento.