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

WhatsApp Business API para confirmação de recebimento de documentos

O cenário envia ao cliente um modelo de WhatsApp personalizado quando os documentos necessários são recebidos e registrados no back office.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando os documentos necessários são recebidos e registrados no back office. A mensagem inclui o nome do cliente, o processo de verificação ou documento e o que acontece em seguida. Um botão com URL estático abre o portal de status ou a página da conta do cliente.

Modelo exemplo

Hello, {{1}}! We have received your documents for {{2}}. {{3}} Thank you for submitting them — we will keep you updated on the progress.

Verificar status
  • {{1}}
    nome do cliente
  • {{2}}
    processo de verificação ou documentação (por exemplo, verificação KYC, documentos de onboarding, anexos de ticket de suporte)
  • {{3}}
    próximo passo ou cronograma esperado (por exemplo, revisão em até 2 dias úteis, nós o notificaremos quando estiver concluído)
  • “Verificar status”
    botão — fixo no modelo Meta
WhatsApp Business API for documents received confirmation

Quando usá-lo

Atingir este cenário quando um cliente envia documentos necessários para onboarding, KYC ou um pedido de suporte e precisa de um reconhecimento de que os arquivos chegaram — sem uma conversa aberta no WhatsApp para confirmar na sessão. Isso se encaixa em equipes de produto processando filas de entrada de KYC, mesas de suporte recebendo anexos de ticket e agências conectando webhooks de recebimento de documentos de plataformas CRM, BPM ou eKYC ao WhatsApp outbound.

Menos ligações perguntando "você recebeu meus documentos?"
Três variáveis no corpo contêm o nome do cliente, o processo de verificação ou documento e a próxima etapa de revisão, para que o cliente tenha comprovação no WhatsApp sem precisar ligar para o suporte ou reenviar arquivos.
Verificações de status a um toque
Um botão de URL estático rotulado como Verificar status abre o portal ou a conta — o link é fixo no modelo da Meta aprovado, enquanto apenas o texto do corpo é enviado pela API.
Alcance clientes fora da janela de 24 horas
Como não há uma conversa ativa, o envio utiliza um modelo de WhatsApp aprovado via API 1MSG — o único canal que pode confirmar o recebimento de documentos quando o cliente não escreveu primeiro.
Sem reconhecimento manual para cada upload
Quando um gatilho de documentos recebidos é acionado no onboarding, KYC ou suporte, o sistema resolve o número de telefone e envia o modelo nesse evento em vez de alguém copiar o texto de confirmação manualmente.
Entrega registrada para como funciona acompanhamento
O resultado de 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. Disparar

    O cliente faz o upload dos documentos necessários através de um portal, aplicativo ou canal de suporte.

    event · triggered

  2. Entregue

    O sistema captura o evento de documentos recebidos e resolve o número de telefone do destinatário.

    delivered

  3. Construir & enviar

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

    POST /sendTemplate

  4. Atos do cliente

    O cliente recebe a confirmação do WhatsApp com o contexto do processo e os próximos passos.

    user action

  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 documents received 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 WhatsApp · Como Aprovar o 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_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_PROCESS=$TEST_PROCESS" \
            "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}} process name → ${TEST_PROCESS}
# {{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_PROCESS}" },
        { "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": true significam que 1MSG aceitou a mensagem para envio — não que ela já chegou ao telefone do cliente. Salve o id campo (parece como wamid.…) para correlacionar callbacks de entrega.

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

    Accepted for sending — 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

    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 em 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 do WhatsApp de início frio exigem 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 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.
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.

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