API do Pulvify
Gerencie sessões WhatsApp via instâncias: envie mensagens, gerencie grupos, comunidades, contatos, canais e webhooks através de uma API REST simples.
Endpoints
69
Categorias
8
Formato
JSON
Autenticação
Todas as chamadas vão para https://api.pulvify.com. As rotas /instances usam o token da conta; as rotas /{instance}/... usam o api-key da instância que receberá a operação.
account-token
Token da conta
Envie no header account-token. Gere em Configurações > API no painel; ele cria, lista e exclui instâncias respeitando o limite do seu plano.
api-key
Token da instância
Envie no header api-key. Cada instância WhatsApp tem o próprio token, disponível na página da instância no painel.
Variáveis da coleção
| {{base_url}} | URL do gateway da API (https://api.pulvify.com). |
| {{instance}} | Slug da instância (sessão) que receberá a operação. |
| {{account_token}} | Token da sua conta (header account-token), usado nas rotas /instances. |
| {{instance_token}} | Token da instância (header api-key). |
| {{group_id}} | JID do grupo, no formato ID_DO_GRUPO@g.us. |
| {{community_id}} | JID da comunidade, no formato ID_DA_COMUNIDADE@g.us. |
| {{webhook_id}} | Identificador do webhook criado na instância. |
| {{jid}} | JID do canal/newsletter, no formato ID_DO_CANAL@newsletter. |
Eventos de webhook
Ao criar um webhook, escolha quais categorias de eventos deseja receber. Use ["*"] para receber tudo. O payload chega no formato {event, eventId, sessionId, data}.
| connection | QR Code, pareamento, conexão e desconexão. |
| history | Histórico recebido do WhatsApp (não é consulta retroativa). |
| messages | Novas mensagens de conversas individuais e grupos. |
| messages_update | Recibos, edições, exclusões, reações e votos. |
| newsletter_messages | Novos posts de canais do WhatsApp. |
| call | Oferta, aceite, rejeição e término de chamadas. |
| contacts | Agenda, nomes, descrição, identidade e fotos de contatos. |
| presence | Presença, digitação e gravação (depende da assinatura de presença). |
| groups | Participantes, permissões, metadados e fotos de grupos. |
| labels | Criação, edição e remoção de etiquetas. |
| chats | Arquivar, fixar, silenciar, marcar leitura, limpar e remover conversas. |
| chat_labels | Associação e remoção de etiquetas em conversas. |
| blocks | Lista de bloqueios e alterações. |
Headers
Corpo da requisição