Wafly · API summary for LLMs · OpenAPI 3.1

API documentation

Wafly WhatsApp API reference

Public REST API documentation for messages, instances, groups, newsletters, communities and webhooks.

Base URL: https://wafly.io/api-bridge-whats. Instance credentials are generated in the dashboard after connecting a number.

Parceiros

Criação de instâncias via API para clientes parceiros (provisionamento completo).

  • POST /api-managment/external/instances — Criar instância (parceiro)

Instância

Gerenciamento de sessão: conexão, status, QR Code e dispositivo.

  • GET /api-bridge-whats/instances/{instance}/token/{token}/status — Status da sessão
  • GET /api-bridge-whats/instances/{instance}/token/{token}/qr-code/image — QR Code para conexão
  • GET /api-bridge-whats/instances/{instance}/token/{token}/passkey-challenge — Desafio de passkey (WebAuthn)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/passkey-response — Enviar assinatura de passkey
  • POST /api-bridge-whats/instances/{instance}/token/{token}/phone-exists-batch — Verificar números no WhatsApp
  • GET /api-bridge-whats/instances/{instance}/token/{token}/device — Informações do dispositivo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/connect — Conectar instância
  • GET /api-bridge-whats/instances/{instance}/token/{token}/disconnect — Desconectar instância
  • GET /api-bridge-whats/instances/{instance}/token/{token}/restart — Reiniciar instância
  • GET /api-bridge-whats/instances/{instance}/token/{token}/pairing-code — Código de emparelhamento (GET)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/pairing-code — Código de emparelhamento (POST)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/restart-with-disconnect — Reiniciar com desconexão
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/inbound-config — Agrupar mensagens picotadas (buffer)
  • GET /api-bridge-whats/instances/{instance}/token/{token}/inbound-config — Consultar config de entrega
  • DELETE /api-bridge-whats/instances/{instance}/token/{token}/inbound-config — Voltar ao padrão
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/ai-config — Transcrever áudio recebido (chave sua)
  • GET /api-bridge-whats/instances/{instance}/token/{token}/ai-config — Consultar config de transcrição
  • DELETE /api-bridge-whats/instances/{instance}/token/{token}/ai-config — Remover chave e desligar transcrição

Mensagens

Envio de mensagens de texto, mídia, interativas e muito mais.

  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-text — Enviar mensagem de texto
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-image — Enviar imagem
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-audio — Enviar áudio
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-video — Enviar vídeo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-document/{type} — Enviar documento
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-link — Enviar link com prévia
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-poll — Enviar enquete
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-contacts — Enviar contato
  • DELETE /api-bridge-whats/instances/{instance}/token/{token}/delete-message — Deletar mensagem
  • POST /api-bridge-whats/instances/{instance}/token/{token}/pin-message — Fixar mensagem
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-option-list — Enviar lista de opções
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-gif — Enviar GIF
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-ptv — Enviar vídeo redondo (PTV)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-event — Enviar evento
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-button-actions — Enviar botões de ação
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-button-list — Enviar lista de botões
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-button-otp — Enviar botão OTP
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-button-pix — Enviar botão PIX
  • POST /api-bridge-whats/instances/{instance}/token/{token}/send-carousel — Enviar carrossel

Grupos

Criação, gerenciamento e configurações de grupos WhatsApp.

  • GET /api-bridge-whats/instances/{instance}/token/{token}/groups — Listar grupos
  • POST /api-bridge-whats/instances/{instance}/token/{token}/create-group — Criar grupo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/add-participant — Adicionar participante
  • POST /api-bridge-whats/instances/{instance}/token/{token}/remove-participant — Remover participante
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-group-name — Alterar nome do grupo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/add-admin — Promover a administrador
  • POST /api-bridge-whats/instances/{instance}/token/{token}/remove-admin — Remover administrador
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-group-settings — Atualizar configurações do grupo
  • GET /api-bridge-whats/instances/{instance}/token/{token}/group/invite-link — Obter link de convite
  • GET /api-bridge-whats/instances/{instance}/token/{token}/group-metadata/{phone} — Metadados do grupo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/leave-group — Sair do grupo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-group-photo — Atualizar foto do grupo
  • POST /api-bridge-whats/instances/{instance}/token/{token}/group/photo — Atualizar foto do grupo (por URL)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/approve-participant — Aprovar solicitação de entrada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/reject-participant — Rejeitar solicitação de entrada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/redefine-invitation-link/{id} — Redefinir link de convite
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-group-description — Atualizar descrição do grupo

