Skip to content

Canais e Status

This content is not available in your language yet.

Endpoints para gerenciar canais (newsletters), publicar status (stories), administrar comunidades e consultar perfis comerciais. Todos exigem o header x-instance ou query param session_id para identificar a sessão.

Retorna os canais que a sessão segue.

GET /newsletter/subscribed

Resposta:

{
"success": true,
"newsletters": [...]
}

Retorna canais criados pela sessão.

GET /newsletter/list

Resposta:

{
"success": true,
"newsletters": [...]
}
POST /newsletter/info
{
"jid": "120363000000000000@newsletter"
}
POST /newsletter/create
{
"name": "Novidades da Loja",
"description": "Promoções e lançamentos semanais."
}
POST /newsletter/follow
{
"jid": "120363000000000000@newsletter"
}
POST /newsletter/follow-invite
{
"invite_code": "abc123def456"
}
POST /newsletter/unfollow
{
"jid": "120363000000000000@newsletter"
}
POST /newsletter/mute
{
"jid": "120363000000000000@newsletter",
"mute": true
}
POST /newsletter/messages
{
"jid": "120363000000000000@newsletter",
"count": 20
}
CampoTipoDescrição
jidstringJID do canal
countnumberQuantidade de mensagens (padrão: 20)
POST /newsletter/reaction
{
"jid": "120363000000000000@newsletter",
"server_id": 42,
"reaction": "🔥"
}
POST /newsletter/mark-viewed
{
"jid": "120363000000000000@newsletter",
"server_ids": [41, 42, 43]
}

Envia texto em um canal que você administra.

POST /newsletter/send
{
"jid": "120363000000000000@newsletter",
"text": "Confira as novidades desta semana!"
}

Resposta:

{
"success": true,
"messageId": "ABCDEF123456..."
}
POST /newsletter/subscribe-live-updates
{
"jid": "120363000000000000@newsletter"
}
POST /newsletter/message-updates
{
"jid": "120363000000000000@newsletter",
"count": 20
}

Publica status visíveis aos contatos da sessão. Campos de mídia aceitam URL HTTP ou base64.

POST /status/send/text
{
"text": "Bom dia!",
"background_color": 4278243070,
"font": 1
}
CampoTipoDescrição
textstringTexto do status
background_colornumberCor de fundo (ARGB int32)
fontnumberÍndice da fonte (0 a 5)
POST /status/send/image
{
"image": "https://exemplo.com/promo.jpg",
"caption": "Legenda opcional",
"mimetype": "image/jpeg"
}
POST /status/send/video
{
"video": "https://exemplo.com/clipe.mp4",
"caption": "Legenda opcional",
"mimetype": "video/mp4"
}
POST /status/send/audio
{
"audio": "https://exemplo.com/mensagem.ogg",
"mimetype": "audio/ogg"
}

Todos os endpoints de status retornam:

{
"success": true,
"id": "3EB0A1B2C3D4..."
}
POST /community/create
{
"name": "Equipe Comercial",
"participants": ["5511999999999@s.whatsapp.net"]
}
POST /community/link
{
"community": "120363000000000000@g.us",
"group": "120363111111111111@g.us"
}
POST /community/unlink
{
"community": "120363000000000000@g.us",
"group": "120363111111111111@g.us"
}
POST /community/linked-groups
{
"community": "120363000000000000@g.us"
}

Resposta:

{
"success": true,
"groups": [...]
}
POST /community/requests
{
"group": "120363000000000000@g.us"
}
POST /community/requests/update
{
"group": "120363000000000000@g.us",
"participants": ["5511999999999@s.whatsapp.net"],
"action": "approve"
}
Valor de actionEfeito
approveAceita a solicitação
rejectRejeita a solicitação
POST /business/profile
{
"jid": "5511999999999@s.whatsapp.net"
}

Gera ou recupera o link QR do perfil comercial da sessão.

POST /business/contact-qr
{
"revoke": false
}

Envie "revoke": true para revogar o link atual e gerar um novo.

Resposta:

{
"success": true,
"link": "https://wa.me/qr/ABCDEF123"
}

Resolve o código de um QR de contato para obter informações do número.

POST /business/resolve-contact-qr
{
"code": "ABCDEF123"
}

Resolve um link wa.me/message/ para obter dados do perfil.

POST /business/resolve-link
{
"code": "ABCDEF123"
}