Endpoint External Notification Fixed

O endpoint External Notification Fixed permite o disparo de mensagens com texto pré-definido, oferecendo a possibilidade de personalização através da substituição de variáveis dinâmicas pelos valores fornecidos no payload.

​

📑 Índice

• 🎯 Visão Geral
• 🔑 Autenticação
• ⚙️ Parâmetros da Requisição
• 📦 Estrutura da Resposta
• 💡 Exemplos de Uso
• ⚠️ Tratamento de Erros
• ✨ Boas Práticas
• 🔄 Endpoints Relacionados

​

🎯 Visão Geral

O endpoint External Notification Fixed é responsável por:

​

🔑 Autenticação

Para utilizar o endpoint, é necessário incluir um token de autenticação no header da requisição:

Authorization: Bearer {seu-token-de-acesso}

​

⚙️ Parâmetros da Requisição

​

📋 Campos Principais

​

🔧 Estrutura do Objeto dentro do Array data

​

📦 Estrutura da Resposta

A resposta da API segue o formato padrão das APIs Tolky, com códigos de status e mensagens relevantes.

{
  "code": 200,
  "message": "Success",
  "data": {
    "processedMessages": 1,
    "messageId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

​

💡 Exemplos de Uso

• Tab Title

• Tab Title

curl --location 'https://api.tolky.to/api/externalAPIs/public/externalNotificationFixed' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {User-Access-Token}' \
--data-raw '{
    "data": [
        {
            "id": "123"
            "name": "GABRIEL FERREIRA COSTA",
            "phone": "(31)98336-7747"
        }
    ],
    "fixedMessage": "Olá, {name} tudo bem? Falo em nome da Cooperlink Minas. O motivo do meu contato é devido ao boleto que está em atraso há 7 dias. Se precisar de uma 2° via, posso te enviar. Lembrando que você está sem proteção em seu veículo, para reativação dos seus benefícios junto a Cooperlink, além do pagamento do seu boleto, é necessário a realização de uma nova vistoria para ativação do seu plano. REFORÇAMOS QUE APENAS O PAGAMENTO DO BOLETO SEM A NOVA VISTORIA, NÃO REATIVA A SUA PROTEÇÃO.",
    "externalCampaignId": "0910",
    "pauseConversation": false
}'

​

Exemplo com Múltiplas Variáveis

{
    "data": [
        {
            "id": "123"
            "phone": "31999999999",
            "name": "João Silva",
            "valorBoleto": "R$ 150,00",
            "dataVencimento": "15/07/2023"
        }
    ],
    "fixedMessage": "Olá {name}, seu boleto no valor de {valorBoleto} vence em {dataVencimento}. Por favor, efetue o pagamento para evitar juros e multas.",
    "externalCampaignId": "0910",
    "pauseConversation": false
}

​

Exemplo com Múltiplos Destinatários

{
    "data": [
        {
            "id": "123",
            "phone": "31999999999",
            "name": "João Silva",
            "produtoAdquirido": "Plano Premium"
        },
        {
            "id": "1234"
            "phone": "31888888888",
            "name": "Maria Santos",
            "produtoAdquirido": "Plano Básico"
        }
    ],
    "fixedMessage": "Olá {name}, obrigado por adquirir o {produtoAdquirido}. Em caso de dúvidas, entre em contato com nosso suporte.",
    "externalCampaignId": "0910",
    "pauseConversation": false
}

​

⚠️ Tratamento de Erros

​

⏱️ Timeout

Todas as requisições têm um timeout de 60 segundos. Se a requisição exceder este limite, será retornado um erro 408 (Request Timeout).

​

✨ Boas Práticas

​

🔄 Endpoints Relacionados

​

External Notification IA

Para envio de mensagens com processamento por IA, permitindo contextualização avançada e geração dinâmica de conteúdo.

Endpoint: POST /api/externalAPIs/public/externalNotificationAI

Ver documentação completa

​

Tolky Reasoning

Para processamento de perguntas e respostas contextualizadas utilizando a inteligência do Tolky.

Endpoint: POST /api/externalAPIs/public/tolkyReasoning

Ver documentação completa