Skill de IA para API do WhatsAppMais
1msg official logo

WhatsApp Business API para confirmação de sucesso da verificação

O cenário envia ao cliente um modelo de WhatsApp personalizado quando a verificação de identidade ou eKYC é aprovada.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando a verificação de identidade ou eKYC é aprovada. A mensagem inclui o nome do cliente, o processo de verificação e o rótulo de status de sucesso. Um botão de URL estático abre a conta ou o portal do cliente.

Exemplo de modelo

Olá, {{1}}! Sua {{2}} foi concluída com sucesso: {{3}}. Agora você pode acessar todos os recursos da conta. Se você tiver dúvidas — estamos aqui para ajudar.

Abrir conta
  • {{1}}
    nome do cliente
  • {{2}}
    processo de verificação (por exemplo, verificação eKYC, verificação de identidade, revisão de documentos)
  • {{3}}
    status de sucesso (por exemplo, Verificado com sucesso, Aprovado, Verificação concluída)
  • “Abrir conta”
    botão — fixo no modelo da Meta
WhatsApp Business API for verification success confirmation

Quando usar isso

Acesse este cenário quando um cliente finalizar a verificação de identidade ou eKYC e o caso for aprovado — e você precisar confirmar o sucesso proativamente antes que eles descubram isso por e-mail ou suporte. Isso se aplica a equipes de fintech fechando filas de KYC, marketplaces ativando vendedores após verificações de identidade e agências conectando webhooks de aprovação de eKYC ou conformidade ao WhatsApp.

Menos ligações de "minha verificação está feita?"
Três variáveis de corpo carregam o nome do cliente, o rótulo do processo de verificação e o status de sucesso, para que o cliente saiba que a verificação foi aprovada sem precisar abrir o e-mail ou ligar para o suporte.
Acesso à conta a um toque de distância
Um botão de URL estático rotulado como Abrir conta abre o portal ou a área da conta — o link é fixo no modelo Meta aprovado, enquanto apenas o texto do corpo é enviado através da API.
Atualizações sem uma janela de chat aberta
Como não há uma conversa ativa, o envio utiliza um modelo de WhatsApp aprovado via a API 1MSG — o único canal que pode alcançar o cliente fora da janela de sessão de 24 horas.
Sem congratulações manuais para cada aprovação
Quando o provedor de eKYC ou o back office marca um caso como aprovado, a integração resolve o número de telefone e aciona o modelo nesse evento, em vez de alguém copiar o texto de sucesso à mão.
Entrega registrada para acompanhar conformidade
O resultado da entrega é registrado após o envio, para que as equipes de CRM ou conformidade possam ver quem foi notificado e lidar com erros de acordo com as regras da plataforma.

Como funciona

  1. Atos do cliente

    O cliente completa a verificação de identidade ou eKYC.

    user action

  2. Escritório

    O back office, o provedor de eKYC ou a integração marca o caso como aprovado ou verificado.

    POST /sendTemplate

  3. Capturar evento

    O sistema resolve os campos de número de telefone do destinatário e de sucesso na verificação.

    phone: "+…"

  4. Construir e 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

  5. Entregue

    O cliente recebe a notificação do WhatsApp informando que a verificação foi bem-sucedida.

    delivered

  6. 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 verification success confirmation

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 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_PROCESS="___"         # {{2}} process name
TEST_STATUS="___"         # {{3}} status label

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_PROCESS=$TEST_PROCESS" \
            "TEST_STATUS=$TEST_STATUS"; 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}} process name → ${TEST_PROCESS}
# {{3}} status label → ${TEST_STATUS}
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_PROCESS}" },
        { "type": "text", "text": "${TEST_STATUS}" }
      ]
    }

  ]
}
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 id campo (parece como 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 isso; os callbacks de entrega e hookInfo são baseados nisso

Delivery itself arrives later, as a separate callback. Register a webhook (POST …/webhook) and 1MSG POSTs status updates to your HTTPS endpoint in a top-level hooks[] payload.

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

    Correlaciona o callback com o id retornado pela chamada de envio

  • timestamp

    segundos Unix, como uma string

Se você prefere 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 ele.

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

Serviço ao Cliente
WhatsApp Business API para esclarecimento de dados de verificação
O cenário envia ao cliente um modelo WhatsApp personalizado se a verificação de identidade ou KYC não puder ser concluída até dados específicos serem aclarados.
Serviço ao Cliente
WhatsApp Business API para notificação de reativação da conta
O cenário envia ao titular da conta um modelo personalizado do WhatsApp quando uma revisão ou verificação da conta é concluída e o acesso é restaurado.
Serviço ao Cliente
WhatsApp Business API para solicitação de confirmação de dados ou assinatura
O cenário envia ao cliente um modelo WhatsApp personalizado quando eles devem assinar um documento ou confirmar dados enviados para continuar.
Serviço ao Cliente
WhatsApp Business API para notificação de verificação rejeitada
O cenário envia ao cliente um modelo de WhatsApp personalizado quando sua eKYC ou verificação de identidade é rejeitada.
Serviço ao Cliente
WhatsApp Business API para notificação de status de verificação
O cenário envia ao cliente um modelo de WhatsApp personalizado quando o status de verificação ou eKYC deles muda.
Serviço ao Cliente
WhatsApp Business API para solicitação de upload de documentos
O cenário envia um modelo de WhatsApp personalizado ao cliente quando um documento necessário está faltando e ele deve carregá-lo para continuar.
Serviço ao Cliente
WhatsApp Business API para notificação de transferência
O cenário envia para o cliente um modelo personalizado de WhatsApp quando um chamado de suporte é transferido para outro departamento.
Serviço ao Cliente
WhatsApp Business API para notificação de status de ticket
O cenário envia ao cliente um modelo de WhatsApp personalizado quando o status de um ticket de suporte muda.

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