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

WhatsApp Business API para notificação de envio de fatura

O cenário envia ao cliente um modelo personalizado de WhatsApp quando uma nova fatura é emitida.

Visão geral do caso de uso

O cenário envia ao cliente um template personalizado do WhatsApp quando uma nova fatura é emitida. A mensagem inclui o nome do cliente, número da fatura, valor devido e data de vencimento do pagamento. Um botão de URL estático abre a fatura ou a página de pagamento.

Exemplo de modelo

Olá, {{1}}! A fatura #{{2}} foi emitida para {{3}}. Pagamento devido: {{4}}.

Pagar fatura
  • {{1}}
    nome do cliente
  • {{2}}
    número da fatura
  • {{3}}
    valor a pagar
  • {{4}}
    data de vencimento do pagamento
  • “Pagar fatura”
    botão — fixo no modelo Meta
WhatsApp Business API for invoice send notification

Quando usar isso

Busque por esse cenário quando a área de cobrança emitir uma nova fatura e o cliente a esperar no WhatsApp, mas não houver um chat aberto — apenas um modelo aprovado pode iniciar a entrega. Isso é adequado para equipes de cobrança B2B, negócios de assinatura e serviços cansados de anexos de e-mail perdidos, e integradores conectando webhooks de faturas geradas por contabilidade ou ERP ao WhatsApp.

Menos faturas perdidas
Quatro variáveis do corpo carregam o nome do cliente, número da fatura, valor devido e data de vencimento do pagamento para o chat do WhatsApp do cliente, para que o resumo permaneça visível em vez de estar enterrado em um anexo de e-mail filtrado.
Pagamento com um toque a partir da mensagem
Um botão de URL estático abre a página de fatura ou pagamento fixada no modelo Meta, para que o cliente possa visualizar ou pagar sem precisar procurar um link no e-mail — apenas as quatro variáveis de corpo são enviadas via API.
Sem entrega manual de faturas
A cobrança dispara um evento de nova fatura, o sistema resolve os campos de telefone do cliente e da fatura, e o template é enviado automaticamente — ninguém digita os valores ou as datas de vencimento para cada cliente.
Status de entrega para acompanhamento de faturamento
O resultado da entrega é registrado após o envio, assim os sistemas de faturamento ou CRM podem rastrear se a fatura chegou ao cliente e tratar erros de acordo com as regras da plataforma.

Fluxo de Trabalho

  1. Disparador

    Problemas de faturamento emitem uma nova fatura e disparam um evento.

    event · triggered

  2. Evento de captura

    O sistema preenche os campos de número de telefone do cliente e de fatura.

    phone: "+…"

  3. Construir & enviar

    Uma mensagem template personalizada é construída com quatro variáveis de corpo e um botão URL estático.

    POST /sendTemplate

  4. Entregue

    O cliente recebe o resumo da fatura pelo WhatsApp e pode pagar pelo botão.

    delivered

  5. Status rastreado

    O resultado da entrega é registrado; erros são tratados de acordo com as regras da plataforma.

    status: "read"

WhatsApp Business API for invoice send notification

Implementação técnica

Pré-requisitos

  1. Chave da API 1MSG · Como obter a chave da API
  2. Conta do WhatsApp Business · Como Conectar WABA
  3. Template do WhatsApp · Como Aprovar o Template do WABA
  4. Consentimento opt-in 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_TICKETNUMBER="___"         # {{2}} ticket number
TEST_PAYMENTAMOUNT="___"         # {{3}} payment amount
TEST_DUEDATE="___"         # {{4}} 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_TICKETNUMBER=$TEST_TICKETNUMBER" \
            "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}} ticket number → ${TEST_TICKETNUMBER}
# {{3}} payment amount → ${TEST_PAYMENTAMOUNT}
# {{4}} 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_TICKETNUMBER}" },
        { "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": true significam que 1MSG aceitou a mensagem para envio — não que ela já tenha chegado ao telefone do cliente. Salve o campo id (parece com wamid.…) para correlacionar os callbacks de entrega.

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

    Aceito para envio — não ainda no telefone do cliente

  • id

    Armazene-o; os retornos de chamada de entrega e hookInfo são baseados nisso

A entrega em si chega mais tarde, como um callback separado. Registre um webhook (POST …/webhook) e 1MSG POSTa atualizações de status para o seu endpoint HTTPS em um payload de nível superior hooks[].

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

    enviado, entregue, lido — ou um status de falha quando aplicável

  • id

    Correla o callback com o id retornado pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber chamadas de retorno, consulte GET {base}/{channel}/hookInfo?messageId=<id> em vez disso. Na prática, a entrega geralmente é concluída em segundos — mas o contrato da API não garante isso, então nunca bloqueie um fluxo esperando por isso.

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 de início a frio requerem um modelo aprovado pela Meta.

Relacionado

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