Saltar al contenido principal

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 en cada ruta. Cada llamada valida la propiedad de la instancia. Esta sección cubre las rutas /api/newsletter/* para crear canales, listar suscripciones, obtener detalles, seguir y dejar de seguir. Los canales tienen JIDs que terminan en @newsletter (diferentes de los JIDs @g.us de los grupos).

​
Endpoints

MétodoRutaFunción
POST/api/newsletter/create/:instanceCrear canal
GET/api/newsletter/list/:instanceListar canales suscritos
GET/api/newsletter/info/:instanceInformación del canal
POST/api/newsletter/join/:instanceSuscribirse
DELETE/api/newsletter/leave/:instanceCancelar suscripción

​
Identificadores aceptados

Los endpoints info, join y leave aceptan:
FormaEjemplo
JID120363422585881117@newsletter
Enlace completohttps://whatsapp.com/channel/120363422585881117
Solo el código120363422585881117

​
Modelo NewsletterChannel

CampoTipoDescripción
jidstring<id>@newsletter
statestringactive, suspended, geosuspended
namestringNombre del canal
descriptionstringPuede estar vacía
inviteLinkstring?https://whatsapp.com/channel/<id> (solo administradores / creador)
subscriberCountintPuede ser 0 si es desconocido
pictureUrlstring?URL temporal del CDN de WhatsApp

​
Estados del canal

EstadoSignificado
activeCanal operativo, aceptando publicaciones y nuevos seguidores
suspendedCanal suspendido (violación de políticas), visible pero sin interacción
geosuspendedCanal no disponible en tu región

​
Envoltorio de error

{
  "success": false,
  "error": { "message": "newsletter not found" }
}

​
Soporte del cliente WhatsMeow

Algunas rutas dependen de funciones del cliente WhatsMeow que pueden no estar disponibles en ciertas builds. Cuando eso ocurre, el servidor devuelve HTTP 501 con mensajes específicos:
  • WhatsApp client does not support newsletter creation
  • WhatsApp client does not support listing newsletters
  • WhatsApp client does not support FollowNewsletter
  • WhatsApp client does not support UnfollowNewsletter

​
Referencia de errores (resumen)

HTTPMensaje
400The 'name' field is required
400The 'identifier' query parameter is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400Instance is not connected to WhatsApp
404newsletter not found
500failed to create newsletter: <reason>
500failed to follow newsletter: <reason>
500failed to leave newsletter: <reason>
501WhatsApp client does not support <method>

​
Siguiente

Crear canal

Crea un nuevo canal vinculado a la cuenta.

Listar canales

Devuelve los canales suscritos.