Leads
Obter Lead por External ID
Retorna dados completos de um lead identificado por external_id (public.leads.external_id)
Retorna os dados completos de um lead identificado por public.leads.external_id. Mesma estrutura de resposta de Obter Detalhes do Lead. Use quando seu sistema identifica leads pelo identificador externo em vez do UUID interno.
Endpoint
POST /api/externalAPIs/public/tolkyReasoning/leads/getLeadByExternalId
Parâmetros
host-id
string
requiredUUID do host. Enviado via header da requisição.
host-slug
string
requiredSlug do host. Enviado via header da requisição.
externalId
string
requiredIdentificador externo do lead (public.leads.external_id) a ser consultado.
Exemplo
curl -X POST {{BASE_URL}}/api/externalAPIs/public/tolkyReasoning/leads/getLeadByExternalId \
-H "Content-Type: application/json" \
-H "host-id: {HOST_ID}" \
-H "host-slug: {HOST_SLUG}" \
-d '{
"externalId": "CRM-LEAD-12345"
}'
Resposta
{
"code": 200,
"message": "Success",
"data": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "CRM-LEAD-12345",
"lead_name": "Maria Silva",
"user_name": "maria.silva",
"email": "maria@empresa.com",
"phone": "5511999990000",
"created_at": "2025-01-10T14:00:00.000Z",
"updated_at": "2025-03-01T09:30:00.000Z",
"host_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"lead_summary": "Lead demonstrou interesse em planos empresariais.",
"sentiment": "positive",
"location": "São Paulo, SP",
"last_interaction_at": "2025-03-01T09:30:00.000Z",
"pipeline_stage": 2,
"user_score": 85,
"user_score_explain": "Alto engajamento e perfil qualificado.",
"ask_human_help": false,
"is_paused": false,
"conversations": [
{
"conversation_id": "c1d2e3f4-0000-0000-0000-000000000001",
"dialogue_summary": "Usuário perguntou sobre planos e preços.",
"created_at": "2025-02-20T10:00:00.000Z",
"ask_human_help": false,
"closed": true
}
],
"tickets": [
{
"id": "t1u2v3w4-0000-0000-0000-000000000001",
"subject": "Solicitação de proposta comercial",
"description": "Lead solicitou proposta detalhada para plano empresarial.",
"status_name": "Em Análise",
"status_level": 2,
"closed": false,
"created_at": "2025-02-21T08:00:00.000Z",
"conversation_id": "c1d2e3f4-0000-0000-0000-000000000001",
"friendly_protocol": "TKT-2025-0042"
}
]
}
}
Campos da Resposta
code
number
Código HTTP da resposta (200 em sucesso).
message
string
Mensagem de status da operação.
data
object
Objeto com os dados completos do lead (mesma estrutura de getLeadDetails).
Erros
| Código | Descrição |
|---|---|
400 | externalId ausente ou inválido |
401 | Headers de autenticação inválidos ou ausentes |
404 | Lead não encontrado |
500 | Erro interno do servidor |