Skip to main content
Na Notifique você pode usar cada serviço individualmente: envio de SMS, e-mail ou mensagens no WhatsApp. Mas não paramos por aí. Através de uma única requisição é possível enviar uma mesma mensagem para vários canais ao mesmo tempo — isso acontece através dos templates.

​
O que são os templates?

Um template é uma configuração que você define de como a mensagem deve se comportar no SMS, no WhatsApp e no e-mail. Quando você cria um template, pode personalizar a aparência que sua mensagem vai ter em cada plataforma: um texto curto e direto no SMS (na Notifique o SMS exige pelo menos 9 caracteres e até 160), uma mensagem rica no WhatsApp e um e-mail com assunto e HTML próprios. Assim você atinge seu cliente da melhor forma possível, no canal que ele preferir, mantendo a mesma intenção e a mesma campanha. Em resumo: um conceito, vários canais. Você escreve uma vez (ou adapta por canal) e envia para quem quiser, no canal que quiser, em uma única chamada à API.

​
Como funciona?

  1. Crie o template no painel — Defina o conteúdo para cada canal em que for usar (WhatsApp, SMS, e-mail). Para e-mail, você pode configurar assunto e corpo em HTML.
  2. Use variáveis — Personalize a mensagem com placeholders como {{1}}, {{2}} ou chaves livres ({{pedido}}). Para o nome do contato do cadastro, use {{name}} (inglês), não {{nome}}, a menos que você trate nome como variável própria e envie em variables. Campos personalizados do contato usam a chave técnica definida no painel. Guia completo: Variáveis do contato, campos personalizados e CRUD.
  3. Envie com uma requisição — Chame POST /v1/templates/send informando:
    • to — Lista de destinatários (números E.164 para WhatsApp/SMS, e-mails para canal e-mail).
    • template — Nome ou ID do template.
    • variables — Valores das variáveis do template.
    • channels — Canais desejados: ["whatsapp"], ["sms"], ["email"] ou qualquer combinação.
    • instanceId — (opcional) ID da instância WhatsApp. Se omitido, é usada a instância principal do workspace.
    • from — (opcional) Remetente do e-mail (domínio verificado). Se omitido, é usado o domínio principal do workspace.
A API valida as variáveis obrigatórias do template, substitui os placeholders em cada conteúdo (WhatsApp, SMS, e-mail) e dispara para os canais escolhidos. Você recebe de volta os IDs das mensagens criadas (WhatsApp, SMS e/ou e-mail) conforme os canais utilizados.

​
Instância e domínio padrão

Por padrão, o envio usa a instância principal do workspace (WhatsApp) e o domínio principal (e-mail). Assim você não precisa informar instanceId nem from em toda requisição. Se quiser usar outra instância ou outro domínio de e-mail (por exemplo, uma linha comercial diferente ou um remetente específico), basta preencher instanceId e/ou from no body da requisição.

​
Resolução de contato (telefone e e-mail)

Se você selecionar o canal e-mail e passar no to apenas números de telefone, a Notifique pode enviar o e-mail mesmo assim: quando existir um contato no workspace com aquele telefone e um e-mail associado, o envio será feito também para esse e-mail. Ou seja, a lista de destinatários é enriquecida com os e-mails dos contatos cadastrados quando o canal e-mail estiver ativo. Assim você pode enviar para “o cliente” (telefone) e, se tiver o e-mail dele no cadastro, ele recebe nos dois canais (SMS/WhatsApp e e-mail) sem precisar repetir o e-mail na lista.

​
Créditos (consumo por destinatário e por tipo)

Cada envio gera consumo de créditos do plano: para cada SMS, cada e-mail e cada mensagem WhatsApp é descontado o valor correspondente ao tipo. O consumo é por destinatário e por canal. Por exemplo: enviar para 2 destinatários nos 3 canais (WhatsApp, SMS e e-mail) gera 2 × 3 = 6 envios — cada um debitado conforme a tabela de créditos do seu plano (ex.: X créditos por SMS, Y por e-mail, Z por mensagem WhatsApp). Assim, quanto mais canais e mais destinatários, mais créditos são consumidos; a resposta da API inclui os IDs de cada mensagem criada para você acompanhar o que foi enviado (e debitado).

​
Variáveis no template

Os templates suportam variáveis nos formatos:
  • Nomeadas (livres): qualquer chave que você colocou no texto, ex.: {{valor}} — na requisição: variables: { "valor": "R$ 100,00" }.
  • Dados do contato (automáticos): {{name}}, {{email}}, {{phone}}, {{telefone}}, {{preferences_link}} — preenchidos pelo sistema quando o destinatário é um contato; detalhes na página Variáveis do contato, campos personalizados e CRUD.
  • Campos personalizados: mesma chave técnica do cadastro, ex. {{cpf_cliente}}.
  • Posicionais: {{1}}, {{2}} — objeto com chaves "1", "2" (ou array, conforme o cliente HTTP).
Assim, a mesma mensagem pode ser personalizada para cada destinatário em todos os canais.

​
Exemplo de uso (API)

POST /v1/templates/send
{
  "to": ["5511999999999", "cliente@example.com"],
  "template": "confirmacao_pedido",
  "variables": {
    "nome": "Maria",
    "pedido": "12345",
    "valor": "R$ 89,90"
  },
  "channels": ["whatsapp", "sms", "email"],
  "instanceId": "sua_instancia_whatsapp",
  "from": "noreply@seudominio.com"
}
Nesse exemplo, a mesma “confirmação de pedido” é enviada por WhatsApp, SMS e e-mail para o número e o e-mail informados, desde que o template confirmacao_pedido tenha conteúdo configurado para os três canais e que as variáveis nome, pedido e valor existam no template.

​
Resumo

O queDescrição
Um templateUma configuração com conteúdo por canal (WhatsApp, SMS, e-mail) e variáveis.
Uma requisiçãoPOST /v1/templates/send com to, template, variables, channels. Opcionalmente instanceId e from (senão, usam-se a instância e o domínio principais do workspace).
CréditosCada SMS, e-mail ou mensagem WhatsApp consome créditos por destinatário e por tipo.
ResultadoA mesma mensagem (personalizada pelas variáveis) é enviada nos canais escolhidos; você recebe os IDs de cada envio.
Assim você unifica campanhas e notificações em uma única integração e deixa o canal (WhatsApp, SMS ou e-mail) a cargo da Notifique e da preferência do seu cliente.