Atendimento · Referência

Pré-Leads (IA)

Interessados captados pelo WhatsApp e a triagem da IA (documentos, score, decisão).

Permissão: pre_leadsAções: ler2 campo(s) LGPDglobal (sem carteira)

GET/v1/pre_leadsListar GET/v1/pre_leads/{id}Detalhar

O objeto pré-leads (ia)

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`phone`	texto	Telefone	LGPD
`client_id`	inteiro	ID do cliente
`stage`	texto (enum)	stage `greeting` `collecting_doc` `doc_received` `scoring` `approved` `rejected` `converted` `abandoned`	filtro
`serasa_score`	inteiro	serasa score	LGPD
`liveness_ok`	booleano	liveness ok
`face_match_ok`	booleano	face match ok
`decision`	texto (enum)	decision `aprovado` `revisar` `recusado`	filtro
`decision_reason`	texto	decision reason
`vehicle_preference`	texto	vehicle preference
`rental_days_pref`	inteiro	rental days pref
`last_interaction`	data-hora	last interaction	ordenar
`created_at`	data-hora	Criado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "phone": "91998765432",
    "client_id": 512,
    "stage": "greeting",
    "serasa_score": 1,
    "liveness_ok": false,
    "face_match_ok": false,
    "decision": "aprovado",
    "decision_reason": "texto",
    "vehicle_preference": "texto",
    "rental_days_pref": 1,
    "last_interaction": "2026-10-08T14:30:00-03:00",
    "created_at": "2026-10-08T14:30:00-03:00"
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `created_at`, `last_interaction` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`stage`	texto (enum)	stage — valor exato ou lista separada por vírgula `greeting` `collecting_doc` `doc_received` `scoring` `approved` `rejected` `converted` `abandoned`
`decision`	texto (enum)	decision — valor exato ou lista separada por vírgula `aprovado` `revisar` `recusado`
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (considera a data de criação)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/pre_leads?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pre_leads?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pre_leads?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/pre_leads?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "phone": "91998765432",
            "client_id": 512,
            "stage": "greeting",
            "serasa_score": 1,
            "liveness_ok": false,
            "face_match_ok": false,
            "decision": "aprovado"
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/pre_leads/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/pre_leads/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/pre_leads/1024', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/pre_leads/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "phone": "91998765432",
        "client_id": 512,
        "stage": "greeting",
        "serasa_score": 1,
        "liveness_ok": false,
        "face_match_ok": false,
        "decision": "aprovado"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}