SMS-ассистент — документация для разработчиков
Подтверждение номера телефона с помощью отправки Telegram‑сообщения с кодом (аунтентификация). Telegram Gateway API
Основные правила
Общие принципы взаимодействия
1
Методы запросов: Параметры могут передаваться методами GET и POST. Рекомендуемый метод — POST.
2
Кодировка: Все параметры должны передаваться в кодировке UTF-8.
3
Ответ при успехе: В случае успешной отправки кода API возвращает hash, который используется для последующей проверки кода.
Работа с кодом подтверждения
Требования к коду
Код подтверждения — это последовательность только из цифр длиной от 4 до 8 символов. Другие символы не допускаются.
Способы генерации кода
Существует три способа задать код для отправки:
1
Генерация на вашей стороне: Вы самостоятельно генерируете код (от 4 до 8 цифр) и передаёте его в параметре message в вашем запросе.
2
Генерация на нашей стороне (с указанием длины): Вы не передаёте параметр message, но указываете желаемую длину кода (от 4 до 8) в параметре code_length. Наша система сгенерирует случайный код указанной длины.
3
Генерация на нашей стороне (по умолчанию): Вы не передаёте ни параметр message, ни code_length. В этом случае наша система автоматически сгенерирует случайный код из 6 цифр.
Правило приоритета: Если в запросе переданы одновременно и готовый код в message, и требуемая длина в code_length, приоритет будет отдан готовому коду.
Каскадная отправка в SMS (Fallback)
Если сообщение в Telegram не было доставлено (например, у пользователя не установлен Telegram или нет доступа к сети), система может автоматически отправить код в SMS‑сообщении. Эта функция называется каскадной рассылкой.
Имя отправителя
Для SMS можно указать собственное имя отправителя в специальном параметре tg_sms_sender.
Текст сообщения
Текст для SMS (параметр tg_sms_text) формируется одним из трёх способов:
1
Только код: В SMS будет отправлен только код.
- Пример: 123456.
2
Текст с подстановкой кода: Вы передаёте свой шаблон текста, используя тег {CODE} в том месте, где должен стоять код.
- Пример: Ваш код для входа: {CODE}.
3
Текст с кодом в конце: Вы передаёте свой текст, и код будет автоматически добавлен в конец сообщения через пробел.
- Пример: Ваш код для входа → в SMS будет: Ваш код для входа 123456.
Если вы генерируете код на своей стороне (способ №1), его не нужно дублировать в тексте для SMS. Наша система автоматически подставит тот же самый код, который отправлялся в Telegram.
Пользовательский опыт (что видит абонент)
Все сообщения с кодами через Telegram Gateway приходят абонентам в единый официальный чат Telegram. Этот чат является верифицированным (с синей галочкой), но имя вашего сервиса в качестве отправителя не указывается.
Ещё в этом разделе