Referência da API
62 operações organizadas por recurso.
Consulte cada operação por recurso. As páginas mostram autenticação, campos, exemplos e respostas do contrato atual.
Diagnóstico
Disponibilidade do serviço e capacidades do servidor.
Instâncias
Crie, conecte e acompanhe sessões de WhatsApp.
- POST · Criar instância e emitir token
- GET · Listar instâncias do servidor
- POST · Conectar ou iniciar pareamento
- GET · Consultar sessão e webhook
- POST · Desvincular e limpar credencial
- POST · Reiniciar preservando credencial
- DELETE · Excluir instância
Administração
Gerencie instâncias por ID usando o token administrativo.
- GET · Consultar instância por ID
- DELETE · Excluir instância por ID
- POST · Conectar instância por ID
- POST · Desvincular instância por ID
- POST · Reiniciar instância por ID
- POST · Reemitir token da instância
- POST · Reiniciar sessões deste worker
Enviar mensagens
Envie texto, mídia, contato, localização e menus.
- POST · Enviar texto
- POST · Enviar mídia
- POST · Enviar contato
- POST · Enviar localização
- POST · Enviar botões, lista ou enquete
Ações em mensagens
Encaminhe, reaja, edite e apague mensagens armazenadas.
- POST · Encaminhar mensagem guardada
- POST · Reagir ou remover reação
- POST · Apagar mensagem própria para todos
- POST · Editar texto ou legenda própria
- PUT · Editar mensagem (alias PUT)
Conversas e consultas
Consulte conversas, mensagens, números e perfis.
- POST · Buscar mensagens no formato legado
- GET · Consultar resultado da mensagem
- GET · Listar mensagens no formato interno
- POST · Verificar números no WhatsApp
- POST · Obter identidade e foto
- POST · Listar conversas conhecidas
Mídia
Baixe arquivos e use URLs assinadas com prazo de validade.
Leitura
Marque mensagens ou conversas como lidas.
Grupos
Consulte e gerencie grupos com as permissões da conta.
- GET · Listar grupos sincronizados
- POST · Consultar grupo
- POST · Criar grupo
- POST · Alterar participantes
- POST · Alterar nome do grupo
- POST · Alterar imagem do grupo
Proxy da instância
Consulte e configure a conexão de rede da instância.
Webhooks e eventos
Configure destinos, acompanhe a entrega e reprocesse eventos.
- POST · Configurar, desativar ou herdar webhook
- GET · Consultar webhook e entrega
- GET · Consultar falhas recentes de entrega
- GET · Inspecionar eventos internos e fila
- POST · Reenfileirar evento
- POST · Salvar ou remover webhook global
- GET · Consultar webhook global
- POST · Configurar, desativar ou herdar webhook por ID
- GET · Consultar webhook e entrega por ID
- GET · Consultar falhas recentes de entrega por ID
Chamadas de voz
Chamadas 1:1 por instância calls, com módulo habilitado e ponte de áudio.