Ler configurações

GET/v1/instances/{id}/settingsdesde M2token da instância ou admin

Quando usar

Configurações efetivas (padrões da config + overrides da instância). A senha do proxy_url vem mascarada.

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

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

Exemplo

cURL

curl -s "$LITEZAP_URL/v1/instances/$ID/settings" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

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

Python

import os
import requests

r = requests.get(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/settings",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_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("GET", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/settings", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_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('GET', '/v1/instances/inst_7f3a9c2e5b1d4086/settings', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_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

200 Configurações efetivas.

Campos de Settings

min_interval_ms	integer	Intervalo mínimo entre envios. Mínimo 1000 sem unsafe_pacing.
jitter_ms	integer	Variação aleatória somada ao intervalo.
max_per_minute	integer	Teto por minuto. Máximo 60 sem unsafe_pacing.
typing_simulation	boolean	Mostra "digitando" antes de enviar (~50ms por caractere, até 5s).
ramp	Ramp
ramp.enabled	boolean
ramp.start_per_day	integer
ramp.end_per_day	integer
ramp.days	integer
ramp.enabled	boolean
ramp.start_per_day	integer
ramp.end_per_day	integer
ramp.days	integer
send_window	SendWindow
send_window.start	string	HH:MM; vazio com end vazio = sem janela.
send_window.end	string
send_window.start	string	HH:MM; vazio com end vazio = sem janela.
send_window.end	string
timezone	string	Fuso IANA (ex.: America/Sao_Paulo); vazio = fuso do servidor.
unsafe_pacing	boolean	Remove os pisos de ritmo. Só admin.
proxy_url	string	http://, https:// ou socks5://; senha mascarada na leitura.
calls	CallSettings	Política de chamadas recebidas (marco 7).
calls.auto_reject	boolean	Rejeita toda chamada individual assim que toca (< 3s); call.received sai com rejected: true. Chamadas em grupo só são informadas.
calls.reject_message	string	Mandada ao autor de chamadas individuais rejeitadas, pela fila (ritmo, janela, rampa); no máximo uma por contato a cada 10 min; expira em 1h. Vazio: sem mensagem.
presence	PresenceSettings	Presença da própria conta (marco 7).
presence.online	boolean	Marca a conta como disponível a cada conexão: necessário para chat.presence e presence/subscribe. Enquanto ligado, o celular deixa de mostrar notificações.
groups	GroupLimits	Cotas anti-ban de grupos por instância (marco 8). Tetos sobem só com unsafe_pacing (admin).
groups.max_adds_per_hour	integer
groups.max_adds_per_day	integer
groups.max_creates_per_day	integer
groups.max_joins_per_day	integer
auto_read	AutoReadSettings	Leitura automática (marco 9).
auto_read.enabled	boolean	Marca as mensagens recebidas como lidas 2 a 5s depois, em lote por chat, no máximo uma confirmação por segundo. Com a confirmação de leitura desligada na privacidade, o contato não vê os tiques azuis.
auto_read.groups	boolean	Também em grupos.

{
  "min_interval_ms": 3000,
  "jitter_ms": 2000,
  "max_per_minute": 20,
  "typing_simulation": true,
  "ramp": {
    "enabled": true,
    "start_per_day": 50,
    "end_per_day": 150,
    "days": 14
  },
  "send_window": {
    "start": "08:00",
    "end": "20:00"
  },
  "timezone": "",
  "unsafe_pacing": false,
  "proxy_url": ""
}

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.

Equivalente na Z-API: Configurações da fila. Veja Migrar da Z-API.

Outras operações de Configurações: Alterar configurações