Listar canales

GET

api

newsletter

list

:instance

Listar canales

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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí (solo lectura)

Descripción

Devuelve todos los canales a los que la cuenta está suscrita, los canales que sigue y los canales de los que es administrador / propietario. Sin paginación: la lista viene completa en una sola respuesta.

Ejemplos

Listar

Devuelve cada canal que la cuenta sigue o administra en una sola respuesta. Sin filtros ni paginación, el cliente recibe la lista completa en newsletters[] con metadatos para 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)
}

Respuesta exitosa

La respuesta lleva newsletters[] con cada canal seguido o administrado por la cuenta, además de meta.total con el conteo (igual a newsletters.length). Cada elemento sigue la forma NewsletterChannel (igual que /info). Cuando la cuenta no sigue ningún canal, el array está vacío y meta.total = 0.

200 OK

{
  "success": true,
  "message": "2 newsletter(s) found",
  "newsletters": [
    {
      "jid": "120363422585881117@newsletter",
      "state": "active",
      "name": "News",
      "description": "Daily updates",
      "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://example.com/tech.jpg"
    }
  ],
  "meta": { "total": 2 }
}

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Notas

La lista mezcla canales seguidos + administrados. No hay una bandera distintiva, para diferenciar, usa GET /info para inspeccionar el rol.
Los canales suspended / geosuspended aparecen en la lista, filtra del lado del cliente si solo quieres los operativos.
inviteLink y pictureUrl son omitempty, los canales que solo sigues normalmente no exponen el enlace de invitación.
Sin paginación: cuentas con más de 100 canales pueden tener respuestas grandes.

Errores

HTTP	Mensaje
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)`

Envoltorio:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Listar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Notas

Errores

​Descripción

​Ejemplos

​Listar

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Notas

​Errores

Descripción

Ejemplos

Listar

Respuesta exitosa

Parámetros de ruta

Cabeceras

Notas

Errores