Подтверждение номера телефона с помощью отправки Telegram‑сообщения с кодом (аунтентификация). Telegram Gateway API

Запрос для отправки Telegram‑сообщения с кодом подтверждения


Параметры запроса

чёрный — обязательные параметры
серый — необязательные параметры
URL
https://userarea.sms-assistent.by/api/v1.2/send_tg/plain
Описание параметров в запросе
user
ваш логин, для доступа в Личный кабинет (ЛК)

password
ваш пароль к API, который генерируется на странице «SMS-рассылка» — «Рассылка по API»

recipient
номер получателя (в возможном формате)

validity_period
срок жизни кода в минутах. По умолчанию составляет 5 минут. Допустим диапазон от 1 до 99 минут.

message
код, который необходимо отправить абоненту для подтверждения номера телефона.
Код может содержать от 4 до 8 цифр. Прочие символы в Telegram-сообщении недопустимы.
Если этот параметр не задан, то отправляется только код, состоящий из 6-ти цифр.

code_length
длина кода, который необходимо сгенерировать на нашей стороне и отправить абоненту для подтверждения номера телефона.
  • Минимальное значение: 4
  • Максимальное значение: 8
Если передан код в параметре message, то данный параметр игнорируется.

name
наименование, которое необходимо присвоить рассылке (сообщению)

tg_sms_resend
признак необходимости отправки SMS-сообщения, в случае, если Telegram-сообщение не было доставлено.
  • Значение: 1
  • Прочие значения игнорируются

tg_sms_sender*
отправитель SMS (подпись SMS), от имени которого необходимо отправить абоненту текст SMS-сообщения с кодом подтверждения, если Telegram-сообщение с кодом не было доставлено.
*Параметр обязателен, если передан параметр tg_sms_resend со значением = 1.

tg_sms_text
текст SMS, который отправляется в случае, если Telegram-сообщение не было доставлено. Для указания места подстановки кода можно использовать тег {CODE}.
  • Варианты формирования текста SMS смотрите здесь.
Ответ
возвращается ключ (hash) для проверки отправленного кода подтверждения или ошибка выполнения операции.
  • Пример hash: 41b22c58e4bc7e1ba65142138e55a10e
Ещё в этом разделе