Skip to main content
POST
/
messages
/
menu-list
curl -X POST https://zapclass.com.br/api/messages/menu-list \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP" \
  -d '{
    "number": "5511999999999",
    "title": "Confira nosso catálogo completo de produtos",
    "choices": [
      "[Eletrônicos]",
      "iPhone 15 Pro|iphone15|Último lançamento Apple com chip A17",
      "MacBook Air M2|macbook|Notebook ultrafino e potente",
      "iPad Air|ipad|Tablet versátil para trabalho e lazer",
      "[Acessórios]",
      "AirPods Pro 2|airpods|Cancelamento de ruído ativo",
      "Magic Mouse|mouse|Mouse sem fio elegante",
      "Carregador MagSafe|magsafe|Carregamento sem fio rápido",
      "[Serviços]",
      "Garantia Estendida|garantia|Proteção adicional de 2 anos",
      "Instalação|instalacao|Configuração e setup completo"
    ],
    "button_text": "Ver Catálogo Completo",
    "description": "Preços e disponibilidade sujeitos a alteração"
  }'

{
  "success": true,
  "id": "5511999999999:1AB2C3DEFG4H56I78JKL9M",
  "chat_id": "5511999999999@s.whatsapp.net"
}
Listas interativas permitem organizar múltiplas opções em seções categorizadas, facilitando a navegação do usuário. Ideal para catálogos, menus de serviços e seleção de produtos.

​
Como Funciona

O usuário clica no botão principal, visualiza a lista organizada em seções e seleciona uma opção. A opção selecionada é enviada como resposta automática.

​
Formato das Opções

Inicia uma nova categoria na lista.Formato: "[Título da Seção]"Exemplo: "[Eletrônicos]" ou "[Acessórios]"
Item selecionável dentro de uma seção.Formato: "título|id|descrição"
  • título: Texto principal do item
  • id: Identificador único retornado ao selecionar
  • descrição: Texto secundário explicativo
Exemplo: "iPhone 15|iphone15|Último lançamento Apple"

​
Authorization

​
api_key
string
required
Chave de autenticação da sua conexão, utilizada no header Authorization como Bearer Token.
Você encontra sua API Key no botão API da sua conexão no painel ZapClass.
A chave sempre começa com o prefixo zc_.
Exemplo: zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP

​
Body Parameters

​
number
string
required
Número do destinatário no formato internacional.
Deve incluir código do país DDI + DDD + número.
Exemplo: 5511999999999
​
title
string
required
Título principal da lista exibido acima do botão.
Exemplo: Confira nosso catálogo completo
​
choices
array
required
Lista de seções e itens da lista.
Inicie seções com [Título] e adicione itens no formato título|id|descrição.
Exemplo: ["[Eletrônicos]", "iPhone 15|iphone15|Último lançamento", "[Acessórios]", "Fones Bluetooth|fones|Som de alta qualidade"]
​
description
string
Descrição exibida abaixo do título.
Exemplo: Preços sujeitos a alteração
​
button_text
string
Texto do botão que abre a lista.
Exemplo: Ver Catálogo
​
delay
integer
Atraso em milissegundos antes do envio.
Durante o atraso aparecerá “Digitando…”.
Exemplo: 1000
​
message_reply_id
string
Identificador da mensagem para responder.
Exemplo: 5511999999999:1AB2C3DEFG4H56I78JKL9M
​
message_source
string
Origem do envio da mensagem.
Normalmente usado para rastreamento da mensagem.
Exemplo: typebot
​
message_id
string
Identificador do envio da mensagem.
Combinado com o message_source pode ser usado para rastreamento.
Exemplo: 5511999999999:1AB2C3DEFG4H56I78JKL9M
​
mentions
string
Relação de números de telefone a serem mencionados na mensagem.
O números devem ser separads por vírgula.
Exemplo: 5511999999999,5511888888888
​
read
boolean
Marca a conversa como lida após o envio.
Exemplo: true
​
read_messages
boolean
Marca as últimas mensagens como lidas após o envio.
Exemplo: true
curl -X POST https://zapclass.com.br/api/messages/menu-list \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP" \
  -d '{
    "number": "5511999999999",
    "title": "Confira nosso catálogo completo de produtos",
    "choices": [
      "[Eletrônicos]",
      "iPhone 15 Pro|iphone15|Último lançamento Apple com chip A17",
      "MacBook Air M2|macbook|Notebook ultrafino e potente",
      "iPad Air|ipad|Tablet versátil para trabalho e lazer",
      "[Acessórios]",
      "AirPods Pro 2|airpods|Cancelamento de ruído ativo",
      "Magic Mouse|mouse|Mouse sem fio elegante",
      "Carregador MagSafe|magsafe|Carregamento sem fio rápido",
      "[Serviços]",
      "Garantia Estendida|garantia|Proteção adicional de 2 anos",
      "Instalação|instalacao|Configuração e setup completo"
    ],
    "button_text": "Ver Catálogo Completo",
    "description": "Preços e disponibilidade sujeitos a alteração"
  }'

{
  "success": true,
  "id": "5511999999999:1AB2C3DEFG4H56I78JKL9M",
  "chat_id": "5511999999999@s.whatsapp.net"
}