Saltar al contenido principal
GET
/
api
/
newsletter
/
list
/
:instance
Listar canales
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 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"

​
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

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
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

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