Información del newsletter

GET

api

newsletter

info

:instance

Información del newsletter

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

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

fetch('https://api.example.com/api/newsletter/info/: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í

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?identifier=120363422585881117@newsletter`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

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"

const params = new URLSearchParams({ identifier: "https://whatsapp.com/channel/120363422585881117" });
await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?${params}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/newsletter/info/{os.environ['Instance_Name']}",
    params={"identifier": "https://whatsapp.com/channel/120363422585881117"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "net/url"
    "os"
)

func main() {
    q := url.Values{}
    q.Set("identifier", "https://whatsapp.com/channel/120363422585881117")
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/info/"+os.Getenv("Instance_Name")+"?"+q.Encode(), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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"

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

import os, requests

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

package main

import (
    "net/http"
    "os"
)

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

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

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Query

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

HTTP	Mensaje
400	`The 'identifier' query parameter is required (JID @newsletter or invite link/code)`
400	`Invalid newsletter identifier (use JID @newsletter or invite link/code)`
400	`newsletter not found or no metadata returned`
500	`failed to get newsletter info: <reason>`
501	`WhatsApp client does not support GetNewsletterInfo`

Envoltorio:

{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Información del newsletter

Descripción

Ejemplos

Por JID

Por enlace

Por código

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores

​Descripción

​Ejemplos

​Por JID

​Por enlace

​Por código

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Query

​Notas

​Errores

Descripción

Ejemplos

Por JID

Por enlace

Por código

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores