API Oficial Botão Quick Reply

🧩 A API de botões Quick Reply permite o envio de mensagens interativas com até 3 botões, estando com a Janela de Atendimento ao Cliente aberta, oferecendo aos a possibilidade de escolher entre opções definidas previamente pelo remetente. A escolha do usuário é enviada como uma mensagem de texto.

API: Oficial

Verifique aqui os Pré-Requisitos para utilizar APIs

Endpoint

https://{BACKEND_URL}/api/messages/sendInteractive

Método

POST

Autenticação

Bearer {seutokenaqui}

Payload

{
    "number": "",
    "type": "button",
    "header": {
      "type": "document",
      "document": {
        "link": "https://livraria-camara-leg.usrfiles.com/ugd/5ca0e9_77426ca451ec4f60b14af67f925f038e.pdf",
        "filename": "catalogo-produtos-2024.pdf"
      }
    },
    "body": {
      "text": "Confira nosso catálogo completo com todos os produtos disponíveis e escolha o que mais combina com você!"
    },
    "footer": { 
        "text": "Rodapé opcional" 
    },
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "fazer_pedido",
          "title": "Fazer Pedido"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "falar_vendedor",
          "title": "Falar com Vendedor"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "cancelar_mensagens",
          "title": "Cancelar Mensagens"
        }
      }
    ]
}

➡️ “number“: telefone do destinatário no formato ddi ddd numero (somente números).

➡️ “type“: button

➡️ “header” (opcional): pode ser text, image, video ou document 💬 exemplo texto“header”: { “type”: “text”, “text”: “Meu cabeçalho Opcional”} 📸 exemplo imagem“header”: { “type”: “image”, “image”: { “link”: “https://s3.typebot.io/public/workspaces/clozv34id002ljx0fpagmqor4/typebots/clozv9d7f0004l50go6cgxv4u/blocks/undv5w2a81os520srvrb4tp5?v=1701958989883” }} 🎵 exemplo áudio// a Meta não tem suporte a Áudio no cabeçalho 🎥 exemplo vídeo“header”: { “type”: “video”, “video”: { “link”: “https://video-previews.elements.envatousercontent.com/h264-video-previews/7ab0b4d4-7df3-4125-b020-cb5903a2f66f/40313112.mp4” }} 📄 exemplo documento“header”: { “type”: “document”, “document”: { “link”: “https://livraria-camara-leg.usrfiles.com/ugd/5ca0e9_77426ca451ec4f60b14af67f925f038e.pdf”, “filename”: “livro.pdf” }} ➡️ “body“:– text: digite sua mensagem (máximo de 1024 caracteres) ➡️ “footer“:– text: rodapé opcional ➡️ “buttons“:– type: reply– reply:–> id: defina um id–> title: texto do botão (máximo de 20 caracteres) ##### 📌 Opcional repetir até 3 botões

API Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{BACKEND_URL}/api/messages/sendInteractive',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "number": "",
    "type": "button",
    "header": {
      "type": "document",
      "document": {
        "link": "https://livraria-camara-leg.usrfiles.com/ugd/5ca0e9_77426ca451ec4f60b14af67f925f038e.pdf",
        "filename": "catalogo-produtos-2024.pdf"
      }
    },
    "body": {
      "text": "Confira nosso catálogo completo com todos os produtos disponíveis e escolha o que mais combina com você!"
    },
    "footer": { 
        "text": "Rodapé opcional" 
    },
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "fazer_pedido",
          "title": "Fazer Pedido"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "falar_vendedor",
          "title": "Falar com Vendedor"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "cancelar_mensagens",
          "title": "Cancelar Mensagens"
        }
      }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;