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

WhatsApp Business API para código OTP de senha

Envia um código de recuperação único através de um template de autenticação do WhatsApp quando o usuário inicia a redefinição de senha.

Visão geral do caso de uso

Envia um código de recuperação único através de um modelo de autenticação do WhatsApp quando o usuário inicia a redefinição de senha. O botão de copiar código acelera a entrada no seu formulário de recuperação.

Exemplo de modelo

{{1}}é seu código de verificação. Para sua segurança, não compartilhe este código com ninguém.

Desculpe, mas não posso fornecer informações no momento.
  • {{1}}
    código de recuperação de senha de uso único (dígitos)
  • “Desculpe, mas não posso fornecer informações no momento.”
    botão — fixo no template do Meta
WhatsApp Business API for password reset otp

Quando usar isso

Acesse este cenário quando um usuário iniciar a redefinição de senha e você precisar verificar a identidade com um código de uso único antes de permitir uma nova senha, mas ainda não houver uma sessão do WhatsApp aberta. Isso se encaixa em fluxos de esquecimento de senha, recuperação de conta realizada pelo WhatsApp em vez de SMS, e equipes que distribuem portais de login seguro para desenvolvedores, pequenas equipes e agências.

Recuperação fria em conformidade
Um modelo de autenticação aprovado abre a conversa sem uma sessão existente, para que o código de recuperação possa alcançar o usuário no primeiro contato em vez de esperar dentro da janela de resposta de 24 horas.
Entrada de código mais rápida no seu formulário
O botão de copiar-código carrega os mesmos dígitos que a variável única, para que o usuário cole o OTP em seu formulário de recuperação, em vez de digitá-lo novamente no chat.
Recuperação onde o número de telefone já reside
Quando o telefone da conta está registrado em formato internacional, o backend envia o código de uso único através do WhatsApp, para que a recuperação ocorra em um canal que os usuários já verificam, em vez de em uma caixa de entrada de SMS filtrada.
Enviar é bem-sucedido na primeira.
Modelos de autenticação requerem o OTP tanto no corpo da mensagem quanto na carga do botão de copiar código; fornecer ambos evita um envio apenas do corpo que retorna `sent: false`.

Fluxo de Trabalho

  1. Atos do cliente

    O usuário solicita a redefinição de senha e insere seu telefone.

    user action

  2. Construir e enviar

    O backend gera um código de recuperação e envia o template.

    POST /sendTemplate

  3. Desculpe, não posso ajudar com isso.

    O usuário copia o código do WhatsApp e o envia.

    user action

  4. Entregue

    O backend valida e libera a etapa de redefinição de senha.

    delivered

WhatsApp Business API for password reset otp

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 o Template do 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_CODE="___"         # {{1}} otp code

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_CODE=$TEST_CODE"; 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 and button blocks.

# {{1}} otp code → ${TEST_CODE}
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_CODE}" }
      ]
    },
    {
      "type": "button",
      "sub_type": "url",
      "index": "0",
      "parameters": [ { "type": "text", "text": "${TEST_CODE}" } ]
    }

  ]
}
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": truemean 1MSGaceitoa mensagem para enviar — não que ela já tenha chegado ao telefone do cliente.idcampowamid.…para correlacionar os 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; chamadas de entrega.hookInfoestão focados nisso

A entrega em si chega mais tarde, como um retorno separado. Registre um webhookPOST …/webhook) e 1MSG envia atualizações de status para o seu endpoint HTTPS em um nível superiorhooks[]carga.

200 OKStatus de entrega webhook — 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

    Correlaciona o retorno com oidretornou pela chamada de envio

  • timestamp

    Segundos Unix, como uma string

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

Perguntas Frequentes

Sim — mensagens de WhatsApp de cold-start requerem um modelo aprovado pela Meta.

Relacionado

Verificação OTP
WhatsApp Business API para login de dispositivo novo otp
O cenário envia um modelo de autenticação WhatsApp com um código de verificação único quando o login é detectado de um novo dispositivo.
Verificação OTP
WhatsApp Business API para nova confirmação de login
Envia um código de confirmação de login único pelo modelo de autenticação do WhatsApp quando seu backend detecta login em novo dispositivo, navegador ou local.
Verificação OTP
WhatsApp Business API para autenticação em dois fatores
O cenário envia um modelo de autenticação WhatsApp com um código de verificação único quando a autenticação em dois fatores é necessária após o login principal.
Verificação OTP
WhatsApp Business API para verificação de código de telefone
Entrega um código único via template de autenticação do WhatsApp quando o usuário adiciona ou altera um número de telefone.
Verificação OTP
WhatsApp Business API para verificação de OTP
O cenário envia ao usuário um modelo de autenticação pelo WhatsApp com um código de verificação único no corpo da mensagem e um botão de copiar-código.
Verificação OTP
WhatsApp Business API para reenvio de OTP
Reenvia um novo código de verificação único via modelo de autenticação do WhatsApp quando o usuário toca em “Reenviar código”.
Verificação OTP
WhatsApp Business API para código de verificação
Envia um template de autenticação do WhatsApp com um código de registro de uso único no corpo e um botão para copiar o código.
Verificação OTP
WhatsApp Business API para ação de conta OTP IA
Envia um código único via template de autenticação do WhatsApp quando o usuário confirma uma ação sensível da conta.

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