Newsletter / Canais

Gerenciamento de newsletters e canais (@newsletter).

  • GET /api-bridge-whats/instances/{instance}/token/{token}/newsletter — Listar newsletters
  • POST /api-bridge-whats/instances/{instance}/token/{token}/create-newsletter — Criar newsletter
  • GET /api-bridge-whats/instances/{instance}/token/{token}/newsletter/metadata/{newsletterId} — Metadados da newsletter
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/follow-newsletter — Seguir newsletter
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/unfollow-newsletter — Deixar de seguir newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/newsletter/settings/{newsletterId} — Configurações da newsletter
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/mute-newsletter — Silenciar newsletter
  • DELETE /api-bridge-whats/instances/{instance}/token/{token}/delete-newsletter — Deletar newsletter
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/unmute-newsletter — Reativar som da newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-newsletter-picture — Atualizar imagem da newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-newsletter-name — Alterar nome da newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/update-newsletter-description — Alterar descrição da newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/search-newsletter — Buscar newsletters
  • POST /api-bridge-whats/instances/{instance}/token/{token}/newsletter/accept-admin-invite/{newsletterId} — Aceitar convite de admin
  • POST /api-bridge-whats/instances/{instance}/token/{token}/newsletter/remove-admin/{newsletterId} — Remover administrador da newsletter
  • POST /api-bridge-whats/instances/{instance}/token/{token}/newsletter/revoke-admin-invite/{newsletterId} — Revogar convite de admin
  • POST /api-bridge-whats/instances/{instance}/token/{token}/newsletter/transfer-ownership/{newsletterId} — Transferir propriedade da newsletter

Chats

Listagem e metadados de conversas.

  • GET /api-bridge-whats/instances/{instance}/token/{token}/chats — Listar conversas
  • POST /api-bridge-whats/instances/{instance}/token/{token}/modify-chat — Marcar chat como lido/não lido
  • GET /api-bridge-whats/instances/{instance}/token/{token}/chats/{phone} — Metadados de um chat

Webhooks

Configuração de URLs de callback para eventos da instância.

  • PUT /api-bridge-whats/instances/{instance}/token/{token}/update-webhook-received — Webhook — mensagem recebida
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/update-webhook-delivery — Webhook — confirmação de entrega
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/update-webhook-connected — Webhook — instância conectada
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/update-webhook-disconnected — Webhook — instância desconectada

Comunidades

Super-grupos: criação, gestão e configurações de comunidades.

  • GET /api-bridge-whats/instances/{instance}/token/{token}/communities — Listar comunidades
  • POST /api-bridge-whats/instances/{instance}/token/{token}/communities — Criar comunidade
  • POST /api-bridge-whats/instances/{instance}/token/{token}/communities/link — Vincular grupos à comunidade
  • POST /api-bridge-whats/instances/{instance}/token/{token}/communities/unlink — Desvincular grupos da comunidade
  • GET /api-bridge-whats/instances/{instance}/token/{token}/communities-metadata/{communityId} — Metadados da comunidade
  • POST /api-bridge-whats/instances/{instance}/token/{token}/communities/settings — Configurações da comunidade
  • DELETE /api-bridge-whats/instances/{instance}/token/{token}/communities/{communityId} — Desativar comunidade

Chamadas (beta)

Chamadas de voz por WhatsApp: atender, recusar, tocar áudio, falar por TTS, gravar e transcrever. Requer ativação.

  • GET /api-bridge-whats/instances/{instance}/token/{token}/call/config — Ver configuração de chamadas
  • PUT /api-bridge-whats/instances/{instance}/token/{token}/call/config — Configurar chamadas recebidas
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/start — Iniciar chamada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/accept — Atender chamada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/reject — Recusar chamada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/terminate — Encerrar chamada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/play — Tocar áudio na chamada
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/say — Falar texto na chamada (TTS)
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/webrtc — Ponte WebRTC
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/{callId}/record/start — Iniciar gravação
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/{callId}/record/stop — Parar gravação
  • GET /api-bridge-whats/instances/{instance}/token/{token}/call/{callId}/recording — Baixar gravação
  • GET /api-bridge-whats/instances/{instance}/token/{token}/call/{callId}/transcript — Ver transcrição
  • POST /api-bridge-whats/instances/{instance}/token/{token}/call/{callId}/transcript — Anexar transcrição