Pular para o conteúdo 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 ou TokenInstance em todas as rotas. Cada chamada valida a ownership da instância. Esta seção cobre as rotas /api/newsletter/* para criar canais, listar inscrições, obter detalhes, seguir e deixar de seguir. Canais têm JIDs terminando em @newsletter (diferente de grupos @g.us).

​
Endpoints

MétodoPathFunção
POST/api/newsletter/create/:instanceCriar canal
GET/api/newsletter/list/:instanceListar canais inscritos
GET/api/newsletter/info/:instanceInfo de um canal
POST/api/newsletter/join/:instanceInscrever-se
DELETE/api/newsletter/leave/:instanceCancelar inscrição

​
Identifiers aceitos

Os endpoints info, join e leave aceitam:
FormaExemplo
JID120363422585881117@newsletter
Link completohttps://whatsapp.com/channel/120363422585881117
Código apenas120363422585881117

​
Modelo NewsletterChannel

CampoTipoDescrição
jidstring<id>@newsletter
statestringactive, suspended, geosuspended
namestringNome do canal
descriptionstringPode ser vazia
inviteLinkstring?https://whatsapp.com/channel/<id> (apenas para admins / criador)
subscriberCountintPode ser 0 se desconhecido
pictureUrlstring?URL temporária do CDN do WhatsApp

​
Estados de canal

EstadoSignificado
activeCanal operacional, recebendo publicações e novos seguidores
suspendedCanal suspenso (violação de políticas), visível mas sem interação
geosuspendedCanal indisponível na sua região

​
Envelope de erro

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

​
Suporte do cliente WhatsMeow

Algumas rotas dependem de funções do cliente WhatsMeow que podem não estar disponíveis em determinadas builds. Quando isso acontece, o servidor retorna HTTP 501 com mensagens específicas:
  • 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

​
Quadro de erros (resumo)

HTTPMensagem
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>

​
Próximo

Criar canal

Cria um novo canal vinculado à conta.

Listar canais

Retorna canais inscritos.