Общие сведения
Avanpost FAM позволяет осуществлять для отправки SMS-сообщений любой SMS-шлюз, поддерживающий HTTP-интерфейс для отправки сообщений. В качестве SMS-шлюза может быть использован шлюз от компании ООО «СМС-Центр» (smsc.ru), Beeline или МТС.
Интеграция с SMS-шлюзом необходима для использования фактора SMS OTP (отправка одноразового кода посредством SMS-сообщения).
Данная инструкция описывает процесс настройки интеграции Avanpost FAM с SMS-шлюзом smsc.ru, Beeline, МТС.
Системные требования для интеграции Avanpost FAM:
- Установленный и настроенный в сети компонент Avanpost FAM Server;
- Наличие сетевого доступа с сервера, на котором размещён Avanpost FAM Server, до URL оператора сотовой связи.
Настройка
Настройка на стороне личного кабинета smsc.ru
- В разделе «Настройки» → «Имена для SMS» зарегистрировать имя отправителя:
- В разделе «Настройки» установить корректный логин и пароль:
Логин и пароль потребуются на следующем шаге при настройке на стороне административной консоли Avanpost FAM.
Настройка на стороне административной консоли Avanpost FAM
Настройка параметров выполняется в соответствии с документацией сервиса на HTTP-интерфейс отправки сообщений, поэтому в случае изменения параметров на стороне сервиса может потребоваться корректировка указанной ниже инструкции. Подробное описание параметров описано в общей инструкции по настройке интеграции с SMS-шлюзами.
- В разделе «Настройки методов аутентификации» создать новый метод с типом SMS:
- Указать параметры метода аутентификации:
- Ключ-тэг – любое значение латиницей; данный идентификатор может быть использован для диагностики интеграции в отладочном журнале системы Avanpost FAM;
- Метод активен – включить, если предполагается использование этого метода после выполнения настройки;
- Включить DEBUG-режим (одноразовый пароль выводится в лог, без отправки SMS) – флаг снят;
- URL-адрес SMS-шлюза – указать значение в соответствии с документацией сервиса; на момент разработки инструкции адрес -
https://smsc.ru/sys/send.php; - HTTP-метод запроса – выбрать
POST; - Заголовок Content-Type –
application/x-www-form-urlencoded; - Фактор доступен только для пользователей с подтвержденным номером телефона – на усмотрение администратора;
- Атрибуты строки запроса (HTTP Query String) –Тело запроса содержит массив объектов JSON добавить две записи:
- Ключ – login; значение – значение логина, указанное в разделе «Настройки» в личном кабинете smsc.ru;
- Ключ – psw; значение – значение пароля, заданное в разделе «Настройки» в личном кабинете smsc.ru;
- Атрибуты тела запроса – оставить пустым;
- Тело запроса содержит массив объектов JSON – флаг снят;
- Атрибуты заголовка запроса (HTTP Header).
- Сохранить изменения.
Настройка выполнена.
Приложение А. Примеры настроенной интеграции на стороне Avanpost FAM
Максимальная длина сообщений не должна превышать количество символов, указанное в документации оператора!
Ниже приведены примеры настройки интеграции через метод запроса POST. Для реализации запросов методом GET необходимо первоначально обратиться к оператору, чтобы он при необходимости произвел настройки доступа до ваших IP-адресов, а затем реализовывать интеграцию. Эта схема более сложна технически в силу данной причины, по возможности рекомендуется использовать настройку через HTTP-метод POST. Приведенные примеры необходимо адаптировать под собственные параметры, а также использовать актуальную информацию по документации от оператора.
Авторизация требуется при каждом подключении к серверу.
Пример настроенной интеграции для BeeLine
Пример выполненной настройки на стороне административной консоли Avanpost FAM для ОПС BeeLine:
Перед настройкой следует сверить параметры с актуальной инструкцией ОПС для настройки шлюза.
Список параметров оператора для настройки:
| Параметр | Описание |
|---|---|
| URL-адрес SMS-запроса | URL запроса |
| Метод запроса | GET или POST |
| Заголовок Content-Type | Заголовок запроса: например, для UTF-8 кодировки следует указать Content-Type: application/x-www-form-urlencoded; charset=utf-8 |
| user | Логин для входа в систему на сайте |
| pass | Пароль для входа в систему на сайте |
| gzip | Параметр использования gzip, в значении none – не использовать Content-encoding: gzip |
| action | Действие, здесь следует указать post_sms |
| message | Текст сообщения, следует поставить значение .Code |
| target | Список адресатов, нужно поставить значение .PhoneNumber для получения списка номеров телефонов |
| show_description | По умолчанию нужно оставить true |
Пример настроенной интеграции для МТС
Пример выполненной настройки на стороне административной консоли Avanpost FAM для ОПС МТС (метод POST):
Запрос состоит из массива сообщений (submits) и необязательного параметра naming.
Список параметров оператора для настройки (метод POST):
| Параметр | Описание |
|---|---|
| URL-адрес SMS-запроса | URL запроса |
| Метод запроса | POST |
| submits | Массив сообщений, Максимальное количество элементов: 1000. Состоит из msid типа string (номера получателя) и message (сообщения) типа string, максимальная длина 2000 символов. |
| naming | Имя отправителя, необязательный параметр |
Список параметров оператора для настройки (метод GET):
В случае успешного ответа код 200 возвращается, когда общая структура запроса и авторизация корректны. Если при обработке сообщения из списка возникла ошибка — она будет описана в полях «code» и «message».
| Параметр | Описание |
|---|---|
| URL-адрес SMS-запроса | URL запроса |
| Метод запроса | GET |
| login | Логин |
| password | Пароль |
| msisdn | Номер телефона адресата. Формат: 79161234567 |
| fromstring | Имя отправителя, которое видит получатель |
| messagestring | Текст сообщения. До 8 сегментов в одном SMS: 536 символов на кириллице и 1224 на латинице. Кодировка — UTF-8. |