Enviar Lista

POST /api/create-message

cURL

curl -X POST https://chatbot.menuia.com/api/create-message \
  -H "Content-Type: application/json" \
  -d '{
    "appkey": "SUA_APPKEY_AQUI",
    "authkey": "SUA_AUTHKEY_AQUI",
    "to": "[phone]",
    "message": "Confira nossos serviços disponíveis:",
    "header_title": "Menu de Serviços",
    "header_image": "https://seusite.com/banner.png",
    "footer_text": "Selecione para saber mais",
    "button_text": "Ver Opções",
    "section": [
      {
        "title": "Produtos",
        "value": [
          {
            "title": "Celulares",
            "description": "Smartphones e acessórios"
          },
          {
            "title": "Notebooks",
            "description": "Computadores portáteis"
          }
        ]
      },
      {
        "title": "Serviços",
        "value": [
          {
            "title": "Suporte Técnico",
            "description": "Atendimento 24h"
          },
          {
            "title": "Instalação",
            "description": "Configuração completa"
          }
        ]
      }
    ]
  }'

200 - Sucesso

{
  "status": 200,
  "message": "Lista enviada com sucesso."
}

Webhook relacionado: Botão / Lista

O clique/seleção dispara o evento Botão / Lista com a opção escolhida.

Descrição

Este endpoint permite enviar uma mensagem interativa com lista de opções organizadas em seções. Ideal para menus de serviços, catálogos de produtos ou qualquer situação que necessite de múltiplas escolhas organizadas.

Compatibilidade: a lista é exibida no iPhone (iOS) e no Android. Ela aparece como um card com imagem no topo e um botão que abre as opções. No WhatsApp Web mensagens interativas não são renderizadas.

Resposta da seleção: quando o usuário escolhe uma opção, o webhook Botão / Lista recebe a escolha normalmente (id e texto), e o painel exibe a opção selecionada. Por uma limitação do próprio WhatsApp, a bolha dessa resposta pode não ser exibida para quem acompanha a conversa pelo aplicativo do WhatsApp (o outro aparelho vê “atualize o WhatsApp”). Isso é apenas visual e não afeta o recebimento pelo webhook nem o acompanhamento pelo painel.

Parâmetros

appkey · string · required

Chave de aplicação.

authkey · string · required

Chave de autenticação do usuário.

to · string · required

Número de telefone no formato internacional ou ID do grupo.

message · string · required

Texto principal da mensagem que aparece antes da lista.

header_title · string

Título exibido no card da lista. Se omitido, é usado “Menu”. (opcional — personalização)

header_image · string

URL de uma imagem para o topo do card da lista. Se omitido, é usada uma imagem padrão. (opcional — personalização)

footer_text · string

Texto do rodapé da lista. (opcional — personalização)

button_text · string · required

Texto do botão que abre a lista de opções.

section · array · required

Array de seções contendo as opções da lista. Cada seção possui:

• title: Título da seção
• value: Array de itens com title e description (a description é opcional)

Suporta várias seções e um número alto de opções (testado com 24 renderizando normalmente). Para uma boa experiência, mantenha a quantidade de opções razoável.

cURL

curl -X POST https://chatbot.menuia.com/api/create-message \
  -H "Content-Type: application/json" \
  -d '{
    "appkey": "SUA_APPKEY_AQUI",
    "authkey": "SUA_AUTHKEY_AQUI",
    "to": "[phone]",
    "message": "Confira nossos serviços disponíveis:",
    "header_title": "Menu de Serviços",
    "header_image": "https://seusite.com/banner.png",
    "footer_text": "Selecione para saber mais",
    "button_text": "Ver Opções",
    "section": [
      {
        "title": "Produtos",
        "value": [
          {
            "title": "Celulares",
            "description": "Smartphones e acessórios"
          },
          {
            "title": "Notebooks",
            "description": "Computadores portáteis"
          }
        ]
      },
      {
        "title": "Serviços",
        "value": [
          {
            "title": "Suporte Técnico",
            "description": "Atendimento 24h"
          },
          {
            "title": "Instalação",
            "description": "Configuração completa"
          }
        ]
      }
    ]
  }'

200 - Sucesso

{
  "status": 200,
  "message": "Lista enviada com sucesso."
}