Listar canais

GET

api

newsletter

list

:instance

Listar canais

curl --request GET \
  --url https://api.example.com/api/newsletter/list/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/newsletter/list/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/list/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/newsletter/list/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/list/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Headers

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

HTTP	Mensagem
400	`Instance is not connected to WhatsApp`
404	`Instance not found`
500	`failed to get newsletters: <reason>`
501	`WhatsApp client does not support listing newsletters (GetSubscribedNewsletters not available)`

Envelope:

{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Listar

Resposta de sucesso

Parâmetros de rota

Headers

Notas

Erros

​Descrição

​Exemplos

​Listar

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Notas

​Erros

Descrição

Exemplos

Listar

Resposta de sucesso

Parâmetros de rota

Headers

Notas

Erros