Referência do modelo genérico

Com o modelo genérico, é possível enviar uma mensagem estruturada que inclui imagem, texto e botões. Um modelo genérico com vários modelos descritos na matriz de elements envia um carrossel de itens com rolagem horizontal em que cada item é constituído por uma imagem, texto e botões. Para obter todos os detalhes sobre a implementação, consulte Modelo genérico.

Solicitar URI

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

Exemplo de solicitação

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>"

Exemplo de resposta

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

Propriedades

`recipient`

Descrição do destinatário da mensagem. Todas as solicitações devem incluir id, phone_number ou user_ref.

Propriedade	Tipo	Descrição
`recipient.id`	Cadeia de caracteres	`PSID`, `phone_number` ou `user_ref` do destinatário da mensagem.
`recipient.phone_number`	Cadeia de caracteres	*Opcional.* Número de telefone do destinatário no formato +1(212)555-2368. Seu bot deve ser aprovado para correspondência de clientes para enviar mensagens dessa maneira.
`recipient.user_ref`	Cadeia de caracteres	*Opcional.*`user_ref` do plugin da caixa de seleção.
`recipient.name`	Objeto	*Opcional.* Usado somente se `phone_number` for definido. Define o nome da pessoa no formato: `{"first_name":"John", "last_name":"Doe"}` O fornecimento de um nome aumenta as chances de uma correspondência bem-sucedida.

`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` do modelo.

`message.attachment.payload`

Nome da propriedade	Tipo	Descrição
`template_type`	String	O valor deve ser `generic`.
`elements`	Matriz de <`element`>	Uma matriz com 1 objeto element que descreve a mídia na mensagem. Há compatibilidade com, no máximo, 1 elemento.
`sharable`	Booliano	*Opcional.* Defina como `true` se quiser habilitar o botão de compartilhamento nativo no Messenger para a mensagem de modelo. O padrão é `false`.

`message.attachment.payload.elements`

O modelo genérico é compatível com, no máximo, 10 elementos por mensagem. Além de title, é necessário definir pelo menos mais uma propriedade.

Nome da propriedade	Tipo	Descrição
`title`	String	O título que será exibido no modelo. Limite de 80 caracteres.
`subtitle`	String	*Opcional.* O subtítulo que será exibido no modelo. Limite de 80 caracteres.
`image_url`	String	*Opcional.* A URL da imagem que será exibida no modelo.
`default_action`	Objeto	*Opcional.* A ação-padrão executada quando o usuário toca no modelo. Aceita as mesmas propriedades que o botão de URL, exceto `title`.
`buttons`	Matriz <`button`>	*Opcional.* Uma matriz de botões a ser anexada ao modelo. Há suporte para, no máximo, 3 botões por elemento.