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

WhatsApp Business API para solicitação de reenvio de documento

O cenário envia ao cliente um modelo de WhatsApp personalizado quando um documento enviado não pode ser aceito e ele deve enviá-lo novamente.

Visão geral do caso de uso

O cenário envia ao cliente um modelo de WhatsApp personalizado quando um documento enviado não pode ser aceito e eles devem enviá-lo novamente. A mensagem inclui o nome do cliente, tipo de documento e instruções de reenvio (por exemplo, imagem desfocada, data expirada). Um botão de URL estático abre o portal ou formulário de upload.

Modelo exemplo

Olá, {{1}}! Não conseguimos aceitar seu {{2}}. {{3}} Por favor, faça o upload do documento novamente usando o botão abaixo. Se você tiver perguntas — estamos aqui para ajudar.

Reenviar documento
  • {{1}}
    nome do cliente
  • {{2}}
    tipo de documento a ser reenviado (por exemplo, cópia do passaporte, comprovante de endereço, comprovante de renda)
  • {{3}}
    razão ou instrução para reenvio (ex.: a imagem estava borrada, envie uma foto colorida até sexta-feira)
  • “Reenviar documento”
    botão — fixo no modelo Meta
WhatsApp Business API for document resubmit request

Quando usá-lo

Atingir esse cenário quando um cliente enviou um documento durante o onboarding, KYC ou finalização da compra, mas a revisão o rejeitou — e ele parou ou abandonou antes de reenviar, sem uma conversa aberta no WhatsApp para contatá-lo na sessão. Isso se encaixa nas equipes de produto desbloqueando a verificação de identidade, empréstimos e fluxos financeiros que estão aguardando scans mais claros ou formulários assinados, e em agências enviando webhooks de revisão de documentos do CRM ou BPM para lembretes de reenviar pelo WhatsApp.

Fluxos parados desbloqueados sem troca de e-mails incessante
Três variáveis de corpo carregam o nome do cliente, o tipo de documento e a instrução específica de reenvio, para que o cliente saiba o que corrigir em vez de adivinhar a partir de um email de rejeição genérico.
Alcance clientes fora da janela de 24 horas
Como o cliente não tem um chat aberto, um modelo de WhatsApp aprovado é a única mensagem inicial permitida — Este cenário envia esse modelo com o contexto do documento em vez de esperar que eles escrevam primeiro.
Faça o upload novamente em um toque
O botão de URL estático fixo no modelo da Meta abre o portal ou formulário de upload, para que o cliente possa reenviar pelo WhatsApp sem precisar procurar um link no e-mail.
Sem reescrita do agente em cada rejeição
Quando a revisão do documento sinaliza reenvio, o sistema resolve o telefone e cria o modelo a partir dos campos de revisão — não copia tipos de documentos nem reescreve a solicitação manualmente.
Entrega registrada para como funciona acompanhamento
O resultado da entrega é registrado após o envio para o CRM ou Como funciona de acompanhamento, e o cliente pode continuar na sessão assim que responder ou fazer o upload.

Como funciona

  1. Disparar

    Revisão de documentos ou como funciona sinaliza que o cliente deve reenviar um documento.

    event · triggered

  2. Capturar evento

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

    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 cliente recebe a solicitação de reenvio pelo WhatsApp com o contexto do documento e as instruções.

    delivered

  5. Status rastreado

    O resultado da entrega está registrado; o cliente pode fazer upload pelo portal e continuar na sessão após a resposta.

    status: "read"

WhatsApp Business API for document resubmit request

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_AWAITEDITEM="___"         # {{2}} awaited item
TEST_ADDITIONALINFO="___"         # {{3}} additional info

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_AWAITEDITEM=$TEST_AWAITEDITEM" \
            "TEST_ADDITIONALINFO=$TEST_ADDITIONALINFO"; 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}} awaited item → ${TEST_AWAITEDITEM}
# {{3}} additional info → ${TEST_ADDITIONALINFO}
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_AWAITEDITEM}" },
        { "type": "text", "text": "${TEST_ADDITIONALINFO}" }
      ]
    }

  ]
}
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": truesignificam que 1MSG aceitou a mensagem para envio — não que ela já tenha chegado ao telefone do cliente. Salve o idcampo (parecewamid.…) para correlacionar as 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; as callbacks de entrega e hookInfo são vinculadas a isso

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 de envio

  • timestamp

    Segundos Unix, como uma string

Se você preferir não receber chamadas de retorno, 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 aguardando 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.

FAQ

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