Skip to main content

​
Pré-requisitos

  • Uma conta ativa na Cordialy
  • Uma API key gerada em Integrações → API Keys
  • Um número de WhatsApp conectado na plataforma

​
Passo 1 — Crie um lead

Um lead é o contato que receberá a mensagem. Se ele já existe na plataforma, a API retorna o registro existente sem criar duplicata. 
curl -X POST https://api.cordialy.ai/integrations/v1/leads \
  -H "X-API-Key: SUA_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_phone": "5511999998888",
    "name": "João Silva"
  }'
Resposta: 
{
  "id": "a1b2c3d4-...",
  "name": "João Silva",
  "customer_phone": "5511999998888",
  "status": "pending",
  "created_at": "2026-06-19T10:00:00.000Z"
}

​
Passo 2 — Envie uma mensagem

Use o id retornado no passo anterior: 
curl -X POST https://api.cordialy.ai/integrations/v1/leads/LEAD_ID/messages \
  -H "X-API-Key: SUA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Olá João! Seu pedido #1234 foi aprovado e está sendo preparado."}'
Resposta: 
{ "sent": true }
A mensagem é entregue ao lead via WhatsApp e aparece na plataforma destacada em roxo com a tag Via API.

​
Passo 3 — Acompanhe o histórico

curl https://api.cordialy.ai/integrations/v1/leads/LEAD_ID/messages \
  -H "X-API-Key: SUA_KEY"
Você verá a mensagem enviada com "source": "api" junto com as demais mensagens do lead.

​
Tratamento de erros

Sempre verifique o status HTTP da resposta: 
const res = await fetch('...', { method: 'POST', ... });

if (!res.ok) {
  const error = await res.json();
  console.error(`Erro ${res.status}:`, error.message);
  // ex: "Lead não encontrado", "Mensagem não pode ser vazia"
}
StatusSignificado
200 / 201Sucesso
400Dados inválidos na requisição
401API key ausente ou inválida
404Recurso não encontrado
429Limite de requisições atingido
500Erro interno — tente novamente

​
Próximos passos

Automatizar follow-ups

Programe mensagens automáticas de reativação.

Receber respostas via Webhook

Seja notificado quando o lead responder.

Sincronizar leads do CRM

Estratégias para manter leads sincronizados.

Entender os agentes de IA

Como a IA decide qual agente responde.