Sair do WhatsApp
Sai do WhatsApp e apaga a sessão: o número deixa de estar ligado à conexão (o phoneNumber dela volta a null), e um QR code novo, ou um código de pareamento, é necessário para conectar de novo. Use para conectar outro número à mesma conexão. Escopo necessário: connections:write.
Parâmetros de caminho
idstring · uuidobrigatórioIdentificador da conexão (o número).
Respostas
| Código | Erro e descrição |
|---|---|
| 200 | A sessão foi encerrada no WhatsApp e apagada: {"ok": true}. |
| 400 | FST_ERR_VALIDATIONA requisição não segue o schema da operação (por exemplo, um id que não é um UUID); message diz o que está errado. |
| 401 | Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. O corpo é {"error": "Unauthorized"}. |
| 403 | A chave não tem o escopo connections:write; a mensagem de erro cita o escopo que falta. |
| 404 | A conexão não existe ou não é de quem chama: a de outra pessoa responde exatamente como uma que não existe (Connection not found). Também quando o logout falhou e nada foi registrado (Connection not found or logout failed): tente de novo. |
| 429 | Requisições demais deste IP de origem, ou autenticações com falha demais: espere os segundos de Retry-After.Cabeçalho: Retry-After |
| 500 | Um erro inesperado durante o logout (Internal error during logout): tente de novo. |
| 503 | A instância do gateway que roda a conexão está mudando (um reinício, um failover) ou não responde: espere os segundos de Retry-After e tente de novo.Cabeçalho: Retry-After |
Detalhes
A conexão continua existindo e ocupando um dos números contratados; para apagá-la, use Excluir conexão.
Para parear de novo, conecte a conexão com POST /tenants/{id}/connections/{connId}/connect e mostre o QR code. Um pareamento novo, mesmo do mesmo número, recomeça o aquecimento dos primeiros 14 dias e torna todos os contatos destinatários novos (veja Limites de envio).
Funciona mesmo quando a organização não está em dia com o pagamento: sair só reduz o uso, então não responde 402.
Guia: Parear um número