API da Profluxus — Referência

Toda chamada de agente leva o cabeçalho api_access_token com o token do usuário, e o identificador da conta vai no próprio caminho, no lugar de :account_id. O token fica em Perfil › Configurações do perfil › Token de acesso, dentro do Talk.

curl -H "api_access_token: SEU_TOKEN" \
  https://talk.profluxus.com/api/v1/accounts/1/conversations

Os endpoints em Platform usam o token da instalação, não o do agente, e servem para criar contas e usuários. Os de API pública e Widget são chamados pelo contato final e usam o identificador da caixa de entrada. O servidor MCP tem autenticação própria, descrita na página do MCP.

Receitas

Consultas frequentes e o caminho para cada uma.

Contatos que conversaram num período, numa caixa de entrada específica

Há endpoint dedicado para esta consulta. GET /profluxus/leads devolve a lista pronta, com nome, cadastro, última mensagem, agente, status e etiquetas em cada linha, e exporta em CSV. O filtro de conversas descrito abaixo atende recortes que os parâmetros de leads não cobrem.

Pelo caminho genérico, a consulta sai do filtro de conversas, não da listagem de contatos: é a conversa que carrega data, caixa, agente, status e etiquetas de uma vez.

curl -X POST "https://talk.profluxus.com/api/v1/accounts/1/conversations/filter?page=1" \
  -H "api_access_token: SEU_TOKEN" -H "Content-Type: application/json" \
  -d '{
    "payload": [
      { "attribute_key": "inbox_id",   "filter_operator": "equal_to",
        "values": [12], "query_operator": "AND" },
      { "attribute_key": "created_at", "filter_operator": "is_greater_than",
        "values": ["2026-08-01"], "query_operator": "AND" },
      { "attribute_key": "created_at", "filter_operator": "is_less_than",
        "values": ["2026-08-31"], "query_operator": null }
    ]
  }'

Onde fica cada campo na resposta:

Nome do contatometa.sender.name

Cadastro do contatometa.sender.created_at

Última mensagemlast_non_activity_message.created_at

Agente atribuídometa.assignee.name

Status da conversastatus

Etiquetaslabels

Com last_activity_at no lugar de created_at, o recorte passa a ser pela última movimentação, não pela abertura. Os atributos aceitos no filtro são status, assignee_id, inbox_id, team_id, contact_id, priority, display_id, campaign_id, labels, created_at, last_activity_at e mail_subject. Datas aceitam is_greater_than, is_less_than e days_before; o resto usa equal_to, not_equal_to, contains, is_present e is_not_present.

A resposta é paginada (?page=, 25 por página) e devolve meta.all_count com o total. Testar no console →

Buscar um contato pelo telefone e abrir conversa

# 1. achar o contato
GET /api/v1/accounts/1/contacts/search?q=5531999998888

# 2. as conversas dele
GET /api/v1/accounts/1/contacts/{id}/conversations

# 3. mandar mensagem numa conversa existente
POST /api/v1/accounts/1/conversations/{id}/messages
{ "content": "Olá!", "message_type": "outgoing" }

Relatório de atendimento por agente num período

GET /api/v1/accounts/1/reports/agents?since=1754006400&until=1756598400

As datas vão como timestamp Unix. Para os totais da conta, use /api/v2/accounts/1/reports/summary; para abrir por caixa, time ou etiqueta, troque o final por inboxes, teams ou labels.

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.