💬 Shared Inbox do WhatsApp na nova PlataformaMais
1msg official logo

WhatsApp Business API para lembrete de pagamento próximo

O cenário envia ao cliente um modelo personalizado de WhatsApp antes da data de vencimento do pagamento.

Visão geral do caso de uso

O cenário envia ao cliente um template personalizado de WhatsApp antes da data de vencimento do pagamento. A mensagem inclui o nome do cliente, o valor devido e a data de vencimento. Um botão de URL estático abre a página de pagamento online.

Exemplo de modelo

Olá,{{1}}! Um pagamento de{{2}}vence em{{3}}. Por favor, pague em dia para evitar interrupção do serviço.

Pague agora
  • {{1}}
    nome do cliente
  • {{2}}
    valor devido
  • {{3}}
    data de vencimento do pagamento
  • “Pague agora”
    botão — fixo no modelo Meta
WhatsApp Business API for upcoming payment reminder

Quando usá-lo

Atingir este cenário quando a cobrança detecta que a data de vencimento de um pagamento está se aproximando e os lembretes de fatura por email ou SMS estão sendo ignorados antes que o prazo passe. Isso se adequa a cobranças de assinatura e fatura, e-commerce e negócios de serviços que desejam lembretes proativos de cobrança, além de integradores conectando cronogramas de datas de vencimento de sistemas ERP ou de cobrança a lembretes automatizados via WhatsApp.

Menos pagamentos em atraso
O nome do cliente, o valor devido e a data de vencimento chegam como três variáveis no corpo da mensagem no WhatsApp antes do prazo, para que o cliente veja o que deve em um canal que ele verifica, em vez de estar enterrado no e-mail.
Caminho de pagamento com um toque
O botão de URL estático fixo no template aprovado do Meta abre a página de pagamento online, assim o cliente pode concluir o pagamento sem responder no chat.
Nenhum trabalho de lembrete manual
A cobrança detecta a data de vencimento se aproximando e dispara o modelo automaticamente, para que ninguém precise reescrever valores e datas para cada fatura futura.
Entrega registrada para acompanhamento
O resultado da entrega é registrado para faturamento ou CRM, para que os fluxos de trabalho financeiro saibam se o lembrete chegou ao cliente antes da data de vencimento.

Fluxo de Trabalho

  1. Desencadear

    A cobrança detecta uma data de vencimento de pagamento se aproximando e envia um lembrete.

    event · triggered

  2. Registrar evento

    O sistema resolve os campos de número de telefone e pagamento do cliente.

    phone: "+…"

  3. Construa e envie

    Uma mensagem de template personalizada é criada com três variáveis de corpo e um botão de URL estático.

    POST /sendTemplate

  4. Entregue

    O cliente recebe o lembrete pelo WhatsApp e pode pagar pelo botão.

    delivered

  5. Status rastreado

    O resultado da entrega é registrado para faturamento ou acompanhamento de CRM.

    status: "read"

WhatsApp Business API for upcoming payment reminder

Implementação técnica

Pré-requisitos

  1. 1MSG API Key · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Modelo de WhatsApp · Como Aprovar o Modelo WABA
  4. Consentimento do cliente · Como Gerenciar o Consentimento dos Clientes

Exemplos de código

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_PAYMENTAMOUNT="___"         # {{2}} payment amount
TEST_DUEDATE="___"         # {{3}} due date

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_PAYMENTAMOUNT=$TEST_PAYMENTAMOUNT" \
            "TEST_DUEDATE=$TEST_DUEDATE"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} payment amount → ${TEST_PAYMENTAMOUNT}
# {{3}} due date → ${TEST_DUEDATE}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_PAYMENTAMOUNT}" },
        { "type": "text", "text": "${TEST_DUEDATE}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Status de resposta e entrega

HTTP 2xx e JSON"sent": truemean 1MSGaceitoa mensagem para enviar — não que já tenha chegado ao telefone do cliente.idcampo (parece quewamid.…) para correlacionar chamadas de retorno de entrega.

200 OKResposta
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Aceito para envio.nãoainda no telefone do cliente

  • id

    Armazene isso; retornos de entrega.hookInfoestão focados nisso

A entrega em si chega mais tarde, como uma chamada de retorno separada. Registre um webhook (POST …/webhook) e 1MSG POSTs atualizações de status para o seu endpoint HTTPS em um nível superiorhooks[]carga.

200 OKWebhook de status de entrega — payload recebido
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    sent, delivered, read— ou um status de falha quando aplicável

  • id

    Correla a função de retorno com oidretornado pela chamada.

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber ligações, escolha não ser contactado.GET {base}/{channel}/hookInfo?messageId=<id>em vez disso. Na prática, a entrega muitas vezes é concluída em segundos — mas o contrato da API não garante isso, então nunca bloqueie um fluxo esperando por ela.

Erros comuns

StatusRespostaCausa
200Message was not sent: template is not definednamespace, template or language missing from the request body.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.
403access deniedThe token is wrong, or belongs to a different channel than the URL.
429too many requests. please try laterThe channel is over its send rate.

Perguntas Frequentes

Sim — mensagens de WhatsApp para início a frio requerem um modelo aprovado pelo Meta.

Relacionado

Crie para o WhatsApp em horas
sem complicações de infraestrutura