Pular para o conteúdo

Apagar chat

DELETE/v1/instances/{id}/chats/{jid}desde M9token da instância ou admin

Quando usar

Apaga a conversa no WhatsApp (celular e aparelhos vinculados). O log do LiteZap mantém as mensagens: o chat sai de GET /chats até chegar mensagem nova e GET /chats/{jid}/messages continua funcionando.

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

NomeTipoDescrição
idobrigatóriostringId da instância (inst_...).
jidobrigatóriostringJID do chat (...@s.whatsapp.net, ...@g.us, ...@lid) ou número com DDI. Prefira o jid devolvido por GET /chats ou check-numbers.

Query

NomeTipoDescrição
delete_media"1"1 também apaga a mídia da conversa no celular.

Exemplo

Janela do terminal
curl -s -X DELETE "$LITEZAP_URL/v1/instances/$ID/chats/$JID" \
-H "Authorization: Bearer $LITEZAP_TOKEN"

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

204 Apagado.

Erros

CódigoHTTPRetentávelO que fazer
validation_failed400nãoCorrija o corpo ou os parâmetros; a message diz o campo.
unauthorized401nãoEnvie Authorization: Bearer <token> válido.
forbidden403nãoUse o token certo (admin, ou o da própria instância).
not_found404nãoConfira o id do recurso (mensagem, chat, contato, mídia ou webhook).
instance_not_found404nãoConfira o id da instância.
app_state_not_synced409não
worker_error502simTente de novo com backoff; se persistir, veja o log do servidor.
worker_timeout504simTente de novo; a instância pode estar sobrecarregada ou reconectando.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Eventos gerados

Equivalente na Z-API: Deletar chat. Veja Migrar da Z-API.

Outras operações de Chats: Listar chats · Histórico do chat · Marcar chat como lido · Consultar chat · Arquivar, fixar, silenciar ou marcar como (não) lido