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

WhatsApp Business API para notificação de conclusão

O cenário envia ao cliente um modelo personalizado WhatsApp quando eles completam uma etapa em um processo de múltiplas etapas.

Visão geral do caso de uso

O cenário envia ao cliente um modelo personalizado de WhatsApp quando eles completam uma etapa em um processo de múltiplas etapas. A mensagem inclui o nome do cliente, a etapa concluída e o que acontece a seguir. Um botão de URL estático abre o portal ou a página de status.

Exemplo de modelo

Olá,{{1}}! Estágio "{{2}}" concluído com sucesso. Passando para a próxima etapa:{{3}}Se você precisar de ajuda — estamos aqui.

Abrir portal
  • {{1}}
    nome do cliente
  • {{2}}
    nome de estágio concluído (por exemplo, envio de documento, verificação de identidade, pagamento)
  • {{3}}
    próximo passo ou etapa seguinte (por exemplo, revisão do gerente dentro de 2 dias úteis)
  • “Abrir portal”
    botão — fixo no template Meta
WhatsApp Business API for stage completion notification

Quando usar a IA

Alcance este cenário quando um cliente finalizar uma etapa em um processo de múltiplas etapas — integração, solicitação de empréstimo, cumprimento de pedido — e você precisar confirmar o marco, além de explicar o que acontecerá a seguir, mas não houver um chat aberto no WhatsApp. Isso se aplica a fluxos de integração de SaaS e KYC, pipelines B2B onde uma etapa de revisão de documentos acabou de ser concluída, e agências que estão enviando eventos de etapas concluídas a partir de CRM, BPM ou um sistema de fluxo de trabalho personalizado.

Menos desistências em processos longos
Três variáveis de corpo contêm o nome do cliente, o rótulo da etapa concluída e o próximo passo, para que o marco chegue no WhatsApp, onde eles já conversam, em vez de esperar um email que talvez nunca abram.
Menos chamadas para suporte de status
O template nomeia a etapa que passou e o que vem a seguir, para que o cliente não precise chamar o suporte ou pesquisar conversas na caixa de entrada para saber em que ponto está na jornada.
Sem atualizações de progresso manuais
O fluxo de trabalho ativa o modelo quando marca uma etapa como concluída e resolve o telefone do destinatário, para que ninguém precise reescrever os nomes das etapas ou o texto do próximo passo para cada cliente.
Acesso ao portal pelo chat
Um botão de URL estático fixo no template Meta abre o portal ou a página de status, enquanto apenas as três variáveis do corpo são enviadas pela API.

Fluxo de Trabalho

  1. Gatilho

    O fluxo de trabalho marca uma etapa como concluída e dispara um evento de etapa concluída.

    event · triggered

  2. Evento de captura

    O sistema resolve os campos de número de telefone do destinatário e de etapa.

    phone: "+…"

  3. Construir & enviar

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

    POST /sendTemplate

  4. Entregue

    O cliente recebe a notificação do WhatsApp com o contexto da etapa e o próximo passo.

    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 stage completion notification

Implementação técnica

Requisitos

  1. 1MSG API Key · Como obter a chave da API
  2. Conta de 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_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 e JSON"sent": truemédia 1MSGaceitoMensagem para enviar — não que já tenha chegado ao telefone do cliente.idcampo (parece que)wamid.…para correlacionar retornos 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 e faça retornos de entrega.hookInfoestão focados nisso

A entrega em si chega mais tarde, como um retorno separado. Registre um webhookPOST …/webhook) e 1MSG POSTs atualizações de status para 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 o retorno com oidretornado pela função de envio.

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber retornos, escolha não participar.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 aguardando 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 de início frio requerem um modelo aprovado pela Meta.

Relacionado

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