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

# Sessões

> Ciclo de vida: criar, parear, parar, reiniciar, desvincular, excluir.

Uma sessão = um número de WhatsApp. O nome aceita letras, números, `_` e `-` (até 64).

## Status

| Status | Significado |
| - | - |
| `STARTING` | conectando |
| `SCAN_QR_CODE` | espera o QR (ou o código por telefone) |
| `WORKING` | conectada e pronta |
| `STOPPED` | parada por você; `start` volta sem QR |
| `FAILED` | erro de conexão; o serviço tenta de novo |

## Ações

| Ação | Rota |
| - | - |
| Criar | `POST /api/sessions {"name","config","start"}` (`422` se já existe) |
| Listar / ler | `GET /api/sessions`, `GET /api/sessions/{nome}` |
| Trocar config (webhooks) | `PUT /api/sessions/{nome} {"config":{...}}` (substitui a config toda) |
| Iniciar / reiniciar | `POST /api/sessions/{nome}/start`, `/restart` |
| Parar (mantém o pareamento) | `POST /api/sessions/{nome}/stop` |
| Desvincular o aparelho | `POST /api/sessions/{nome}/logout` (volta ao QR) |
| Excluir | `DELETE /api/sessions/{nome}` (apaga mensagens e chaves) |

## Parear

* **QR:** `GET /api/{nome}/auth/qr?format=image` devolve `{"mimetype":"image/png","data":"<base64>"}`. Com `Accept: image/png` devolve o PNG cru.
* **Código por telefone:** `POST /api/{nome}/auth/request-code {"phoneNumber":"5511999990000"}` devolve `{"code":"ABCD-1234"}`; digite no celular.

Sessões não paradas voltam sozinhas quando o serviço reinicia.


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