Как работает умный шлюз

Умный шлюз в OTP-кодах — режим работы через API, где вы генерируете код, а платформа доставляет его по 9 каналам с каскадом

Коротко: умный шлюз — это режим, при котором вы сами генерируете код, а платформа только доставляет его по каналам с каскадом.

Кому подходит

  • Роль: Клиент, Разработчик
  • Уровень: Опытный

Что это

Умный шлюз — второй режим работы OTP-сервиса. В отличие от «Под ключ», здесь вы контролируете генерацию и проверку кода, а платформа берёт на себя доставку.

Это один из двух режимов работы OTP-сервиса. Первый режим — Под ключ — когда платформа сама генерирует и проверяет код. Умный шлюз работает через API — технические детали в разделе API и интеграция.

Тестовое подключение бесплатно — договор не требуется, мы предоставляем баланс для тестирования. Для продолжения работы после теста — запросите договор через поддержку сервиса.

Начните с быстрого старта →

Перед началом

  • Вы зарегистрированы в OTP-сервисе.
  • У вас есть свой механизм генерации OTP-кодов.
  • У вас есть имя отправителя со статусом Активно.
  • Вы готовы создать API-ключ с правами omni-api.
  • Вы настроили endpoint для вебхука (если нужны статусы доставки через push).
  • Вы знаете, какие каналы доступны — 9 каналов OTP.

Чем отличается от «Под ключ»

КритерийПод ключ (2FA)Умный шлюз
Кто генерирует кодПлатформаВы
Кто проверяет кодПлатформаВы
Что вы получаете«Код верный / неверный»Статус доставки сообщения
Сложность интеграции2 запроса1 запрос + своя логика
Кому подходитБез своего OTP-модуляСо своим генератором кодов

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

  • У вас уже есть свой OTP-механизм.
  • Нужны специфические правила доставки.
  • Нужен полный контроль над логикой.

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

  • Нет своего OTP-механизма. Используйте режим Под ключ.
  • Нужна простая интеграция за 2 запроса.

Как начать

1
Зарегистрируйтесь в OTP-сервисе

Создайте аккаунт и получите доступ в личный кабинет сервиса.

2
Зарегистрируйте имя отправителя

Имя отправителя нужно для отправки сообщений по любому каналу.

Как зарегистрировать имя отправителя →

3
Создайте API-ключ с правами omni-api

Ключ используется для аутентификации в API умного шлюза.

Как создать API-ключ →

4
Отправьте первый код

Сформируйте запрос с кодом и правилами каскада.

Как отправить первый код через умный шлюз →

5
Настройте каскад

Выберите каналы, successOn и timeout для каждого шага.

Как настроить каскад в умном шлюзе →

Карта раздела API

Технические детали — эндпоинты, параметры, форматы payload, коды ответов, статусы и ошибки.

API и интеграция — обзор

Все эндпоинты и группы API

OMNI API — отправка кодов

Эндпоинты /messages и /omnimessages

Форматы payload

JSON-примеры для каждого канала

Статусы сообщений

Push и pull — два способа

Broadcasts API

Запуск рассылок и шаблоны

Справочные эндпоинты

Каналы, отправители, баланс

Обработка ошибок API

Форматы ошибок для каждого API

HTTP-коды ошибок

Полный справочник кодов ответа

Результат

Вы понимаете, как работает умный шлюз, чем он отличается от режима «Под ключ» и знаете, где искать технические детали.

Частые проблемы

Причина: два режима работы — «Под ключ» и «Умный шлюз» — для разных задач.

Решение: если у вас нет своего генератора кодов — «Под ключ». Если есть — «Умный шлюз».

Какой режим выбрать →

Причина: в OTP-сервисе умные сервисы доступны только через каналы.

Решение: используйте сервис Multi API — там HLR, MNP и IMSI доступны через API.

Умные сервисы в Multi API →

Причина: неверный или отсутствующий API-ключ.

Решение: проверьте заголовок X-API-Key и ключ — у него должны быть права omni-api.

Ошибка 401 →

См. также

Какой режим выбрать

Сравнение двух режимов работы

Как работает 2FA-сервис

Режим «Под ключ»

Как отправить первый код

Пошаговый сценарий

Как настроить каскад

Практические рекомендации

Какие каналы использовать для OTP

9 каналов OTP и их номера в API

Как выбрать канал для OTP

Выбор канала и каскад

Нужна помощь?