Как создать шаблон сообщения для OTP
Создание шаблона сообщения с кодом — переменная, канал, сохранение
Коротко: шаблон — это готовое сообщение с плейсхолдером
{{code}}. В режиме «Под ключ» платформа подставляет сгенерированный код, в режиме «Умный шлюз» — код, переданный вами через API.
Кому подходит
- Роль: Клиент, Разработчик
- Уровень: Новичок
Что это
Шаблон сообщения — это заранее подготовленный текст, который используется для отправки кода. В шаблоне есть плейсхолдер {{code}}, который заменяется на актуальный код.
В OTP-сервисе есть два режима работы с шаблонами. Оба шаблона создаются в личном кабинете, но в разных разделах:
- Под ключ (2FA Service) — платформа сама генерирует код и подставляет его вместо
{{code}}. Шаблон настраивается внутри 2FA-интеграции (раздел 2FA Service). - Умный шлюз — вы сами генерируете код и передаёте его в API-запросе. Платформа подставляет переданный код вместо
{{code}}. Шаблон создаётся в разделе Активы → Шаблоны сообщений.
Режим 1. Под ключ (2FA Service)
В этом режиме платформа сама генерирует и проверяет код. Шаблон настраивается внутри 2FA-интеграции — в разделе 2FA Service.
- Откройте 2FA Service → 2FA SMS.
- Выберите интеграцию или создайте новую.
- В поле Текст сообщения введите текст с плейсхолдером
{{code}}. - Сохраните интеграцию.
При отправке платформа заменит {{code}} на сгенерированный ею код.
Как настроить 2FA-интеграцию →
Режим 2. Умный шлюз
В этом режиме вы сами генерируете код и передаёте его в запросе. Платформа заменит {{code}} на код, который вы передали. Шаблон создаётся в разделе Активы → Шаблоны сообщений или через API.
Способ А. В личном кабинете
Кнопка в правом верхнем углу страницы Активы → Шаблоны сообщений.
Понятное имя шаблона. Например, «Код для входа».
SMS, WhatsApp, TTS, RCS, FlashCall, Email, Telegram Gateway, Viber или Mobile Push.
Используйте переменную {{code}} там, где должен быть код.
Пример для SMS: Ваш код: {{code}}. Никому не сообщайте его.
Пример для TTS: Ваш код подтверждения: {{code}}. Повторяю: {{code}}.
Нажмите Сохранить изменения.
Способ Б. Через API
Для создания шаблонов используйте эндпоинт POST /broadcast/templates в Broadcasts API. При отправке кода через /messages или /omnimessages передайте код в параметре payload — платформа подставит его в шаблон вместо {{code}}.
Примеры шаблонов
SMS
Ваш код: {{code}}. Никому не сообщайте его.
Здравствуйте! Ваш код подтверждения: {{code}}.
TTS (диктовка кода голосом)
Ваш код: {{code}}. Повторяю: {{code}}.
Тема: Ваш код подтверждения
Текст: Ваш код: {{code}}. Если вы не запрашивали код, проигнорируйте письмо.
Переменная {{code}} обязательна. Без неё код не подставится, и шаблон не сработает. Проверьте, что переменная указана именно так — {{code}}.
Частые проблемы
Причина: в тексте шаблона нет переменной {{code}} или она написана с ошибкой.
Решение: добавьте переменную {{code}} — именно в таком виде, с двойными фигурными скобками.
Причина: в режиме «Под ключ» шаблон настраивается не в разделе Активы, а внутри 2FA-интеграции. Решение: откройте 2FA Service → 2FA SMS → ваша интеграция → поле Текст сообщения. Как настроить 2FA-интеграцию →
Причина: в запросе передан неверный код или не передан вовсе.
Решение: проверьте параметр payload в запросе к /messages или /omnimessages — код должен быть передан явно.
Как отправить код через умный шлюз →
Причина: шаблон не сохранён, или вы ищете шаблон для «Под ключ» в разделе Активы, а он настраивается внутри 2FA-интеграции. Решение: проверьте, что нажали Сохранить изменения. Если нужен шаблон для умного шлюза — он должен быть в разделе Активы → Шаблоны сообщений. Для режима «Под ключ» шаблон настраивается в 2FA Service → 2FA SMS → ваша интеграция → Текст сообщения.
См. также
Нужна помощь?
- OTP-коды: support@otpcod.ru