Central de ajuda
API
Integre o Pipe ao seu sistema: chaves, mensagens, contatos, campanhas e webhooks.
17 artigos em API
- API do Pipe: visão geral e primeira chamadaEntenda o que a API do Pipe faz, escolha entre API, MCP e Builder e faça sua primeira chamada com uma chave de API em poucos minutos.
- Autenticação e chaves de APICrie uma chave de API na Gestão, use o cabeçalho Bearer ou Key, entenda chave de fluxo, de organização e de IA e saiba restringir por IP.
- Escopos e permissões da chave de APIVeja o que cada escopo da chave de API libera, quais vêm por padrão, como o fluxo limita a chave e o que fazer ao receber 403 ou 404.
- Erros, respostas e paginação da APIEntenda o formato de erro da API do Pipe, os códigos HTTP mais comuns, como paginar listas com cursor e como tratar cada falha.
- Limites de uso e idempotência na APIConheça os limites de chamadas por chave, de corpo e de arquivo, e use o cabeçalho Idempotency-Key para repetir escritas sem duplicar nada.
- Versões e notas de versão da APIAcompanhe o que mudou na API do Pipe, com datas, quebras de compatibilidade e novas rotas, e saiba como o versionamento por /v1 funciona.
- Enviar mensagens pela API: texto, mídia e modelosEnvie texto, imagem, áudio, vídeo, documento, localização, contato e modelos em um ticket, reaja, responda uma mensagem e reenvie falhas.
- Contatos pela API: criar, buscar, editar e etiquetarCrie ou encontre contatos sem duplicar, busque por telefone, e-mail ou documento, edite campos e atributos, etiquete e leia o histórico do contato.
- Contexto do contato e sessões do bot pela APILeia e grave variáveis do bot em um contato, mude o bloco em que ele está e encontre quem ficou preso na conversa automática, sem ticket.
- Conversas e tickets pela APIAbra tickets para contatos, liste e filtre conversas, transfira, encerre, ponha em espera, etiquete e consulte filas, atendentes e horário.
- Mensagens ativas e campanhas pela APIDispare modelos aprovados para até 15 contatos de uma vez ou crie campanhas de até 5000 destinatários, com agendamento, relatório e cancelamento.
- Agendar mensagens pela APIAgende uma mensagem de texto ou um modelo para um contato em data futura, consulte o resultado, filtre por status e cancele antes da hora.
- Relatórios e monitoramento pela APIPuxe relatórios de atendimento, esforço e satisfação, o histórico de tickets encerrados em JSON ou CSV e os contadores do dia para seu painel.
- Webhooks e eventos que o Pipe enviaReceba eventos de tickets, mensagens, contatos e SLA no seu sistema, valide a assinatura HMAC, entenda as tentativas e consulte as entregas por API.
- Consultar etiquetas, respostas, regras e modelosLeia pela API os cadastros do atendimento: etiquetas, respostas rápidas, modelos de mensagem, regras de atribuição e prioridade, filas e atendentes.
- Compatibilidade com a Blip: comandos e envelopesUse comandos, mensagens e notificações no formato da Blip na API do Pipe, com Authorization Key, e veja o que é igual, o que muda e o que não existe.
- Limitações da API do PipeSaiba o que a API por chave não faz, como cadastrar canais, ligações, webhooks e modelos, e quais alternativas existem na Gestão, no Builder e no MCP.