Pular para o conteúdo principal
GET
/
api
/
newsletter
/
list
/
:instance
Listar canais
curl --request GET \
  --url https://api.example.com/api/newsletter/list/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim (read-only)

​
Descrição

Retorna todos os canais aos quais a conta está inscrita, canais que ela segue e canais dos quais é admin / dono. Sem paginação: a lista vem completa em uma única resposta.

​
Exemplos

​
Listar

Retorna em uma única resposta todos os canais que a conta segue ou administra. Sem filtros nem paginação, o cliente recebe a lista completa em newsletters[] com metadados de cada canal. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/list/$Instance_Name" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

A resposta traz newsletters[] com cada canal seguido ou administrado pela conta e meta.total com a contagem (igual a newsletters.length). Cada item segue o shape NewsletterChannel (mesmo de /info). Quando a conta não segue nenhum canal, o array vem vazio e meta.total = 0.
200 OK
{
  "success": true,
  "message": "2 newsletter(s) found",
  "newsletters": [
    {
      "jid": "120363422585881117@newsletter",
      "state": "active",
      "name": "Notícias",
      "description": "Atualizações diárias",
      "inviteLink": "https://whatsapp.com/channel/120363422585881117",
      "subscriberCount": 150,
      "pictureUrl": null
    },
    {
      "jid": "120363499999999999@newsletter",
      "state": "active",
      "name": "Tech News",
      "description": "Latest tech updates",
      "subscriberCount": 500,
      "pictureUrl": "https://exemplo.com/tech.jpg"
    }
  ],
  "meta": { "total": 2 }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Notas

  • A lista mistura canais seguidos + administrados. Não há flag distintiva, para diferenciar, use GET /info para inspecionar role.
  • Canais suspended / geosuspended aparecem na lista, filtre no cliente se quiser apenas operacionais.
  • inviteLink e pictureUrl são omitempty, canais que você só segue normalmente não expõem o link de convite.
  • Sem paginação: contas com 100+ canais podem ter respostas grandes.

​
Erros

HTTPMensagem
400Instance is not connected to WhatsApp
404Instance not found
500failed to get newsletters: <reason>
501WhatsApp client does not support listing newsletters (GetSubscribedNewsletters not available)
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}