Mensagens com IA
Dispara mensagens com contexto personalizado e instruções específicas para processamento pela IA
Você pode testar esta rota diretamente em nossa documentação interativa.
Todas as variáveis adicionais fornecidas dentro de cada objeto de data serão usadas pela IA para contextualizar a mensagem.
Endpoint
POST /api/externalAPIs/public/externalNotificationAI
Parâmetros
Array de objetos com informações dos destinatários para contextualização.
Instruções sobre como a IA deve proceder com os dados disponíveis.
Identificador de campanha externa para rastreio.
Define se a conversa será pausada após o disparo (a IA não responderá caso o usuário retorne).
Instruções para serem inseridas na conversa após o disparo.
Data de expiração da campanha no formato YYYY-MM-DD. Opcional.
O body pode ser enviado em formatos alternativos: array de itens ou objeto com chaves numéricas, além do formato padrão { data: [...], generalInstructions, ... }.
Exemplo
curl -X POST {{BASE_URL}}/api/externalAPIs/public/externalNotificationAI \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"data": [
{
"id": "123",
"name": "João Silva",
"email": "joao@email.com",
"phone": "5531999999991",
"cidade": "Belo Horizonte",
"veiculo": "Sedan Luxo"
},
{
"id": "124",
"name": "Maria Santos",
"email": "maria@email.com",
"phone": "5531999999992",
"cidade": "São Paulo",
"veiculo": "SUV Compacto"
}
],
"generalInstructions": "Enviar mensagem de campanha de proteção veicular, engajando o usuário a contratar o plano.",
"externalCampaignId": "campanha-veicular-01",
"pauseConversation": false
}'
Resposta
{
"code": 200,
"message": "OK",
"data": {
"trackingId": "campaign-uuid-123",
"timestamp": "2024-01-15T10:30:00.000Z",
"results": [
{
"status": "queued",
"phone": "5531999999991",
"campaignId": "campaign-uuid-123",
"message": "Mensagem enviada para processamento"
}
],
"summary": {
"totalItems": 2,
"validItems": 2,
"skippedItems": 0,
"queuedItems": 2,
"failedItems": 0
},
"processedItems": [
{
"originalData": { "id": "123", "name": "João Silva", "email": "joao@email.com", "phone": "5531999999991", "cidade": "Belo Horizonte", "veiculo": "Sedan Luxo" },
"processedData": { "id": "123", "name": "João Silva", "email": "joao@email.com", "phone": "5531999999991", "cidade": "Belo Horizonte", "veiculo": "Sedan Luxo" },
"status": "queued",
"phone": "5531999999991",
"campaignId": "campaign-uuid-123",
"message": "Mensagem enviada para processamento"
}
],
"error": null,
"time": 456,
"message": "2 mensagens foram enviadas para processamento em fila. O processamento ocorrerá em segundo plano e as notificações serão enviadas conforme forem processadas."
}
}
Campos da Resposta
ID da campanha criada para acompanhamento do lote.
Data e hora do processamento em ISO 8601.
Resultado do processamento por destinatário.
Totais do processamento.
Detalhe por item processado.
As mensagens são processadas em segundo plano. O status "queued" indica que a mensagem foi aceita para processamento.
Erros
| Código | Descrição |
|---|---|
400 | generalInstructions ou data ausentes ou vazios |
401 | Token inválido ou ausente |
403 | Credenciais insuficientes |
408 | Timeout — requisição excedeu 60 segundos |
500 | Erro interno do servidor |