Você pode testar esta rota diretamente em nossa documentação interativa.

Para substituir variáveis no texto, use o formato {nomeDaVariavel} — o nome deve corresponder exatamente ao campo no objeto de dados.

​
Endpoint

POST /api/externalAPIs/public/externalNotificationFixed

​
Parâmetros

data
array
required

Array de objetos com informações dos destinatários.

fixedMessage
string
required

Mensagem pré-definida com variáveis entre chaves. Exemplo: "Olá {name}, seu boleto de {valor} vence em {data}.".

externalCampaignId
string

Identificador de campanha externa para rastreio.

dialogueInserts
string

Texto ou instrução inserida na conversa após o envio da mensagem.

expireAt
string

Data de expiração da campanha no formato YYYY-MM-DD. Opcional.

​
Exemplo

curl -X POST {{BASE_URL}}/api/externalAPIs/public/externalNotificationFixed \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "data": [
      {
        "id": "123",
        "name": "João Silva",
        "phone": "5531999999999",
        "valorBoleto": "R$ 150,00",
        "dataVencimento": "15/07/2025"
      }
    ],
    "fixedMessage": "Olá {name}, seu boleto de {valorBoleto} vence em {dataVencimento}.",
    "externalCampaignId": "campanha-01"
  }'

​
Resposta

{
  "code": 200,
  "message": "OK",
  "data": {
    "trackingId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "results": [
      {
        "status": "queued",
        "phone": "5531999999999",
        "campaignId": "550e8400-e29b-41d4-a716-446655440000",
        "message": "Mensagem enviada para processamento"
      }
    ],
    "summary": {
      "totalItems": 1,
      "validItems": 1,
      "skippedItems": 0,
      "queuedItems": 1,
      "failedItems": 0
    },
    "processedItems": [
      {
        "originalData": { "id": "123", "name": "João Silva", "phone": "5531999999999", "valorBoleto": "R$ 150,00", "dataVencimento": "15/07/2025" },
        "processedData": { "id": "123", "name": "João Silva", "phone": "5531999999999", "valorBoleto": "R$ 150,00", "dataVencimento": "15/07/2025" },
        "status": "queued",
        "phone": "5531999999999",
        "campaignId": "550e8400-e29b-41d4-a716-446655440000",
        "message": "Mensagem enviada para processamento"
      }
    ],
    "error": null,
    "time": 123,
    "message": "1 mensagem foi enviada para processamento em fila. O processamento ocorrerá em segundo plano e as notificações serão enviadas conforme forem processadas."
  }
}

​
Campos da Resposta

code
number
Código HTTP da resposta.
message
string
Mensagem de status (ex.: “OK”).
data.trackingId
string
ID do lote para acompanhamento.
data.timestamp
string
Data e hora do processamento em ISO 8601.
data.results
array

Resultado do processamento por destinatário.

data.summary
object

Totais do processamento.

data.processedItems
array

Detalhe por item processado.

data.error
any
Erro, se houver; caso contrário null.
data.time
number
Tempo de processamento em milissegundos.
data.message
string
Mensagem informativa sobre quantas mensagens foram enviadas para processamento em fila.

​
Erros

CódigoDescrição
400Campos obrigatórios ausentes ou inválidos
401Token inválido ou ausente
403Credenciais insuficientes
408Timeout — requisição excedeu 60 segundos
500Erro interno do servidor
Mensagens com IAMensagem Fixa com Template