Управление отправкой сообщений осуществляется через REST API.
Отправка сообщения
Для отправки сообщения необходимо выполнить запрос типа POST на URL:
http://<хост>:<порт>/v1/mailing/add
<хост>
– адрес сервера, на котором установлен сервис,<порт>
– порт сервиса.
По умолчанию параметр порт
имеет значение 12023
. Подробнее о настройках сервиса можно прочитать в подразделе "Установка и настройка сервиса" в статье "Сервис отправки сообщений".
В теле запроса передаются следующие параметры:
Параметры phoneNumber
, text
, gateways
обязательны для заполнения.
Наименование | Описание | Возможные значения | Примечания |
---|---|---|---|
phoneNumber | Номер телефона без кода | ||
text | Текст сообщения | Количество символов в сообщении не должно превышать | |
settingsKey | Ключ настройки СМС шлюза | Если значение не задано, то используется СМС шлюз с ключом " Параметр используется только для отправки сообщений через СМС шлюз На кассовом сервере реализована возможность задать ключ для следующих СМС шлюзов:
| |
gateways | Список шлюзов для отправки |
|
{ "phoneNumber": "9635311111", "text": "Тестовое сообщение", "gateways": [ "TELEGRAM" ] }
В результате будет создана задача на рассылку с данными, указанными в параметрах запроса.
1e0373dc-77c9-4496-8ce6-ef9bbb89b042