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.
Newsletters
Seção intitulada “Newsletters”Listar inscrições
Seção intitulada “Listar inscrições”Retorna os canais que a sessão segue.
GET /newsletter/subscribedResposta:
{ "success": true, "newsletters": [...]}Listar canais próprios
Seção intitulada “Listar canais próprios”Retorna canais criados pela sessão.
GET /newsletter/listResposta:
{ "success": true, "newsletters": [...]}Informações de um canal
Seção intitulada “Informações de um canal”POST /newsletter/info{ "jid": "120363000000000000@newsletter"}Criar canal
Seção intitulada “Criar canal”POST /newsletter/create{ "name": "Novidades da Loja", "description": "Promoções e lançamentos semanais."}Seguir canal
Seção intitulada “Seguir canal”POST /newsletter/follow{ "jid": "120363000000000000@newsletter"}Seguir via convite
Seção intitulada “Seguir via convite”POST /newsletter/follow-invite{ "invite_code": "abc123def456"}Deixar de seguir
Seção intitulada “Deixar de seguir”POST /newsletter/unfollow{ "jid": "120363000000000000@newsletter"}Silenciar/ativar notificações
Seção intitulada “Silenciar/ativar notificações”POST /newsletter/mute{ "jid": "120363000000000000@newsletter", "mute": true}Buscar mensagens do canal
Seção intitulada “Buscar mensagens do canal”POST /newsletter/messages{ "jid": "120363000000000000@newsletter", "count": 20}| Campo | Tipo | Descrição |
|---|---|---|
jid | string | JID do canal |
count | number | Quantidade de mensagens (padrão: 20) |
Reagir a mensagem
Seção intitulada “Reagir a mensagem”POST /newsletter/reaction{ "jid": "120363000000000000@newsletter", "server_id": 42, "reaction": "🔥"}Marcar como visto
Seção intitulada “Marcar como visto”POST /newsletter/mark-viewed{ "jid": "120363000000000000@newsletter", "server_ids": [41, 42, 43]}Enviar mensagem no canal
Seção intitulada “Enviar mensagem no canal”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..."}Inscrever para atualizações ao vivo
Seção intitulada “Inscrever para atualizações ao vivo”POST /newsletter/subscribe-live-updates{ "jid": "120363000000000000@newsletter"}Buscar atualizações de mensagens
Seção intitulada “Buscar atualizações de mensagens”POST /newsletter/message-updates{ "jid": "120363000000000000@newsletter", "count": 20}Status (Stories)
Seção intitulada “Status (Stories)”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}| Campo | Tipo | Descrição |
|---|---|---|
text | string | Texto do status |
background_color | number | Cor de fundo (ARGB int32) |
font | number | Í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..."}Comunidades
Seção intitulada “Comunidades”Criar comunidade
Seção intitulada “Criar comunidade”POST /community/create{ "name": "Equipe Comercial", "participants": ["5511999999999@s.whatsapp.net"]}Vincular grupo
Seção intitulada “Vincular grupo”POST /community/link{ "community": "120363000000000000@g.us", "group": "120363111111111111@g.us"}Desvincular grupo
Seção intitulada “Desvincular grupo”POST /community/unlink{ "community": "120363000000000000@g.us", "group": "120363111111111111@g.us"}Listar grupos vinculados
Seção intitulada “Listar grupos vinculados”POST /community/linked-groups{ "community": "120363000000000000@g.us"}Resposta:
{ "success": true, "groups": [...]}Solicitações de entrada
Seção intitulada “Solicitações de entrada”POST /community/requests{ "group": "120363000000000000@g.us"}Aprovar/rejeitar solicitações
Seção intitulada “Aprovar/rejeitar solicitações”POST /community/requests/update{ "group": "120363000000000000@g.us", "participants": ["5511999999999@s.whatsapp.net"], "action": "approve"}Valor de action | Efeito |
|---|---|
approve | Aceita a solicitação |
reject | Rejeita a solicitação |
Business (Perfil Comercial)
Seção intitulada “Business (Perfil Comercial)”Consultar perfil comercial
Seção intitulada “Consultar perfil comercial”POST /business/profile{ "jid": "5511999999999@s.whatsapp.net"}Obter QR de contato
Seção intitulada “Obter QR de contato”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"}Resolver QR de contato
Seção intitulada “Resolver QR de contato”Resolve o código de um QR de contato para obter informações do número.
POST /business/resolve-contact-qr{ "code": "ABCDEF123"}Resolver link comercial
Seção intitulada “Resolver link comercial”Resolve um link wa.me/message/ para obter dados do perfil.
POST /business/resolve-link{ "code": "ABCDEF123"}