Docs
Páginas desta seção

Filtros de leads e conversas

Por recurso

  • Autenticação
  • Usuário
  • Workspaces
  • Departamentos
  • Chaves de API
  • Especificação da API
  • Eventos
  • Webhooks
  • Auditoria
  • Conversas
  • Mensagens agendadas
  • Notas internas
  • Atalhos de mensagem
  • Dados da conversa
  • Etiquetas
  • Funis
  • Etapas
  • CRM
  • Visões salvas
  • Leads
  • Memórias do lead
  • Campos personalizados
  • Carteira de clientes
  • Negociações
  • Negociações automáticas
  • Chamados
  • Chat da equipe
  • WhatsApp: cadastro
  • WhatsApp: contas
  • WhatsApp: números
  • WhatsApp: modelos
  • WhatsApp: formulários
  • WhatsApp: campanhas
  • WhatsApp: iniciar conversa
  • WhatsApp não oficial: instâncias
  • WhatsApp não oficial: campanhas
  • WhatsApp não oficial: grupos
  • Instagram
  • Facebook
  • TikTok
  • Telegram
  • Mercado Livre
  • WebChat
  • RCS e SMS
  • E-mail: domínios e caixas
  • E-mail: campanhas
  • E-mail: API transacional
  • Público de campanhas
  • Rascunhos de campanha
  • Troncos SIP
  • Filas de atendimento
  • Listas de ligação
  • Campanhas de ligação
  • Histórico de chamadas
  • Gravações de chamadas
  • Cobrança de chamadas
  • Agentes
  • Fluxos
  • Segredos do workspace
  • Automações
  • Elo
  • Mídia gerada com IA
  • Estúdio
  • Métricas de atendimento
  • Pesquisas de satisfação
  • SLA
  • Relatórios
  • Análises
  • Anúncios
  • Páginas
  • Páginas: rotas públicas
  • Central de ajuda
  • Links curtos
  • Mídias
  • Google
  • Google Planilhas
  • Lojas e infoprodutos
  • Sincronização com CRM
  • Agenda
  • Saldo
  • Faturas
  • Add-ons
  • Preços
  • Afiliados
  • Notificações
  • Tutoriais
  • CEP
  • WebSockets
  • Webhooks recebidos

Referência

Códigos HTTP

O que cada status HTTP quer dizer nesta API e o formato das respostas de erro.

StatusSignificado
200Sucesso.
201Recurso criado.
202Pedido aceito para processamento em segundo plano.
204Sucesso, sem corpo.
400Um campo está ausente ou inválido, ou o corpo não é um JSON válido.
401Credencial ausente, inválida, expirada ou encerrada.
402Saldo insuficiente ou plano sem o recurso.
403Sem permissão no workspace, ou fora do departamento.
404O recurso não existe neste workspace.
409Conflito com o estado atual do recurso.
413O corpo passa do tamanho permitido.
422O pedido está bem formado, mas o conteúdo não pode ser aceito.
428Falta o cabeçalho If-Match com a versão do recurso.
429Limite de requisições atingido.
500Erro inesperado.
502Um serviço externo recusou ou falhou.
503Um serviço necessário está indisponível naquele momento.

As respostas de erro trazem um corpo JSON:

json
{
  "error": true,
  "code": "read_permission_required",
  "message": "Insufficient permissions: requires leads:read in this workspace",
  "expected": {
    "required_permission": "leads:read"
  }
}

Decida o que fazer pelo status e pelo code, que é estável; a message é para pessoas e pode mudar. Os códigos de cada rota estão na descrição dela. O formato completo, as exceções e como tratar cada status estão no guia Erros.