API · Atualizado em 12/10/2026
Versões e notas de versão da API
Acompanhe o que mudou na API do Pipe, com datas, quebras de compatibilidade e novas rotas, e saiba como o versionamento por /v1 funciona.
A API do Pipe é versionada pelo caminho: as rotas estáveis ficam sob /v1. Hoje existe só a versão 1. Esta página lista o que entrou ou mudou, e marca como quebra o que alterou uma resposta já existente.
Quando usar
Antes de atualizar uma integração, para saber se algo que ela usa mudou, e ao investigar um comportamento diferente do esperado.
Como ler as notas
- Novo: rota, campo ou escopo adicionado.
- Quebra: o comportamento de algo que existia mudou. Revise a integração.
- Correção: um erro foi consertado e o comportamento correto é o que está descrito.
Outubro de 2026
08/10/2026: envio no estilo Blip e fidelidade de comandos
- Novo:
POST /messagesePOST /notificationsna raiz do endereço, no formato de envelope da Blip. Resposta 202 sem corpo quando aceita. Recusas por regra voltam como HTTP 200 com notificaçãofailed. - Novo:
POST /commandsna raiz, comAuthorization: Key. Escopo ausente responde HTTP 200 comfailure66 nesse perfil. - Novo: a chave "Compatível com a Blip" na criação.
- Novo: mais caminhos de comando: histórico do cliente (
/threads), contatos em lista, etiquetas por nome, atribuição a atendente, cadastros em leitura, relatórios e contadores, agendamentos e modelos. - Quebra (só no perfil Blip da raiz): a chave de roteador deixa de ver o Desk dos serviços. Em
/v1isso não mudou. - Quebra (só no perfil Blip da raiz): o contexto de uma chave de roteador passa a ser o contexto compartilhado do roteador.
08/10/2026: correções de segurança e robustez
- Novo: limite de 20 falhas de autenticação por minuto por IP, com 429 e
Retry-After. - Correção:
POST /v1/attachmentssó lê o corpo depois de autenticar. Sem credencial válida, 401 imediato. - Correção: nomes de campo inválidos em filtros dos comandos (
constructor,__proto__) dãofailure64 em vez de erro 500. - Correção: telefones sem
+em comandos de contato têm os não dígitos removidos. - Novo: a chave pode ter lista de IPs permitidos (
ip_permitidos), com 403ip_not_allowed.
07/10/2026 e 08/10/2026: paridade com a Blip
- Novo:
POST /v1/contacts/:id/ticketsePOST /v1/ticketspara abrir ticket por chave, adotando a sessão do bot. - Novo:
GET /v1/bot-sessionseGET /v1/contacts/:id/bot-sessionpara achar contatos presos no bot. - Novo: contexto e bloco do contato:
GET/PUT/DELETE /v1/contacts/:id/context[/:name]ePUT /v1/contacts/:id/bot-state. - Novo:
GET/POST /v1/scheduleseGET/DELETE /v1/schedules/:id. - Novo: leitura de webhooks (
GET /v1/webhooks) e de modelos (GET /v1/channels/:id/templates). - Novo: relatórios por chave:
GET /v1/reports/attendance,effort,satisfaction,historyeGET /v1/monitoring/summary, com o escoporelatorios:ler. - Novo: filtros de histórico em
GET /v1/conversations(closed,from,to,label_id,sequential_id) e fechamento como cliente (closedBy: "cliente"). - Novo:
GET /v1/contacts/:id/messagescom a conversa inteira do contato, incluindo o bot. - Novo:
Idempotency-Key, limite de chamadas por chave e auditoria das escritas por chave. - Novo: campanhas por chave em
/v1/campaigns. - Quebra:
POST /v1/agents/statusexigeatendentes:escrever. Quem tinha sóatendentes:lerrecebe 403without_scope. - Quebra:
POST /v1/contactsagora cria ou encontra o contato. Repetir o telefone devolve 200 comcreated: false, em vez de criar outro contato. Para o comportamento estrito, use?upsert=false, que responde 409 se o contato existir. - Novo e migração: chaves de fluxo passam a nascer com
filas:ler,atendentes:lerecontatos:escrever. As chaves de fluxo que já existiam receberam os mesmos três escopos por migração.
Mensagens e mídia
- Novo: reações (
POST /v1/conversations/:id/messages/:messageId/reaction), o evento de webhookmensagem.reacaoe o estado de entregareproduzida. - Novo: mensagens de localização e de contato e botões dinâmicos de modelo.
- Novo:
errorTextem português para os códigos de erro da Meta mais comuns. - Quebra: texto acima de 4096 caracteres passa a dar 422
text_too_long. - Quebra: mídia que o WhatsApp não aceita é recusada com 422 (por exemplo, áudio WAV) ou reclassificada (imagem GIF vira documento), com o aviso em
warning.
Resultado esperado
Você sabe se alguma mudança afeta sua integração e o que revisar.
Problemas comuns
- Uma chave antiga recebe 403 depois de uma mudança: quase sempre é um escopo novo exigido por uma rota. Veja Escopos e permissões.
- Contato duplicado em integração antiga: se ela contava com a criação sempre nova, ajuste para o comportamento de buscar ou criar.
Boas práticas
- Ignore campos que você não conhece nas respostas. Campos novos podem aparecer sem aviso.
- Não dependa da ordem das chaves do JSON nem do texto das mensagens de erro.
- Reveja esta página antes de cada atualização da sua integração.
Próximos passos
- Veja o panorama completo em API do Pipe: visão geral.
- Para a camada estilo Blip, leia Compatibilidade com a Blip.
Perguntas frequentes
Como a API é versionada?
Pelo prefixo do caminho. Todas as rotas estáveis ficam em /v1. Hoje existe só a versão 1.
Onde vejo as quebras de compatibilidade?
Nesta página. Cada nota marca o que muda para quem já integra, em especial o que passa a responder diferente.
Chaves antigas ganham escopos novos sozinhas?
Em geral não. Escopos novos são concedidos na criação da chave. A exceção documentada foi a migração de outubro de 2026, que deu três escopos às chaves de fluxo existentes.
Esse artigo foi útil?
Obrigado pelo retorno!