Saltar al contenido principal
GET
/
api
/
newsletter
/
info
/
:instance
Información del newsletter
curl --request GET \
  --url https://api.example.com/api/newsletter/info/: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í

​
Descripción

Devuelve el NewsletterChannel completo. Útil como vista previa antes de seguir un newsletter, funciona incluso si no estás suscrito.

​
Ejemplos

​
Por JID

Busca los metadatos del newsletter por su JID canónico (@newsletter). Funciona incluso cuando la cuenta no está suscrita, útil como vista previa antes de llamar a /join. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"

​
Por enlace

Busca el newsletter por el enlace de invitación completo. El servidor decodifica la URL y resuelve el código antes de obtener los metadatos, devolviendo el mismo NewsletterChannel. 
curl -G "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name" \
  --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
  -H "token: $Token_Instance"

​
Por código

Busca el newsletter usando solo el código de invitación (el sufijo del enlace). Mismo resultado, más conciso cuando ya tienes el código a mano. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Respuesta exitosa

La respuesta devuelve el NewsletterChannel completo, con el channel.jid canónico, state actual (active, suspended, etc.), nombre, descripción, inviteLink (cuando esté disponible), subscriberCount y pictureUrl. Los campos inviteLink y pictureUrl son opcionales y pueden faltar cuando la cuenta no tiene permiso para verlos.
200 OK
{
  "success": true,
  "message": "Newsletter info retrieved",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Tech News",
    "description": "Latest tech updates",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 500,
    "pictureUrl": "https://example.com/tech.jpg"
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Query

​
identifier
string
requerido
JID @newsletter, enlace completo (https://whatsapp.com/channel/<id>) o solo el código (<id>).

​
Notas

  • Esta es la forma correcta de previsualizar antes de llamar a /join.
  • subscriberCount puede estar ligeramente desactualizado (caché de WhatsApp).
  • Los códigos son case-sensitive: ABC123 no es lo mismo que abc123.
  • inviteLink solo se devuelve si la cuenta tiene permiso para verlo.

​
Errores

HTTPMensaje
400The 'identifier' query parameter is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400newsletter not found or no metadata returned
500failed to get newsletter info: <reason>
501WhatsApp client does not support GetNewsletterInfo
Envoltorio: 
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}