{ "info": { "name": "ZapZap API", "description": "API REST para conectar números de WhatsApp por QR code e enviar, receber e automatizar mensagens. Autentique com os cabeçalhos `x-api-key` e `x-api-secret` (Configurações e API no painel). O canal usa QR code e não é a API oficial da Meta: o WhatsApp pode restringir números que enviam mensagens indesejadas. Documentação: https://zapzapapi.com/docs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.request.headers.upsert({ key: 'x-api-secret', value: pm.variables.get('apiSecret') });" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.zapzapapi.com/api/v1" }, { "key": "apiKey", "value": "" }, { "key": "apiSecret", "value": "" }, { "key": "instanceId", "value": "" } ], "item": [ { "name": "Conta e Instâncias", "item": [ { "name": "Dados da Conta", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account", "host": [ "{{baseUrl}}" ], "path": [ "account" ] }, "description": "Retorna os dados da sua conta: nome, email, saldo atual, dia de cobrança e status." } }, { "name": "Listar Instâncias", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances", "host": [ "{{baseUrl}}" ], "path": [ "instances" ] }, "description": "Lista todas as instâncias WhatsApp da sua conta com status, nome, telefone e configurações." } }, { "name": "Criar Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances", "host": [ "{{baseUrl}}" ], "path": [ "instances" ] }, "description": "Cria uma nova instância WhatsApp. Debita automaticamente do saldo (taxa de ativação + proporcional). O nome deve conter apenas letras, números, _ e -.", "body": { "mode": "raw", "raw": "{\n \"name\": \"minha-instancia\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Custo de Criação", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/cost", "host": [ "{{baseUrl}}" ], "path": [ "instances", "cost" ] }, "description": "Retorna o custo para criar uma nova instância: taxa de ativação, proporcional e saldo necessário." } }, { "name": "Deletar Instância", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Deleta (soft delete) uma instância. O WhatsApp é desconectado e um waiver de taxa de ativação é gerado para a próxima criação." } }, { "name": "Detalhes da Instância", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Retorna detalhes de uma instância específica." } }, { "name": "Atualizar Instância", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Atualiza webhook_url e/ou metadata de uma instância. O metadata é um JSON livre para vincular a instância ao seu sistema (ex: ID do cliente, plano, etc). O metadata é incluído automaticamente nos webhooks recebidos.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "QR Code da Instância", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/qrcode", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "qrcode" ] }, "description": "Retorna o QR Code para conectar o WhatsApp à instância. Escaneie com o celular." } }, { "name": "Ver Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook" ] }, "description": "Retorna a URL de webhook configurada para a instância. O webhook recebe eventos em tempo real (mensagens, status, etc).\n\n⚠️ ATENÇÃO À URL: o {id} já vai no caminho: NÃO adicione duas vezes.\n\n✅ Certo: GET /api/v1/instances/SEU-INSTANCE-ID/webhook\n❌ Errado: GET /api/v1/SEU-INSTANCE-ID/instances/SEU-INSTANCE-ID/webhook (instanceId duplicado)" } }, { "name": "Configurar Webhook", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook" ] }, "description": "Define ou atualiza a URL de webhook da instância. A URL deve ser pública e acessível via HTTPS. Eventos como mensagens recebidas, status de entrega e mudanças de conexão serão enviados via POST para essa URL.\n\n⚠️ ATENÇÃO À URL: o {id} já vai no caminho: NÃO adicione duas vezes.\n\n✅ Certo: PUT /api/v1/instances/SEU-INSTANCE-ID/webhook\n❌ Errado: PUT /api/v1/SEU-INSTANCE-ID/instances/SEU-INSTANCE-ID/webhook (instanceId duplicado)", "body": { "mode": "raw", "raw": "{\n \"webhook_url\": \"https://meusite.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Testar Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook/test", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook", "test" ] }, "description": "Envia um evento de teste para a URL de webhook configurada. Retorna o status code e tempo de resposta. Útil para validar que seu servidor está recebendo os eventos corretamente.\n\n⚠️ ATENÇÃO À URL: o {id} já vai no caminho: NÃO adicione duas vezes.\n\n✅ Certo: POST /api/v1/instances/SEU-INSTANCE-ID/webhook/test\n❌ Errado: POST /api/v1/SEU-INSTANCE-ID/instances/SEU-INSTANCE-ID/webhook/test (instanceId duplicado)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Limites de Novas Conversas (WhatsApp)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/wa_messages_limits", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "wa_messages_limits" ] }, "description": "Consulta o limite atual de novas conversas que o WhatsApp permite iniciar a partir deste número (o 'tier' da conta). Útil para acompanhar aquecimento e evitar bloqueio por excesso de disparos." } } ] }, { "name": "Enviar Mensagens", "item": [ { "name": "Enviar Carrossel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/carousel", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "carousel" ] }, "description": "Envia um carrossel de cartões com imagem e botões de ação. Cada item do array `carousel` representa um cartão com `text`, `image` e `buttons: [{type,text,id}]`.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Confira nossas opções:\",\n \"carousel\": [\n {\n \"text\": \"Produto 1\",\n \"image\": \"https://exemplo.com/img.jpg\",\n \"buttons\": [\n {\n \"type\": \"REPLY\",\n \"text\": \"Quero!\",\n \"id\": \"quero\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Contato (vCard)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/contact", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "contact" ] }, "description": "Envia um cartão de contato (vCard) com nome e telefone.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"fullName\": \"João Silva\",\n \"phoneNumber\": \"5511999999999,5511888888888\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Localização", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/location", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "location" ] }, "description": "Envia uma localização geográfica com pin no mapa. O destinatário pode abrir no Google Maps ou Apple Maps diretamente.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5505,\n \"longitude\": -46.6333\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Solicitar Localização", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/location-button", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "location-button" ] }, "description": "Envia uma mensagem com botao que pede a localizacao do usuario. O botao de compartilhar localizacao e adicionado automaticamente.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Compartilhe sua localização para entregarmos seu pedido:\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Mídia", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/media", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "media" ] }, "description": "Envia um arquivo de mídia para um contato. O arquivo deve estar acessível em uma URL pública.\n\nTipos disponíveis:\n• image: Imagem (JPG, PNG, GIF, WebP). Suporta legenda via text.\n• video: Vídeo (MP4, AVI, MOV). Suporta legenda via text.\n• audio: Áudio como arquivo (MP3, OGG, WAV). Aparece com ícone de arquivo de áudio.\n• ptt: Push-to-Talk: áudio que aparece como mensagem de voz (bolha de microfone). Ideal para humanizar automações.\n• myaudio: Áudio nativo do WhatsApp (OGG/Opus). Semelhante ao ptt, use quando já tiver o arquivo no formato correto.\n• ptv: Recado de vídeo (nota de vídeo redonda). Chega sempre em formato circular; vídeo 16:9 é cortado no centro. Ignora legenda (o campo text não aparece). Use MP4 H.264. Aceita durações longas (testado 15 a 180 s) e tamanho dentro do limite de mídia.\n• document: Documento (PDF, DOCX, XLSX, etc.). Use docName para definir o nome exibido no chat.\n• sticker: Figurinha animada ou estática (WebP).\n\nLimite de tamanho (envio por URL): imagem, vídeo e áudio até ~190 MB; documento até ~500 MB. Acima disso o WhatsApp recusa (HTTP 413 / erro de upload). Observação: ao enviar o arquivo em base64 no corpo da requisição pela API pública (/api/v1), o limite cai para ~2 MB. Por isso, para arquivos maiores, sempre envie por URL.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"type\": \"\",\n \"file\": \"https://...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Botões de Resposta", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/buttons", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "buttons" ] }, "description": "Envia botões clicáveis (até 3). Cada objeto do array `buttons` vira um tipo diferente de botão conforme o campo usado:\n\n• `text` + `id` → botão de resposta rápida (contato clica, envia o texto)\n• `text` + `url` → botão que abre link externo\n• `text` + `phone` → botão de ligação\n• `text` + `copy` → botão que copia código pra área de transferência\n\nSem `image`, a mensagem sai só com texto + botões (header limpo). Com `image`, aparece uma imagem no topo. Limitação WhatsApp: misturar reply com url/phone/copy na mesma mensagem pode exibir aviso 'Abra no celular'.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Como podemos ajudar?\",\n \"buttons\": [\n {\n \"text\": \"Sim\",\n \"id\": \"yes\"\n },\n {\n \"text\": \"Nosso site\",\n \"url\": \"https://exemplo.com\"\n },\n {\n \"text\": \"Ligar\",\n \"phone\": \"+5511999999999\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Lista de Opções", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "list" ] }, "description": "Envia menu em lista com seções e itens selecionáveis. O contato toca no botão e escolhe uma opção.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Escolha uma opção:\",\n \"choices\": [\n \"[Produtos]\",\n \"Camiseta|p1|R$ 50\",\n \"Calça|p2|R$ 120\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Enquete", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/poll", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "poll" ] }, "description": "Envia enquete nativa do WhatsApp. Contatos votam e o resultado chega via webhook.\n\nEnquete (type poll): use choices (lista de opções) e selectableCount (quantas o usuário pode marcar; >1 = múltipla escolha). O WhatsApp aceita 12+ opções. Os votos chegam pelo webhook de mensagens como PollUpdateMessage com o campo vote já decifrado (texto da opção); em múltipla escolha vem a lista das opções atuais separada por vírgula, e voto removido vem vazio.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Qual o melhor dia?\",\n \"choices\": [\n \"Segunda\",\n \"Terça\",\n \"Quarta\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Botão PIX", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/pix-button", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "pix-button" ] }, "description": "Envia um botão de pagamento PIX nativo do WhatsApp. O contato pode copiar a chave e pagar diretamente.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"pixType\": \"EVP\",\n \"pixKey\": \"123e4567-e89b-12d3-a456-426614174000\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Solicitar Pagamento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/request-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "request-payment" ] }, "description": "Envia uma solicitação de pagamento com o botão nativo \"Revisar e pagar\" do WhatsApp. É obrigatório enviar pelo menos um método de pagamento: `pixKey`, `boletoCode`, `paymentLink` ou `allowCards: true`. Sem isso, a API retorna erro.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"amount\": 49.9\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Status / Story", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/status", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "status" ] }, "description": "Publica um status/story no WhatsApp (texto, imagem ou vídeo). Visível para todos os contatos por 24 horas.", "body": { "mode": "raw", "raw": "{\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Enviar Texto", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/text", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "text" ] }, "description": "Envia uma mensagem de texto simples para um número de WhatsApp. O número deve incluir o código do país (DDI), por exemplo: 5511999999999.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Olá! Tudo bem?\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Conversas", "item": [ { "name": "Arquivar Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/archive", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "archive" ] }, "description": "Arquiva uma conversa, ocultando-a da lista principal do WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\",\n \"archive\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Bloquear / Desbloquear Contato", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/block", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "block" ] }, "description": "⚠️ ATENÇÃO: Bloqueia um contato. NÃO use block: false . isso pode DESCONECTAR a instância inteira (bug conhecido da WhatsApp). Para desbloquear, use o próprio WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"block\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lista de Bloqueados", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/blocklist", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "blocklist" ] }, "description": "Retorna todos os contatos bloqueados pela instância." } }, { "name": "Deletar Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "delete" ] }, "description": "Deleta um chat inteiro. Pode limpar apenas no app ou também no banco de dados.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Buscar Chats", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/find", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "find" ] }, "description": "Busca chats com filtros avançados: por nome, label, status, grupo, e mais.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Silenciar Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/mute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "mute" ] }, "description": "Silencia notificações de uma conversa por um período em milissegundos. Exemplo: 86400000 = 24h.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ver Notas do Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes" ] }, "description": "Retorna as notas internas (privadas) associadas a um chat.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar Notas do Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes", "edit" ] }, "description": "Edita as notas internas de um chat. Notas são visíveis apenas para você.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Recarregar Notas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes/refresh", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes", "refresh" ] }, "description": "Recarrega as notas internas do WhatsApp para o banco local.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Fixar / Desfixar Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/pin", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "pin" ] }, "description": "Fixa ou desfixa uma conversa no topo da lista de chats do WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\",\n \"pin\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Marcar Chat como Lido", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/read", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "read" ] }, "description": "Marca todas as mensagens não lidas de uma conversa como lidas, zerando o contador de não lidas.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletar Mensagem", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "delete" ] }, "description": "Apaga uma mensagem enviada para todos os participantes do chat. So e possivel deletar mensagens enviadas pela propria instancia.", "body": { "mode": "raw", "raw": "{\n \"id\": \"ABCDEF123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download de Mídia", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/download", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "download" ] }, "description": "Faz o download de uma mídia recebida (imagem, vídeo, áudio, documento) a partir do ID da mensagem. O campo `id` deve vir do webhook ou do endpoint `/message/find`. Obs: o parâmetro transcribe é best-effort e pode não retornar a transcrição. Para transcrição garantida de áudios, use o módulo de IA.", "body": { "mode": "raw", "raw": "{\n \"id\": \"7EB0F01D7244B421048F0706368376E0\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar Mensagem", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "edit" ] }, "description": "Edita o texto de uma mensagem previamente enviada. Aparece com indicador de editada para o destinatario. So funciona com mensagens enviadas pela propria instancia.", "body": { "mode": "raw", "raw": "{\n \"id\": \"ABCDEF123456\",\n \"number\": \"5511999999999\",\n \"text\": \"Texto corrigido...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Histórico de Mensagens", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/find", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "find" ] }, "description": "Retorna o histórico de mensagens da instância. Filtre por `chatid` para buscar mensagens de uma conversa específica. Suporta paginação via `limit` e `offset`.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sincronizar Histórico", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/history-sync", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "history-sync" ] }, "description": "Solicita sincronizacao de historico de mensagens antigas de um chat. As mensagens chegam via webhook/SSE.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Marcar como Lida", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/markread", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "markread" ] }, "description": "Marca uma ou mais mensagens como lidas. Envie um array de IDs.", "body": { "mode": "raw", "raw": "{\n \"id\": [\n \"3EB0538DA65A59F6D8A251\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Indicador de Digitando...", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/presence", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "presence" ] }, "description": "Mostra \"digitando...\" ou \"gravando áudio...\" para o contato. O indicador some automaticamente após alguns segundos.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"presence\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reagir com Emoji", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/react", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "react" ] }, "description": "Envia uma reação (emoji) a uma mensagem existente. Envie emoji vazio para REMOVER a reação. O id deve ser o messageId achatado no formato OWNER:MSGID (ex: 5511999990000:2A6E2F02CE4125FDBA1B): não use o formato Baileys concatenado com JID, vai dar 404. O webhook de confirmação chega com messageType=ReactionMessage e inclui o atalho 'reaction' no envelope.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"id\": \"5511999990000:2A6E2F02CE4125FDBA1B\",\n \"emoji\": \"👍\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mensagens Temporárias (conversa privada)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/ephemeral", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "ephemeral" ] }, "description": "Liga ou desliga as mensagens temporárias (que somem sozinhas) numa conversa privada. Vale para as próximas mensagens da conversa. Duração em segundos, seguindo o padrão do WhatsApp: 0 desliga, 86400 = 24 horas, 604800 = 7 dias, 7776000 = 90 dias.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contatos e Perfil", "item": [ { "name": "Verificar Número", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/check", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "check" ] }, "description": "Verifica se um ou mais numeros estao registrados no WhatsApp. Retorna JID, nome verificado e status.", "body": { "mode": "raw", "raw": "{\n \"numbers\": \"[\\\"5511999999999\\\", \\\"5521888888888\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Detalhes do Contato", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/details", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "details" ] }, "description": "Retorna detalhes completos de um contato: nome, foto, status, verificação, e-commerce.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Adicionar Contato", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contact/add", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contact", "add" ] }, "description": "Adiciona um novo contato à agenda do WhatsApp conectado com nome e número.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\",\n \"name\": \"João Silva\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remover Contato", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contact/remove", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contact", "remove" ] }, "description": "Remove um contato da agenda do WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Contatos (Rápido)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contacts" ] }, "description": "Lista todos os contatos salvos na agenda do WhatsApp." } }, { "name": "Listar Contatos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contacts/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contacts", "list" ] }, "description": "Busca contatos com paginacao. Use limit e offset para navegar.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Foto", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/profile/image", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "profile", "image" ] }, "description": "Altera a imagem de perfil da sua instancia. Envie URL, base64 ou \"remove\" para remover.", "body": { "mode": "raw", "raw": "{\n \"image\": \"https://exemplo.com/logo.jpg\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Nome", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/profile/name", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "profile", "name" ] }, "description": "Altera o nome do perfil da sua instancia no WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Minha Empresa\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Grupos", "item": [ { "name": "Criar Comunidade", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/community/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "community", "create" ] }, "description": "Cria uma Comunidade do WhatsApp, estrutura que agrupa multiplos grupos sob um mesmo canal de anuncios central. O numero conectado sera o dono da comunidade.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Comunidade da Empresa\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Gerenciar Grupos da Comunidade", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/community/editgroups", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "community", "editgroups" ] }, "description": "Adiciona ou remove grupos de uma comunidade existente. Use action: add ou action: remove com o array de JIDs de grupos.", "body": { "mode": "raw", "raw": "{\n \"community\": \"120363000000000001@g.us\",\n \"action\": \"\",\n \"groups\": [\n \"120363000000000000@g.us\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Criar Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "create" ] }, "description": "Cria um novo grupo do WhatsApp com os participantes indicados. O número conectado é automaticamente adicionado como administrador. Nome: mín. 1, máx. 100 caracteres. Máximo de 50 participantes.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Meu Time\",\n \"participants\": \"[\\\"5511999990001\\\",\\\"5511999990002\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Informações do Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "info" ] }, "description": "Retorna detalhes completos de um grupo: nome, descrição, participantes, admins, data de criação e configurações. Use `getInviteLink: true` para incluir o link de convite na resposta.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Info pelo Convite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/inviteInfo", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "inviteInfo" ] }, "description": "Obtem informacoes de um grupo pelo codigo ou link de convite.", "body": { "mode": "raw", "raw": "{\n \"invitecode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Entrar em Grupo via Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/join", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "join" ] }, "description": "Faz a instância entrar em um grupo utilizando um link de convite do WhatsApp. Aceita a URL completa (https://chat.whatsapp.com/...) ou apenas o código.", "body": { "mode": "raw", "raw": "{\n \"invitecode\": \"https://chat.whatsapp.com/XXXXXXXXXXXXXXXX\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sair do Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/leave", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "leave" ] }, "description": "Remove o número conectado do grupo especificado. Esta ação não pode ser desfeita pelo sistema. Funciona também para sair de comunidades.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Grupos", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "list" ] }, "description": "Lista todos os grupos do WhatsApp. Retorna array com JID, nome e dados de cada grupo." } }, { "name": "Buscar Grupos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "list" ] }, "description": "Lista grupos com opcao de incluir participantes. Retorna objeto com array \"groups\".", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resetar Código de Convite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/resetInviteCode", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "resetInviteCode" ] }, "description": "Gera um novo codigo de convite para o grupo. O link anterior sera invalidado.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Modo Somente Admins", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateAnnounce", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateAnnounce" ] }, "description": "Ativa ou desativa o modo em que apenas administradores podem enviar mensagens. Ideal para canais de comunicação unidirecional.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"announce\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Descrição do Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateDescription", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateDescription" ] }, "description": "Altera a descricao do grupo. Descricao vazia nao e permitida.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"description\": \"Descrição do grupo...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Foto do Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateImage", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateImage" ] }, "description": "Altera a imagem do grupo. Envie URL da imagem ou \"remove\" para remover.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"image\": \"https://exemplo.com/foto.jpg ou \\\"remove\\\"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Bloquear Edição do Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateLocked", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateLocked" ] }, "description": "Quando ativado, apenas administradores podem alterar nome, foto e descrição do grupo.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"locked\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Renomear Grupo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateName", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateName" ] }, "description": "Altera o nome de exibição do grupo. Mín. 1 e máx. 25 caracteres. Requer que o número conectado seja administrador.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"name\": \"Nome do grupo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Gerenciar Participantes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateParticipants", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateParticipants" ] }, "description": "Gerencia participantes do grupo. Adicionar, remover, promover ou rebaixar.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"action\": \"\",\n \"participants\": \"[\\\"5511999990003\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mensagens Temporárias (grupo)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/ephemeral", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "ephemeral" ] }, "description": "Liga ou desliga as mensagens temporárias no grupo. Duração em segundos, padrão do WhatsApp: 0 desliga, 86400 = 24 horas, 604800 = 7 dias, 7776000 = 90 dias.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Exigir Aprovação para Entrar", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateJoinApproval", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateJoinApproval" ] }, "description": "Define se a entrada de novos membros no grupo precisa da aprovação de um administrador.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"IsJoinApprovalRequired\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Quem Pode Adicionar Membros", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateMemberAddMode", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateMemberAddMode" ] }, "description": "Define quem pode adicionar novos membros ao grupo: só administradores ou qualquer participante.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"MemberAddMode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Newsletters e Canais", "item": [ { "name": "Aceitar Convite de Admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/accept", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "accept" ] }, "description": "Aceita um convite para ser admin de um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Convidar Admin do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/invite", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "invite" ] }, "description": "Convida um número para ser admin de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remover Admin do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/remove", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "remove" ] }, "description": "Remove um admin de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revogar Convite de Admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/revoke", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "revoke" ] }, "description": "Revoga um convite de admin pendente. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Criar Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "create" ] }, "description": "Cria um novo canal (newsletter) do WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Canal de Promoções\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletar Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "delete" ] }, "description": "Deleta um canal que você administra.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Descrição do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/description", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "description" ] }, "description": "Atualiza a descrição de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Seguir Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/follow", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "follow" ] }, "description": "Segue um canal para receber suas publicações.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Info do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "info" ] }, "description": "Obtém informações detalhadas de um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Buscar Canal por Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/link", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "link" ] }, "description": "Busca informações de um canal pelo link/chave de convite.", "body": { "mode": "raw", "raw": "{\n \"key\": \"AbCdEfGhIjKlMn\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Canais", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "list" ] }, "description": "Lista todos os canais em que a instância está inscrita." } }, { "name": "Mensagens do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages" ] }, "description": "Busca mensagens publicadas em um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deletar Mensagem do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages", "delete" ] }, "description": "Deleta uma mensagem de um canal que você administra.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Editar Mensagem do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages", "edit" ] }, "description": "Edita uma mensagem recente de um canal que você administra.", "body": { "mode": "raw", "raw": "{\n \"text\": \"Post atualizado\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Silenciar Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/mute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "mute" ] }, "description": "Silencia notificações de um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Nome do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/name", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "name" ] }, "description": "Atualiza o nome de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Canal de Promoções VIP\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Transferir Dono do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/owner/transfer", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "owner", "transfer" ] }, "description": "Transfere a propriedade do canal para outro número.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Alterar Foto do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/picture", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "picture" ] }, "description": "Atualiza a foto de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"picture\": \"https://example.com/newsletter.png\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reagir a Post do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/reaction", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "reaction" ] }, "description": "Reage a um post de um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pesquisar Canais", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/search", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "search" ] }, "description": "Pesquisa canais públicos por texto, país ou categoria.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Configurações do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/settings", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "settings" ] }, "description": "Atualiza configurações do canal (ex: códigos de reação permitidos). (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{\n \"reactionCodes\": \"basic\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assinar Updates do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "subscribe" ] }, "description": "Assina updates temporários de um canal para receber notificações.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Deixar de Seguir", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/unfollow", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "unfollow" ] }, "description": "Deixa de seguir um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reativar Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/unmute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "unmute" ] }, "description": "Reativa notificações de um canal.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Updates do Canal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/updates", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "updates" ] }, "description": "Busca atualizações de mensagens de um canal. (Nota: pode retornar erro GraphQL dependendo da versão da WhatsApp)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Marcar como Visualizado", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/viewed", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "viewed" ] }, "description": "Marca posts do canal como visualizados.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Campanhas", "item": [ { "name": "Disparar Campanha em Lote", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/advanced", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "advanced" ] }, "description": "Dispara mensagens em lote com conteudo individualizado por destinatario. Cada item do array messages pode ter numero e texto diferentes.", "body": { "mode": "raw", "raw": "{\n \"messages\": \"[{\\\"number\\\":\\\"5511999999999\\\",\\\"text\\\":\\\"Olá!\\\"}]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Limpar Toda a Fila", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/clearall", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "clearall" ] }, "description": "Limpa toda a fila de mensagens, incluindo pendentes e em andamento." } }, { "name": "Limpar Campanhas Concluídas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/cleardone", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "cleardone" ] }, "description": "Remove da lista todas as campanhas com status concluído dentro da pasta informada.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Controlar Campanha", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "edit" ] }, "description": "Controla uma campanha de envio em massa: pausar, retomar ou cancelar.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_123\",\n \"action\": \"stop\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Campanhas", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/listfolders", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "listfolders" ] }, "description": "Lista todas as campanhas/pastas de envio em massa. Retorna array direto." } }, { "name": "Listar Mensagens da Campanha", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/listmessages", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "listmessages" ] }, "description": "Retorna as mensagens de uma campanha especifica com status de envio e paginacao.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disparar Mensagem Simples", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/simple", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "simple" ] }, "description": "Dispara uma mensagem para uma lista de numeros com delay aleatorio entre cada envio. Retorna um folder_id para acompanhamento.", "body": { "mode": "raw", "raw": "{\n \"numbers\": \"[\\\"5511999999999\\\",\\\"5511888888888\\\"]\",\n \"type\": \"\",\n \"delayMin\": 1,\n \"delayMax\": 5\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Chamadas", "item": [ { "name": "Fazer Chamada", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/call/make", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "call", "make" ] }, "description": "Inicia uma chamada de voz para um numero do WhatsApp. A chamada toca no destino mas nao estabelece comunicacao de voz real.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Rejeitar Chamada", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/call/reject", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "call", "reject" ] }, "description": "Rejeita uma chamada recebida.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "WhatsApp Business", "item": [ { "name": "Deletar Produto do Catálogo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "delete" ] }, "description": "Remove permanentemente produtos do catálogo do WhatsApp Business. Envie um array de IDs no campo `productIds`. Atenção: timeout (504) pode ocorrer se os IDs forem inválidos.", "body": { "mode": "raw", "raw": "{\n \"productIds\": \"[\\\"prod_abc123\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ocultar Produto do Catálogo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/hide", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "hide" ] }, "description": "Oculta um produto do catálogo público sem removê-lo. ⚠️ Pode retornar erro 501 em contas que não suportam esta feature . é uma limitação do WhatsApp, não da API.", "body": { "mode": "raw", "raw": "{\n \"id\": \"prod_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Info do Produto", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "info" ] }, "description": "Retorna informações detalhadas de um produto específico do catálogo.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999@s.whatsapp.net\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Catálogo de Produtos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "list" ] }, "description": "Retorna todos os produtos cadastrados no catálogo do WhatsApp Business do JID informado.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Exibir Produto no Catálogo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/show", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "show" ] }, "description": "Torna um produto visível no catálogo público do WhatsApp Business. ⚠️ Pode retornar erro 501 em contas que não suportam esta feature . é uma limitação do WhatsApp, não da API.", "body": { "mode": "raw", "raw": "{\n \"id\": \"prod_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Categorias Comerciais", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/get/categories", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "get", "categories" ] }, "description": "Retorna a lista de categorias disponíveis para o perfil comercial do WhatsApp Business." } }, { "name": "Ver Perfil Comercial", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/get/profile", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "get", "profile" ] }, "description": "Retorna os dados do perfil comercial do WhatsApp Business: descrição, endereço, e-mail, site e categorias. Envie o `jid` com o número (sem @s.whatsapp.net). Obrigatório informar o número.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Atualizar Perfil Comercial", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/update/profile", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "update", "profile" ] }, "description": "Atualiza os dados do perfil do WhatsApp Business. É obrigatório enviar pelo menos um dos campos: `description`, `address` ou `email`. Atenção: este endpoint pode retornar 403 forbidden se a instância não for do tipo Business.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Configurações", "item": [ { "name": "Aplicar Etiqueta ao Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/labels", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "labels" ] }, "description": "Gerencia labels (etiquetas) de um chat. Use `labelids` para definir todas as labels de uma vez, `add_labelid` para adicionar uma label, ou `remove_labelid` para remover. Envie apenas um desses campos por requisição.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Conectar Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/connect", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "connect" ] }, "description": "Conecta a instância ao WhatsApp. Necessário escanear QR code após esta chamada.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Desconectar Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "disconnect" ] }, "description": "Desconecta a instancia do WhatsApp. Sera necessario escanear o QR code novamente para reconectar." } }, { "name": "Status de Presença", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/presence", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "presence" ] }, "description": "Define se a instância aparece como online ou offline para os contatos.", "body": { "mode": "raw", "raw": "{\n \"presence\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ver Privacidade", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/privacy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "privacy" ] }, "description": "Retorna as configurações de privacidade da conta: quem pode adicionar em grupos, ver último acesso, foto de perfil e confirmações de leitura." } }, { "name": "Alterar Privacidade", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/privacy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "privacy" ] }, "description": "Atualiza as configurações de privacidade. Todos os campos são opcionais . envie apenas o que deseja alterar.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Ver Proxy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/proxy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "proxy" ] }, "description": "Retorna a configuração de proxy da instância." } }, { "name": "Configurar Proxy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/proxy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "proxy" ] }, "description": "Configura, altera ou REMOVE o proxy da instância. O campo canônico é `mode`: `custom` (proxy próprio, exige proxy_url), `internal` (proxy gerenciado pelo serviço) ou `none` (remove o proxy, exige confirm_no_proxy=true). Para remover o proxy, envie mode=none e confirm_no_proxy=true.", "body": { "mode": "raw", "raw": "{\n \"mode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reiniciar Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/reset", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "reset" ] }, "description": "Reinicia o runtime da instancia. Se a instancia estiver desconectada, sera necessario escanear o QR code novamente." } }, { "name": "Informações & Status da Instância", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/status", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "status" ] }, "description": "Retorna dados completos da instância: nome, número de telefone conectado, foto de perfil e status atual da conexão (disconnected, connecting, connected)." } }, { "name": "Configurar Delay", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateDelaySettings", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateDelaySettings" ] }, "description": "Configura o delay minimo e maximo entre mensagens na fila. Retorna o objeto completo da instancia.", "body": { "mode": "raw", "raw": "{\n \"msg_delay_min\": 0,\n \"msg_delay_max\": 2\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Renomear Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateInstanceName", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateInstanceName" ] }, "description": "Atualiza o nome interno da instancia. Retorna o objeto completo da instancia.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Minha Nova Instância 2024!@#\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Criar / Editar Etiqueta", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/label/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "label", "edit" ] }, "description": "Cria uma nova etiqueta ou edita/deleta uma existente. Para criar, use labelid \"0\" com name e color. Para editar, use o labelid real. Cor: numero de 0 a 19.", "body": { "mode": "raw", "raw": "{\n \"labelid\": \"0\",\n \"name\": \"Cliente VIP\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Etiquetas", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/labels", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "labels" ] }, "description": "Retorna todas as etiquetas criadas na instância." } }, { "name": "Recarregar Etiquetas", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/labels/refresh", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "labels", "refresh" ] }, "description": "Recarrega as etiquetas do WhatsApp para sincronizar com o banco local.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Criar / Editar Resposta Rápida", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/quickreply/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "quickreply", "edit" ] }, "description": "Cria ou atualiza um atalho de resposta rápida. Ao digitar \"/\" seguido do atalho no WhatsApp, a mensagem completa é sugerida. Para editar, envie o campo `id`.", "body": { "mode": "raw", "raw": "{\n \"shortCut\": \"bom-dia\",\n \"text\": \"Bom dia! Como posso te ajudar hoje?\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Respostas Rápidas", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/quickreply/showall", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "quickreply", "showall" ] }, "description": "Retorna todas as respostas rápidas configuradas na instância." } } ] }, { "name": "Webhooks e Eventos", "item": [ { "name": "Server-Sent Events (SSE)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sse", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sse" ] }, "description": "Abre conexão Server-Sent Events para receber eventos em tempo real." } }, { "name": "Ver Webhook da Instância", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook" ] }, "description": "Retorna a configuracao de webhooks da instancia. A resposta e sempre um array, mesmo com um unico webhook." } }, { "name": "Configurar Webhook da Instância", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook" ] }, "description": "Gerencia webhooks da instancia. Suporta modo simples (sem action) e modo multi-webhook (com action: add/update/delete). Para deletar, envie id + action \"delete\". Os eventos vêm DESATIVADOS por padrão. Ligue só os que for consumir (evita tráfego desnecessário). Eventos de volume alto (presence, history) só ligue se realmente for tratar.", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Erros do Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook/errors", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook", "errors" ] }, "description": "Lista os últimos erros de entrega do webhook." } }, { "name": "Entregas Recentes do Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook/deliveries?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook", "deliveries" ], "query": [ { "key": "limit", "value": "50", "description": "Quantidade (máx 100)" } ] }, "description": "Lista as últimas entregas de webhook desta instância (janela recente, para depurar): evento, se foi entregue, status HTTP, latência, número da tentativa e horário. Útil pra conferir se o seu endpoint está recebendo e respondendo 2xx." } } ] }, { "name": "Fila Async", "item": [ { "name": "Limpar Fila Async", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/async", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "async" ] }, "description": "Limpa toda a fila de mensagens async." } }, { "name": "Ver Fila Async", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/async", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "async" ] }, "description": "Consulta a fila de mensagens async pendentes." } } ] }, { "name": "Chatbot e IA", "item": [ { "name": "Criar/Editar Agente IA", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/agent/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "agent", "edit" ] }, "description": "Cria, edita ou deleta um agente de IA para atendimento automático. Enviar id vazio para criar; preenchido para editar; delete=true para deletar.", "body": { "mode": "raw", "raw": "{\n \"agent\": {\n \"name\": \"Assistente\",\n \"provider\": \"openai\",\n \"apikey\": \"sk-...\",\n \"model\": \"gpt-4o-mini\",\n \"basePrompt\": \"Voce é um assistente...\",\n \"maxTokens\": 2000,\n \"temperature\": 70,\n \"diversityLevel\": 50,\n \"frequencyPenalty\": 30,\n \"presencePenalty\": 30,\n \"signMessages\": true,\n \"readMessages\": true,\n \"maxMessageLength\": 500,\n \"typingDelay_seconds\": 3,\n \"contextTimeWindow_hours\": 24,\n \"contextMaxMessages\": 50,\n \"contextMinMessages\": 3\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Agentes IA", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/agent/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "agent", "list" ] }, "description": "Lista todos os agentes de IA configurados na instancia. Retorna array vazio se nenhum agente existir." } }, { "name": "Criar/Editar Função API", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/function/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "function", "edit" ] }, "description": "Cria, edita ou deleta uma funcao de API para integracao com servicos externos. Envie id vazio para criar, preenchido para editar, delete=true para deletar.", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"delete\": \"\",\n \"function\": {\n \"name\": \"minha_funcao\",\n \"description\": \"Descricao da funcao\",\n \"active\": false,\n \"method\": \"GET\",\n \"endpoint\": \"https://api.example.com/endpoint\",\n \"headers\": {},\n \"body\": {},\n \"parameters\": []\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Funções API", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/function/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "function", "list" ] }, "description": "Lista todas as funcoes de API configuradas. Retorna array vazio se nenhuma funcao existir." } }, { "name": "Criar/Editar Conhecimento", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/knowledge/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "knowledge", "edit" ] }, "description": "Cria ou edita base de conhecimento para os agentes de IA. (Requer OpenAI API key configurada na instância)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Conhecimentos", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/knowledge/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "knowledge", "list" ] }, "description": "Lista toda a base de conhecimento dos agentes. Retorna array vazio se nenhum conhecimento existir." } }, { "name": "Criar/Editar Trigger", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/trigger/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "trigger", "edit" ] }, "description": "Cria, edita ou deleta um trigger de chatbot. Requer um agente existente (agent_id).", "body": { "mode": "raw", "raw": "{\n \"trigger\": {\n \"active\": true,\n \"type\": \"agent\",\n \"agent_id\": \"id_do_agente\",\n \"ignoreGroups\": true,\n \"priority\": 1,\n \"wordsToStart\": \"ola|oi|iniciar\",\n \"responseDelay_seconds\": 3,\n \"lead_field\": \"\",\n \"lead_operator\": \"\",\n \"lead_value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Listar Triggers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/trigger/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "trigger", "list" ] }, "description": "Lista todos os triggers de chatbot configurados. Retorna array vazio se nenhum trigger existir." } } ] }, { "name": "CRM e Leads", "item": [ { "name": "Editar Lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/editLead", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "editLead" ] }, "description": "Edita dados de lead de um contato. O ID deve incluir @s.whatsapp.net.", "body": { "mode": "raw", "raw": "{\n \"id\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Campos Personalizados de Lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateFieldsMap", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateFieldsMap" ] }, "description": "Define os nomes dos campos de lead. Campos sao flat (lead_field01, lead_field02, etc).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Integração Chatwoot", "item": [ { "name": "Ver Config Chatwoot", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chatwoot/config", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chatwoot", "config" ] }, "description": "Retorna a configuracao atual da integracao com Chatwoot, incluindo status da conexao." } }, { "name": "Configurar Chatwoot", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chatwoot/config", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chatwoot", "config" ] }, "description": "Atualiza a configuracao da integracao Chatwoot. Os campos usam prefixo chatwoot_. Integracao em beta.", "body": { "mode": "raw", "raw": "{\n \"chatwoot_enabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Fluxos", "item": [ { "name": "Listar Fluxos", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flows", "host": [ "{{baseUrl}}" ], "path": [ "flows" ] }, "description": "Lista todos os fluxos do usuario, incluindo status (habilitado/desabilitado) e tipo de gatilho." } }, { "name": "Disparar Fluxo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flows/{{flowId}}/trigger", "host": [ "{{baseUrl}}" ], "path": [ "flows", "{{flowId}}", "trigger" ] }, "description": "Dispara um fluxo para um contato especifico. O fluxo precisa estar habilitado e a instancia conectada. Variaveis opcionais ficam disponiveis dentro do fluxo como {nome_da_variavel}. Ao chegar num bloco de webhook, todas as variaveis coletadas (respostas, cliques, dados do contato) sao enviadas para a URL configurada.", "body": { "mode": "raw", "raw": "{\n \"instance_id\": \"inst-456\",\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Traqueamento Meta", "item": [ { "name": "Registrar venda de um lead de anúncio", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/tracking/conversion", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "tracking", "conversion" ] }, "description": "Avisa que um lead que veio de anúncio virou venda. É o que permite a Meta aprender quem realmente compra, em vez de otimizar só por quem responde mensagem. Use quando o pagamento for confirmado no seu sistema. Chamar duas vezes para a mesma venda não duplica.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }