Подключение универсального сервиса для оповещений

К магазину автозапчастей на платформе PARTS SOFT можно подключить свой сервис отправки SMS- или Push-рассылок по API, вместо готовой интеграции с сервисами отправки оповещений. Например, в случае подключения своего сервиса отправки SMS, схема работы универсального сервиса будет такая:

Подключение в админпанели системы PARTS SOFT

ШАГ 1. В списке сервисов раздела Служебные → SMS и мессенджеры → Сервисы нажмите кнопку Универсальный сервис и подтвердите подключение сервиса во всплывающем окне.

ШАГ 2. На странице настройки сервиса выполните следующие действия:

Настройки универсального сервиса

1. Название. Укажите название сервиса. Оно будет отображаться на странице подключенных сервисов.

2. Метод запроса. Выберите используемый метод HTTP-запроса, GET или POST.

3. Адрес запроса. Введите требуемый адрес для отправки запросов от системы PARTS SOFT. При составлении используйте переменные для передачи в запросе:

• {{message.phone}} — телефона клиента, как указан в системе.
• {{message.clean_phone}} — телефона клиента, очищенного от лишних символов (плюс и скобки).
• {{message.message}} — текста сообщения из системы PARTS SOFT.
• {{message.id}} — идентификационного номера сообщения в системе.

4. Тело POST запроса. Если вы используете метод запроса POST, то введите тело запроса. Для метода GET тело запроса не указывается.

5. HTTP заголовки. Если вы хотите передавать дополнительную информацию вместе с запросом, то укажите HTTP-заголовки в формате «Заголовок: Значение». Каждый заголовок должен быть на новой строке. Например, Content-Type: application/json.

ШАГ 3. Заполните дополнительные поля:

Заполнение дополнительных полей

• Использовать для кодов. Если вы подключаете универсальный сервис для рассылки SMS-сообщений, то в этом поле можно разрешить рассылку только на номера определенных операторов. Для этого укажите коды в формате: код 1|код 2|..|код n.  Здесь код 1, код 2..код n — коды операторов. Например, если ввести 903|901, сервис будет использоваться только для номеров вида 79031234567 или 7901234567;
• Не использовать для кодов. По аналогии с полем выше, укажите коды только тех операторов, на номера которых не будут отправляться сообщения с помощью этого сервиса.
• Регион. Выберите конкретный регион, в котором будет использоваться подключаемый сервис для оповещений. Если не указывать, то он будет использоваться для всех регионов из списка.
• Приоритет. Система PARTS SOFT будет игнорировать приоритет и отправлять в первую очередь оповещения через универсальный сервис, если он активен. В случае, если подключено два и более универсальных сервисов, то оповещения будут отправляться согласно заданным приоритетам.

ШАГ 4. Включите галочку активен и нажмите кнопку Сохранить.

Тестирование с помощью webhook.site

Webhook.site это сервис для тестирования и отлаживания вебхуков и HTTP-запросов. Протестируем GET запрос, для этого выполните следующие действия:

ШАГ 1. Перейдите на сайт Webhook.site и скопируйте уникальный URL для тестирования.

Уникальный URL для тестирования

ШАГ 2. Подключите Универсальный сервис, как описано в разделе «Подключение универсального сервиса».

ШАГ 3. Укажите Метод запроса — GET.

ШАГ 4. Вставьте скопированный адрес в поле Адрес запроса и дополните его переменными. Пример будет такой:

https://webhook.site/167178fe-b52b-4f94-b408-476367720c04?phone={{message.phone}}&message={{message.message | url_encode }}

ШАГ 5. Нажмите кнопку Сохранить.

ШАГ 6. Переведите позицию любого заказа клиента в статус из группы Пришло.

ШАГ 7. Перейдите обратно на сайт Webhook.site и убедитесь, что запрос доставлен.

Мы передали телефон клиента и сообщение о смене статуса заказа.

Результат теста

Настройка сервиса на примере GSM VoIP шлюза Yeastar

GSM VoIP шлюз — это устройство, позволяющее перенаправлять трафик из интернета в GSM сеть. Одной из функций таких устройств это отправка SMS при помощи API. Ниже мы рассмотрим подключение универсального сервиса для рассылки SMS на примере Yeastar TG100 с использованием статического IP-адреса и GET запроса.

Этап 1. На стороне веб-панели Yeastar

Предварительно выполните стартовую настройку устройства согласно его инструкции и выполните следующие шаги:

ШАГ 1. В разделе SMS веб-панели Yeastar нажмите кнопку Настройки AMI.

Переход к настройкам AMI

ШАГ 2. На открывшейся странице выполните следующие действия:

1. Активируйте галочку Включить AMI.

2. Придумайте и введите имя пользователя и пароль в поля Пользователь и Пароль, соответственно. Эти данные будут использоваться для составления запроса.

Настройки AMI

ШАГ 3. Нажмите кнопку Сохранить.

Теперь для отправки SMS мы можем использовать следующий запрос:

http://ip:port/cgi/WebCGI?1500101=account=login&password=pass&port=1&destination=89991234567&content=test

ip:port — внешний статический IP-адрес и порт устройства.

login и pass — данные, которые мы указали в полях Пользователь и Пароль на шаге 2 выше.

port=1 — номер GSM-порта.

89991234567 — номер телефона, на который отправляется СМС. Номер должен начинаться с 8.

test — текст отправляемого сообщения.

Этап 2. На стороне PARTS SOFT

Для подключения универсального сервиса на стороне PARTS SOFT выполните шаги из раздела «Подключение в админпанели системы PARTS SOFT». При этом в нашем случае нужно указать следующие данные:

• Метод запроса — GET.
• Адрес запроса

http://202.168.180.530:8080/cgi/WebCGI?1500101=account=username&password=12345678&port=1&destination={{message.clean_phone | replace_first: "7", "8" }}&content={{message.message | url_encode }}

202.168.180.530:8080 — статический внешний ip-адрес GSM VoIP шлюза с указанием порта.

username — имя пользователя, указанное при настройке устройства в разделе «Этап 1. На стороне веб-панели Yeastar» в поле «Пользователь».

12345678 — пароль, указанный при настройке устройства в разделе «Этап 1. На стороне веб-панели Yeastar» в поле «Пароль».

port=1 — номер GSM порта шлюза. Наше устройство имеет один GSM порт, поэтому указываем 1.

{{message.clean_phone | replace_first: "7", "8" }} — выводим номер телефона клиентов без скобок и плюса, дополнительно используем фильтр для замены 7 на 8 в начале номеров телефона.

{{message.message | url_encode }} — текст сообщения.

Настройка SMS сервиса на стороне PARTS SOFT

Теперь ваши клиенты будут получать SMS сообщения в случаях, описанных в статье Настройка SMS-оповещений.