TokenAccount ou TokenInstance em todas as rotas. Cada chamada valida a ownership da instância.
Esta seção cobre as rotas /api/newsletter/* para criar canais, listar inscrições, obter detalhes, seguir e deixar de seguir. Canais têm JIDs terminando em @newsletter (diferente de grupos @g.us).
Endpoints
| Método | Path | Função |
|---|---|---|
| POST | /api/newsletter/create/:instance | Criar canal |
| GET | /api/newsletter/list/:instance | Listar canais inscritos |
| GET | /api/newsletter/info/:instance | Info de um canal |
| POST | /api/newsletter/join/:instance | Inscrever-se |
| DELETE | /api/newsletter/leave/:instance | Cancelar inscrição |
Identifiers aceitos
Os endpointsinfo, join e leave aceitam:
| Forma | Exemplo |
|---|---|
| JID | 120363422585881117@newsletter |
| Link completo | https://whatsapp.com/channel/120363422585881117 |
| Código apenas | 120363422585881117 |
Modelo NewsletterChannel
| Campo | Tipo | Descrição |
|---|---|---|
jid | string | <id>@newsletter |
state | string | active, suspended, geosuspended |
name | string | Nome do canal |
description | string | Pode ser vazia |
inviteLink | string? | https://whatsapp.com/channel/<id> (apenas para admins / criador) |
subscriberCount | int | Pode ser 0 se desconhecido |
pictureUrl | string? | URL temporária do CDN do WhatsApp |
Estados de canal
| Estado | Significado |
|---|---|
active | Canal operacional, recebendo publicações e novos seguidores |
suspended | Canal suspenso (violação de políticas), visível mas sem interação |
geosuspended | Canal indisponível na sua região |
Envelope de erro
Suporte do cliente WhatsMeow
Quadro de erros (resumo)
| HTTP | Mensagem |
|---|---|
| 400 | The 'name' field is required |
| 400 | The 'identifier' query parameter is required (JID @newsletter or invite link/code) |
| 400 | Invalid newsletter identifier (use JID @newsletter or invite link/code) |
| 400 | Instance is not connected to WhatsApp |
| 404 | newsletter not found |
| 500 | failed to create newsletter: <reason> |
| 500 | failed to follow newsletter: <reason> |
| 500 | failed to leave newsletter: <reason> |
| 501 | WhatsApp client does not support <method> |
Próximo
Criar canal
Cria um novo canal vinculado à conta.
Listar canais
Retorna canais inscritos.