Canal por link de convite

POST/v1/instances/{id}/channels/previewdesde M10token da instância ou admin

Quando usar

Lê um canal pelo link (https://whatsapp.com/channel/...) ou código de convite, sem segui-lo (role vem vazio).

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

Corpo (JSON)

Nome	Tipo	Descrição
inviteobrigatório	string

Exemplo

cURL

curl -s -X POST "$LITEZAP_URL/v1/instances/$ID/channels/preview" \
  -H "Authorization: Bearer $LITEZAP_TOKEN" \
  -d '{"invite":"https://whatsapp.com/channel/0029VaExemplo"}'

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/channels/preview", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "invite": "https://whatsapp.com/channel/0029VaExemplo"
  }),
});
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/channels/preview",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    json={
        "invite": "https://whatsapp.com/channel/0029VaExemplo",
    },
    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/channels/preview", strings.NewReader(`{"invite":"https://whatsapp.com/channel/0029VaExemplo"}`))
  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/channels/preview', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'json' => [
        'invite' => 'https://whatsapp.com/channel/0029VaExemplo',
    ],
    '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 Canal.

Campos de Channel

jid	string
name	string
description	string
invite_code	string
invite_link	string
subscribers	integer
verified	boolean
state	"active" | "suspended" | "geosuspended"
created_at	string
role	"owner" | "admin" | "subscriber" | "guest"	Papel do número (vazio quando lido por convite).
muted	boolean
picture_url	string

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.
forbidden	403	não	Use o token certo (admin, ou o da própria instância).
not_found	404	não	Confira o id do recurso (mensagem, chat, contato, mídia ou webhook).
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: Metadata do canal (por convite). Veja Migrar da Z-API.

Outras operações de Canais: Listar canais seguidos · Criar canal · Metadados do canal · Seguir, deixar de seguir, silenciar · Publicações do canal · Publicar no canal · Reagir a publicação