API da Profluxus — Referência

2 resultado(s) para "profluxus/leads"

GET/api/v1/accounts/:account_id/profluxus/leadsdocumentadoProfluxustestar

Leads por período, caixa e agente

Uma linha por contato (ou por conversa) com os dados de atendimento já cruzados: cadastro, última mensagem, agente, status e etiquetas.

Responde de uma vez o que antes exigia juntar conversas, contatos e mensagens na mão. Sem formato=csv a resposta vem em JSON paginado; com formato=csv vem o arquivo pronto para planilha. É preciso informar pelo menos um recorte de tempo.

Acesso: Token de um administrador da conta, no cabeçalho api_access_token.

Parâmetros

`created_after`	data · query	Conversas criadas a partir desta data. Pelo menos um entre created_after, created_before e updated_after é obrigatório.
`created_before`	data · query	Conversas criadas até esta data.
`updated_after`	data · query	Conversas movimentadas a partir desta data.
`inbox_ids`	lista · query	Restringe às caixas de entrada informadas.
`assignee_ids`	lista · query	Restringe aos agentes atribuídos.
`status`	lista · query	open, pending, resolved ou snoozed.
`with_labels`	lista · query	Só quem tem estas etiquetas.
`without_labels`	lista · query	Exclui quem tem estas etiquetas.
`agrupar`	texto · query	contato (padrão): cada pessoa uma vez, com a conversa mais recente e o total do período. conversa: cada conversa vira uma linha.
`page`	número · query	Página. Repita aumentando enquanto has_more for verdadeiro.
`per_page`	número · query	Padrão 100, máximo 500.
`formato`	texto · query	csv devolve o arquivo em vez do JSON.

Chamada

curl -G "https://talk.profluxus.com/api/v1/accounts/66/profluxus/leads" \
  -H "api_access_token: SEU_TOKEN" \
  --data-urlencode "created_after=2026-08-01" \
  --data-urlencode "created_before=2026-09-02" \
  --data-urlencode "inbox_ids[]=12" \
  --data-urlencode "agrupar=contato"

Resposta

{
  "meta": {
    "total": 812, "count": 100, "page": 1, "per_page": 100,
    "has_more": true, "next_page": 2,
    "filtros": {
      "created_after": "2026-08-01T00:00:00-03:00",
      "created_before": "2026-09-02T23:59:59-03:00",
      "inbox_ids": [12], "assignee_ids": [], "status": [],
      "with_labels": [], "without_labels": [], "agrupar": "contato"
    }
  },
  "leads": [
    {
      "contato_id": 48213,
      "nome": "Maria Souza",
      "telefone": "+5531999998888",
      "telefone_digitos": "5531999998888",
      "email": "[email protected]",
      "identificador": null,
      "contato_criado_em": "2026-08-14T10:22:31-03:00",
      "etiquetas_contato": ["socio"],
      "conversa_id": 125852,
      "conversa_criada_em": "2026-08-14T10:22:35-03:00",
      "ultima_mensagem_em": "2026-08-20T18:05:12-03:00",
      "ultima_mensagem_do_contato_em": "2026-08-20T17:58:40-03:00",
      "primeira_mensagem_do_contato_em": "2026-08-14T10:22:35-03:00",
      "mensagens": 14,
      "status": "resolved",
      "agente": "Julia Tatiane",
      "agente_id": 7,
      "agente_email": "[email protected]",
      "caixa": "Aquabeat WhatsApp",
      "caixa_id": 12,
      "origem": "ad",
      "etiquetas_conversa": ["quente", "visita-agendada"],
      "conversas_no_periodo": 2
    }
  ]
}

Para exportar tudo, percorra as páginas enquanto has_more for verdadeiro — o próximo número já vem em next_page.
agrupar=contato é o que você quer para uma lista de pessoas; agrupar=conversa serve para auditar atendimento, porque mostra cada passagem separadamente.

POST/api/v1/accounts/:account_id/profluxus/leads/cruzardocumentadoProfluxustestar

Cruzar uma lista de fora com a base

Você manda telefones e e-mails; a resposta diz quem já é cliente, quem está cadastrado mas sem atendimento no período e quem nunca apareceu.

Aceita os mesmos filtros do endpoint de leads, mas sem exigir período. Serve para conferir uma lista de campanha, uma planilha de indicações ou um mailing comprado contra quem já está na base.

Acesso: Token de um administrador da conta, no cabeçalho api_access_token.

Parâmetros

`chaves`	lista · corpo	Telefones e e-mails a procurar. Obrigatório.
`inbox_ids`	lista · corpo	Mesmos filtros do endpoint de leads, todos opcionais.
`created_after`	data · corpo	Recorte de período, aqui opcional.

Chamada

curl -X POST "https://talk.profluxus.com/api/v1/accounts/66/profluxus/leads/cruzar" \
  -H "api_access_token: SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "chaves": ["31999998888", "(31) 98888-7777", "[email protected]"] }'

Resposta

{
  "meta": { "total": 3, "encontrados": 2, "sem_atendimento": 1, "filtros": {} },
  "resultados": [
    { "chave": "31999998888",
      "encontrado": true,
      "lead": { "...": "mesma linha do endpoint de leads" } },
    { "chave": "(31) 98888-7777",
      "encontrado": true,
      "lead": { "conversa_id": null, "conversas_no_periodo": 0,
                "...": "cadastrado, sem conversa no periodo" } },
    { "chave": "[email protected]", "encontrado": false, "lead": null }
  ]
}

Telefone pode vir de qualquer jeito: com ou sem o 55, com máscara ou só dígitos. O casamento é feito apenas pelos dígitos.
encontrado: false significa que a pessoa não existe na base. Já lead com conversa_id nulo significa que ela está cadastrada, mas não teve conversa dentro dos filtros.

Catálogo gerado a partir das rotas da plataforma em 2026-09-03. Endpoints marcados como Profluxus são recursos novos da plataforma e podem exigir um plano superior ou a liberação do módulo na sua conta.