> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zapclass.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Enviar Lista Interativa

> Enviar menu organizado em seções com itens selecionáveis

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

> **Seção**
>
> Inicia uma nova categoria na lista.
>
> **Formato:** `"[Título da Seção]"`
>
> Exemplo: `"[Eletrônicos]"` ou `"[Acessórios]"`

> **Item da Lista**
>
> 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`.&#x20;

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`

```bash cURL theme={null}
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"
  }'
```

```javascript JavaScript theme={null}
const response = await fetch("https://zapclass.com.br/api/messages/menu-list", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP",
  },
  body: JSON.stringify({
    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",
  }),
});
```

```php PHP theme={null}
<?php
$ch = curl_init('https://zapclass.com.br/api/messages/menu-list');

$payload = [
    "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"
];

curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
    'Authorization: Bearer zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);
?>
```

```json 200 theme={null}
{
  "success": true,
  "id": "5511999999999:1AB2C3DEFG4H56I78JKL9M",
  "chat_id": "5511999999999@s.whatsapp.net"
}
```

```json 400 theme={null}
{
  "success": false,
  "message": "Token de autenticação inválido"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.