Templates

Criar e gerenciar templates de mensagem. Templates são necessários para conversas iniciadas pela empresa fora da janela de 24 horas.

Listar templates de mensagem

get

Recupera todos os templates de mensagem associados à conta WhatsApp Business (WABA). Templates são mensagens pré-aprovadas necessárias para iniciar conversas fora da janela de 24 horas.

Categorias de Template

Categoria	Finalidade	Tempo de Aprovação
MARKETING	Promoções, ofertas, boletins	1-3 dias úteis
UTILITY	Atualizações de pedido, confirmações, lembretes	1-2 dias úteis
AUTHENTICATION	Códigos OTP, verificação de login	Geralmente instantâneo

Status dos Templates

Status	Descrição
PENDING	Enviado e aguardando revisão
APPROVED	Pronto para uso em mensagens
REJECTED	Não aprovado na revisão, ver motivo
PAUSED	Temporariamente desativado por problemas de qualidade
DISABLED	Desativado permanentemente, é necessário criar novo template
PENDING_DELETION	Agendado para exclusão

Classificação de Qualidade

Templates são avaliados com base no feedback dos usuários:

• GREEN: Alta qualidade, baixa taxa de bloqueio

• YELLOW: Qualidade média, alguns bloqueios

• RED: Baixa qualidade, alta taxa de bloqueio (pode ser pausado)

Paginação de Resposta

Para contas com muitos templates, usar parâmetros de paginação:

• limit: Máximo de templates por resposta (padrão 100, máximo 1000)

• offset: Número de templates a pular

Filtragem

O objeto filters na resposta indica opções de filtragem disponíveis.

Autorizações

ApiKeyAuth

apikeystringObrigatório

Chave de API para autenticação

Respostas

200

Templates recuperados com sucesso

application/json

401

Não autorizado.

application/json

get

/configs/templates

HTTPcURLJavaScriptPython

GET /v1/configs/templates HTTP/1.1
Host: waba.fortics.com.br
apikey: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "filters": {},
  "limit": 1000,
  "offset": 0,
  "sort": [],
  "total": 1,
  "waba_templates": [
    {
      "name": "sample_template",
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "Olá mundo"
        },
        {
          "type": "BODY",
          "text": "Bem-vindo! Esta mensagem demonstra a capacidade de enviar notificações do WhatsApp."
        },
        {
          "type": "FOOTER",
          "text": "Plataforma WhatsApp Business"
        },
        {
          "type": "BUTTONS",
          "buttons": [
            {
              "type": "URL",
              "text": "Comprar Agora",
              "url": "https://www.website.com/shop?promo={{1}}",
              "example": [
                "verao2023"
              ]
            },
            {
              "type": "QUICK_REPLY",
              "text": "Tenho interesse!"
            }
          ]
        }
      ]
    }
  ],
  "language": "pt_BR",
  "status": "APPROVED",
  "category": "MARKETING",
  "id": "3442830349297977"
}

Criar template de mensagem

post

Cria um novo template de mensagem para a conta WhatsApp Business. Templates devem ser aprovados pelo WhatsApp antes de serem usados em mensagens.

Categorias de Template

A categoria deve ser escolhida com base no caso de uso:

• MARKETING: Conteúdo promocional, ofertas, anúncios de produto, boletins. Requer opção clara de opt-out. Revisão com maior rigor.

• UTILITY: Mensagens transacionais como confirmações de pedido, atualizações de envio, lembretes de compromissos e notificações de pagamento. Deve ser relevante a uma ação prévia do cliente.

• AUTHENTICATION: Senhas de uso único (OTP), códigos de login, mensagens de verificação. Possui requisitos de formato estritos e aprovação mais rápida.

Componentes do Template

Templates são compostos por múltiplos componentes:

Componente	Obrigatório	Tamanho Máx	Descrição
HEADER	Não	60 caracteres (texto)	Texto, imagem, vídeo ou documento
BODY	Sim	1024 caracteres	Conteúdo principal da mensagem com variáveis
FOOTER	Não	60 caracteres	Texto pequeno no rodapé
BUTTONS	Não	Máx 3 botões	Respostas rápidas, URLs ou botões de chamada

Espaços para Variáveis

Usar chaves duplas para conteúdo dinâmico: {{1}}, {{2}}, etc.

Exemplo: "Olá {{1}}, seu pedido #{{2}} chegará em {{3}}."

É necessário fornecer valores de exemplo para todas as variáveis ao criar o template.

Tipos de Botões

Tipo	Descrição	Máx por Template
QUICK_REPLY	Opções de resposta predefinidas	3
URL	Abre uma página web	2
PHONE_NUMBER	Inicia uma chamada telefônica	1
COPY_CODE	Copia código de cupom/rastreamento	1
FLOW	Inicia um WhatsApp Flow	1
CATALOG	Visualiza catálogo de produtos	1
MPM	Visualiza mensagem multi-produto	1

Boas Práticas

1. Manter mensagens concisas e claras

2. Incluir todas as informações obrigatórias no template

3. Evitar linguagem excessivamente promocional em templates UTILITY

4. Testar templates com valores de exemplo antes de enviar

5. Usar a flag allow_category_change para aprovação mais rápida

Autorizações

ApiKeyAuth

apikeystringObrigatório

Chave de API para autenticação

Corpo

application/json

namestringObrigatório

Nome do template (apenas letras minúsculas, números e underscores)

Example: order_updatePattern: ^[a-z0-9_]+$

categorystring · enumObrigatório

Categoria do template

Valores possíveis:

allow_category_changebooleanOpcional

Permitir que o WhatsApp atribua uma categoria diferente, se apropriado

Default: false

languagestringObrigatório

Código de idioma e localidade do template

Example: pt_BR

post

/configs/templates

HTTPcURLJavaScriptPython

POST /v1/configs/templates HTTP/1.1
Host: waba.fortics.com.br
apikey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "name": "simple_text_message",
  "category": "UTILITY",
  "allow_category_change": true,
  "language": "pt_BR",
  "components": [
    {
      "type": "BODY",
      "text": "Olá {{1}}, o status do seu pacote é {{2}}.",
      "example": {
        "body_text": [
          "João",
          "Entregue"
        ]
      }
    }
  ]
}

Template de texto básico com variáveisTemplate com cabeçalho de imagemTemplate com cabeçalho de localização e botãoTemplate com botão de catálogo de produtosTemplate de solicitação de permissão de chamadaTemplate com botão de chamada de voz