Apagar instância

DELETE/v1/instances/{id}desde M1token admin

Quando usar

Faz logout (melhor esforço, até 15s, libera o aparelho no celular), para o worker e apaga a sessão, a mídia e a fila da instância. É a única saída para uma instância banned. Pode levar ~20s.

Confiabilidade e risco

Apaga sessão, mídia, fila e histórico da instância. Não há como desfazer.

Autenticação

Exige o token admin. Com um token de instância a resposta é 403 forbidden.

Parâmetros

Caminho

Nome	Tipo	Descrição
idobrigatório	string	Id da instância (inst_...).

Exemplo

cURL

curl -s -X DELETE "$LITEZAP_URL/v1/instances/$ID" \
  -H "Authorization: Bearer $LITEZAP_ADMIN_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086", {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_ADMIN_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.delete(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_ADMIN_TOKEN']}"},
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("DELETE", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_ADMIN_TOKEN"))
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('DELETE', '/v1/instances/inst_7f3a9c2e5b1d4086', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_ADMIN_TOKEN')],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

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 Apagada.

Erros

Código	HTTP	Retentável	O que fazer
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
forbidden	403	não	Use o token certo (admin, ou o da própria instância).
instance_not_found	404	não	Confira o id da instância.

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

Eventos gerados

• instance.status

Equivalente na Z-API: Apagar instância (parceiros). Veja Migrar da Z-API.

Outras operações de Instâncias: Listar instâncias · Criar instância · Consultar instância · Editar instância · Iniciar worker · Parar worker · Reiniciar worker · Desconectar número · Rotacionar token da instância