Metadados da comunidade

GET/v1/instances/{id}/communities/{jid}desde M8token da instância ou admin

Quando usar

A comunidade (como um grupo) e seus grupos; o de avisos vem com announcement_group. Um grupo comum responde 404 group_not_found.

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

Exemplo

cURL

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

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/communities/[email protected]", {
  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/communities/[email protected]",
    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/communities/[email protected]", 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/communities/[email protected]', [
    '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 Comunidade e grupos.

Campos de object

community	Group
community.jid	string
community.name	string
community.description	string
community.owner	string
community.created_at	string
community.community	boolean	É uma comunidade.
community.parent	string	Comunidade a que o grupo pertence.
community.announcement_group	boolean	Grupo de avisos da comunidade.
community.participant_count	integer
community.lid_addressing	boolean	O grupo endereça os membros por LID.
community.suspended	boolean
community.settings	GroupSettings	Configurações de um grupo (marco 8).
community.participants	GroupParticipant[]	Só em GET /groups/{jid} e na criação.
groups	SubGroup[]

Erros

Código	HTTP	Retentável	O que fazer
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.
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.

Equivalente na Z-API: Metadata da comunidade. Veja Migrar da Z-API.

Outras operações de Comunidades: Listar comunidades · Criar comunidade · Grupos da comunidade · Vincular grupo · Desvincular grupo