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

WhatsApp Business API para lembrete de conclusão do onboarding

O cenário envia ao usuário um modelo WhatsApp personalizado quando o onboarding da conta é iniciado, mas não concluído.

Visão geral do caso de uso

O cenário envia ao usuário um modelo WhatsApp personalizado quando o onboarding da conta é iniciado, mas não finalizado. A mensagem inclui o nome do cliente, a etapa de onboarding pendente e o próximo passo a ser concluído. Um botão de URL estático abre o assistente de onboarding onde eles pararam.

Exemplo de modelo

Olá, {{1}}! O seu onboarding de conta ainda não está completo — o {{2}} passo ainda está pendente. {{3}} Toque no botão abaixo para finalizar a configuração. Se precisar de ajuda, responda a esta mensagem.

Finalizar onboarding
  • {{1}}
    nome do cliente
  • {{2}}
    fase de onboarding pendente (por exemplo, verificação de perfil de negócios, upload de documentos)
  • {{3}}
    instruções para o próximo passo (por exemplo, envie os documentos da empresa e confirme os detalhes no portal)
  • “Finalizar onboarding”
    botão — fixo no modelo do Meta
WhatsApp Business API for onboarding completion reminder

Quando usar

Atingir esse cenário quando um usuário se registra e inicia o onboarding da conta — configuração de perfil, upload de documentos ou verificação — mas para antes que todos os passos obrigatórios sejam concluídos. Isso se aplica a equipes de SaaS e fintechs recuperando fluxos de KYC paralisados, marketplaces incentivando vendedores a finalizar a verificação e agências enviando eventos de progresso de onboarding do aplicativo de um cliente para lembretes no WhatsApp.

Menos fluxos de onboarding inacabados
Três variáveis do corpo contêm o nome do cliente, a etapa de onboarding pendente e a instrução do próximo passo, assim o lembrete nomeia exatamente o que falta em vez de um incentivo genérico de inscrição.
Um toque para voltar ao assistente
Um botão de URL estático rotulado como Finalizar onboarding abre o assistente de onboarding onde o usuário parou — o link é fixo no modelo aprovado da Meta, enquanto apenas o texto do corpo é enviado via API.
Lembretes sem uma janela de chat aberta
Porque não há uma conversa ativa, o envio utiliza um modelo de WhatsApp aprovado através da API 1MSG — o único canal que pode alcançar o usuário fora da janela de sessão de 24 horas.
Sem a necessidade de perseguições manuais após onboarding parado
Quando o sistema detecta um estado de onboarding incompleto — timeout em uma etapa, rascunho salvo ou verificação parada — ele resolve o número de telefone e dispara o modelo nesse gatilho.
Entrega registrada para acompanhamento do produto
O resultado da entrega é registrado após o envio, para que a análise de produtos ou o CRM possam ver quem foi lembrado e lidar com erros de acordo com as regras da plataforma.

Como funciona

  1. Ações do cliente

    O usuário inicia o onboarding, mas sai antes de completar todas as etapas necessárias.

    user action

  2. Capturar evento

    O sistema detecta o estado de onboarding incompleto e resolve o número de telefone do destinatário.

    phone: "+…"

  3. Construir & enviar

    Uma mensagem de modelo personalizado é construída com três variáveis de corpo e um botão de URL estático.

    POST /sendTemplate

  4. Entregue

    O usuário recebe o lembrete pelo WhatsApp com a etapa pendente e o próximo passo para finalizar a configuração.

    delivered

  5. Status rastreado

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

    status: "read"

WhatsApp Business API for onboarding completion 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 do WhatsApp · Como Aprovar Modelo WABA
  4. 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_STAGE="___"         # {{2}} stage name
TEST_NEXTSTEP="___"         # {{3}} next step

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_STAGE=$TEST_STAGE" \
            "TEST_NEXTSTEP=$TEST_NEXTSTEP"; 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}} stage name → ${TEST_STAGE}
# {{3}} next step → ${TEST_NEXTSTEP}
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_STAGE}" },
        { "type": "text", "text": "${TEST_NEXTSTEP}" }
      ]
    }

  ]
}
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 and JSON "sent": true mean 1MSG accepted the message for sending — not that it already reached the customer's phone. Save the id field (looks like wamid.…) to correlate delivery callbacks.

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 isso; os callbacks de entrega e hookInfo estão relacionados a isso

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

200 OKWebhook de status de entrega — dados que você recebe
{
  "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 o callback com o id retornado pela chamada send

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber callbacks, faça polling 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.

FAQ

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

Relacionado

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