💰 Бесплатные сервисные ответы заканчиваются 1 октябряЕщё
1msg official logo

WhatsApp Business API для подтверждения авторизации через otp

Отправляет одноразовый код через шаблон подтверждения WhatsApp, когда пользователю нужно подтвердить вход или доступ.

Обзор сценария

Отправляет одноразовый код авторизации через шаблон аутентификации WhatsApp, когда пользователю необходимо подтвердить вход или доступ. Кнопка «Копировать код» ускоряет ввод в форме входа или авторизации.

Пример шаблона

{{1}} — ваш код подтверждения. Для безопасности не сообщайте этот код никому.

Скопировать код
  • {{1}}
    одноразовый код подтверждения авторизации (цифры)
  • “Скопировать код”
    кнопка — исправлено в шаблоне Meta
WhatsApp Business API for authorization confirmation otp

Когда использовать это

Используйте этот сценарий, когда пользователь начинает вход в систему или должен подтвердить авторизацию перед доступом к защищённой области, и вам нужен одноразовый код при холодном старте до создания какой-либо сессии WhatsApp. Это подходит для проверки при входе, повышения уровня авторизации перед доступом к защищённым ресурсам и для команд, которые отправляют безопасные порталы для разработчиков, небольших команд и агентств.

Авторизация при холодном запуске
Утверждённый шаблон аутентификации открывает диалог без существующей сессии, так что код авторизации может быть доставлен пользователю при первом контакте, а не ждать в 24-часовом окне для ответа.
Более быстрое введение кода в вашей форме входа
Кнопка «Скопировать код» содержит те же цифры, что и единственная переменная в теле, поэтому пользователь вставляет OTP в вашу форму входа или авторизации вместо того, чтобы перепечатывать его из чата.
Авторизация, где номер телефона уже используется
Когда номер телефона аккаунта указан в международном формате, бэкенд отправляет одноразовый код через WhatsApp, чтобы верификация поступила в канал, который пользователи уже проверяют, вместо того чтобы попасть в отфильтрованный Инбокс SMS.
Успешная отправка с первой попытки
Шаблоны аутентификации требуют, чтобы OTP присутствовал как в теле сообщения, так и в нагрузке кнопки копирования кода; указание обоих параметров предотвращает ситуацию, когда отправляется только тело сообщения и возвращается `sent: false`.

Как это работает

  1. Действия клиента

    Пользователь начинает вход или авторизацию и вводит номер своего телефона.

    user action

  2. Создать и отправить

    Сервер генерирует код авторизации и отправляет шаблон.

    POST /sendTemplate

  3. Копировать код

    Пользователь копирует код из WhatsApp и отправляет.

    user action

  4. Доставлено

    Бэкенд проверяет и завершает авторизованную сессию.

    delivered

WhatsApp Business API for authorization confirmation otp

Техническая реализация

Предварительные условия

  1. Ключ API 1MSG · Как получить ключ API
  2. Аккаунт WhatsApp Business · Как подключить WABA
  3. Шаблон WhatsApp · Как утвердить шаблон WABA
  4. Согласие клиента на получение сообщений · Как управлять согласием клиентов

Примеры кода

#!/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

Статус ответа и доставки

HTTP 2xx и JSON "sent": true означают, что 1MSG приняла сообщение для отправки, но не то, что оно уже доставлено на телефон клиента. Сохраните id поле (выглядит как wamid.…), чтобы сопоставить колбэки по доставке.

200 OKОтвет
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Принято для отправки — ещё не на устройстве клиента

  • id

    Храните это: доставочные обратные вызовы и hookInfo используют это как ключ

Доставка приходит позже, отдельным обратным вызовом. Зарегистрируйте вебхук (POST …/webhook), и 1MSG отправляет обновления статуса на ваш HTTPS-ендпоинт в основном hooks[] теле запроса.

200 OKВебхук статуса доставки — содержимое, которое вы получаете
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    sent, delivered, read — или статус сбоя, если применимо

  • id

    Соотносит колбэк с id, возвращённым вызовом send

  • timestamp

    Секунды Unix в виде строки

Если вы не хотите получать обратные вызовы, вместо этого опрашивайте GET {base}/{channel}/hookInfo?messageId=<id>. На практике доставка часто завершается за считанные секунды, но контракт API этого не гарантирует, поэтому никогда не блокируйте поток в ожидании этого.

Распространённые ошибки

СтатусОтветПричина
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.

ЧАСТО ЗАДАВАЕМЫЕ ВОПРОСЫ

Да, для холодных сообщений WhatsApp требуется одобренный Meta шаблон.

Связанные

Подтверждение OTP
WhatsApp Business API для подтверждения регистрации приложения
Отправляет в WhatsApp шаблон аутентификации с одноразовым кодом подтверждения регистрации в теле сообщения и кнопкой «Копировать код».
Подтверждение OTP
WhatsApp Business API для миграции sms на whatsapp otp
Отправляет одноразовый код подтверждения через шаблон аутентификации WhatsApp при переключении доставки OTP с SMS на WhatsApp.
Подтверждение OTP
WhatsApp Business API для безопасного подтверждения действий OTP
Сценарий отправляет шаблон аутентификации WhatsApp с одноразовым кодом, когда требуется подтвердить безопасное действие.
Подтверждение OTP
WhatsApp Business API для подтверждения доступа к сервису
Отправляет одноразовый код подтверждения через шаблон аутентификации WhatsApp, когда нужно подтвердить личность перед использованием защищённого сервиса.
Подтверждение OTP
WhatsApp Business API для OTP входа на новом устройстве
Сценарий отправляет пользователю в WhatsApp шаблон с кодом подтверждения, если попытка входа отмечена как выполненная с нового устройства.
Подтверждение OTP
WhatsApp Business API для подтверждения нового входа
Отправляет одноразовый код подтверждения через шаблон WhatsApp, когда ваше приложение фиксирует вход с нового устройства, браузера или местоположения.
Подтверждение OTP
WhatsApp Business API для двухфакторной аутентификации
Сценарий отправляет в WhatsApp шаблон аутентификации с одноразовым проверочным кодом, если после основного входа требуется двухфакторная аутентификация.
Подтверждение OTP
WhatsApp Business API для кода проверки номера телефона
Отправляет разовый код через шаблон аутентификации WhatsApp, когда пользователь добавляет или меняет номер телефона.

Интегрируйте WhatsApp за часы
без проблем с инфраструктурой