Gerenciar participantes

POST/v1/instances/{id}/groups/{jid}/participantsdesde M8token da instância ou admin

Quando usar

action: add, remove, promote ou demote (a instância precisa ser admin). Responde um resultado por participante pedido. Para add: até 10 por requisição; só pessoas com conversa no log ou confirmadas pela consulta de números (@lid sem conversa é recusado); 10 segundos entre lotes e cotas max_adds_per_hour (padrão 10) e max_adds_per_day (padrão 50) por instância, persistidas; acima, 429 rate_limited; recusado com envios suspensos (403 sending_suspended). Demais ações: até 50 por requisição.

Confiabilidade e risco

Adições: só contatos conhecidos, 10 por lote, 10s entre lotes, cotas por hora e por dia.

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_...).
jidobrigatório	string	JID do grupo ou comunidade (120363…@g.us).

Corpo (JSON)

Nome	Tipo	Descrição
actionobrigatório	"add" | "remove" | "promote" | "demote"
participantsobrigatório	string[]	(até 50 itens)

Exemplo

cURL

curl -s -X POST "$LITEZAP_URL/v1/instances/$ID/groups/$JID/participants" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"action":"promote","participants":["5511999999999"]}'

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/groups/5511999999999@s.whatsapp.net/participants", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "action": "promote",
    "participants": [
      "5511999999999"
    ]
  }),
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.post(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/groups/5511999999999@s.whatsapp.net/participants",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "action": "promote",
        "participants": ["5511999999999"],
    },
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

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

func main() {
  req, _ := http.NewRequest("POST", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/groups/5511999999999@s.whatsapp.net/participants", strings.NewReader(`{"action":"promote","participants":["5511999999999"]}`))
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  req.Header.Set("Content-Type", "application/json")
  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('POST', '/v1/instances/inst_7f3a9c2e5b1d4086/groups/5511999999999@s.whatsapp.net/participants', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'action' => 'promote',
        'participants' => ['5511999999999'],
    ],
    '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 Resultado por participante.

Campos de object

results

ParticipantResult[]

{
  "results": [
    {
      "participant": "5511999999999@s.whatsapp.net",
      "jid": "5511999999999@s.whatsapp.net",
      "status": "ok"
    },
    {
      "participant": "5511888888888@s.whatsapp.net",
      "status": "privacy_invite_required",
      "code": 403,
      "invite_code": "AbCd"
    }
  ]
}

Erros

Código	HTTP	Retentável	O que fazer
validation_failed	400	não	Corrija o corpo ou os parâmetros; a message diz o campo.
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
group_forbidden	403	não
group_not_found	404	não
instance_not_connected	409	depende	Confira o estado da instância; se logged_out, pareie de novo.
instance_banned	409	não	Número banido: apague a instância.
rate_limited	429	sim	Espere e tente de novo com backoff.
worker_error	502	sim	Tente de novo com backoff; se persistir, veja o log do servidor.

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

Eventos gerados

• group.updated

Equivalente na Z-API: Adicionar / remover participantes; promover / remover admin. Veja Migrar da Z-API.

Outras operações de Grupos: Listar grupos · Criar grupo · Metadados do grupo · Alterar grupo · Trocar foto do grupo · Remover foto do grupo · Listar pedidos de entrada · Aprovar ou rejeitar pedidos · Link de convite · Redefinir link de convite · Sair do grupo · Ver grupo pelo convite · Entrar por convite