Pular para o conteúdo principal
GET
/
api
/
newsletter
/
info
/
:instance
Info do canal
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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna o NewsletterChannel completo. Útil para preview antes de seguir um canal, funciona mesmo que você não esteja inscrito.

​
Exemplos

​
Por JID

Consulta os metadados do canal pelo JID canônico (@newsletter). Funciona mesmo que a conta não esteja inscrita, útil para preview antes de chamar /join. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"
Consulta o canal pelo link de convite completo. O servidor faz o url-decode e resolve o código antes de buscar os metadados, retornando o mesmo 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

Consulta o canal apenas com o código de convite (sufixo do link). Mesmo resultado, mais conciso quando você já tem o código extraído. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

A resposta retorna o NewsletterChannel completo, com channel.jid canônico, state atual (active, suspended, etc.), nome, descrição, inviteLink (quando disponível), subscriberCount e pictureUrl. Os campos inviteLink e pictureUrl são opcionais e podem vir ausentes quando a conta não tem permissão para enxergá-los.
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://exemplo.com/tech.jpg"
  }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Query

​
identifier
string
obrigatório
JID @newsletter, link completo (https://whatsapp.com/channel/<id>) ou apenas o código (<id>).

​
Notas

  • É a forma certa de preview antes de chamar /join.
  • subscriberCount pode vir defasado (cache do WhatsApp).
  • Códigos são case-sensitive: ABC123 não é o mesmo que abc123.
  • inviteLink só vem se a conta tiver permissão para enxergá-lo.

​
Erros

HTTPMensagem
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
Envelope: 
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}