API позволяет рассылать сообщения через ваши проекты и сервисы по протоколам HTTP/HTTPS, SMTP и SMPP. Готовые библиотеки на разных языках программирования подключаются к вашему проекту и помогают отправлять сообщения из любого места с помощью одной команды.
При возникновении определенных событий может потребоваться отправка уведомительных сообщений, содержащих информацию, необходимую для обработки данных событий. Для решения подобных задач можно воспользоваться расширением нашей системы мониторинга, которое позволяет отправлять различные уведомления через наш сервис из внешних систем. Для этого в личном кабинете на странице "Создание группы заданий" требуется создать соответствующую группу, где указать шаблоны уведомлений, типы сообщений, отправляемых при возникновении события, а также контакты для уведомлений (номера телефонов, e-mail адреса, jabber аккаунты).
Для отправки уведомления необходимо вызвать методом GET или POST адрес:
http://bingosms.ru/sys/ping.php?login=<login>&psw=<password>&id=<id>
Серверу передаются следующие параметры:
Параметр
Значение
login
Логин Клиента.
psw
Пароль Клиента (можно добавить или изменить на данной странице).
Название правила или сервера в задании. Заменяет макрос {NAME} в тексте уведомления.
host
Адрес или IP проверяемого сервера. Заменяет макрос {HOST}.
info
Дополнительная информация о событии. Заменяет макрос {INFO}.
ok
При формировании уведомления использовать следующий шаблон:
0 – (по умолчанию) используется шаблон группы заданий, отправляемый при сбое.
1 – используется шаблон группы заданий, отправляемый при восстановлении.
В случае ошибки Сервер возвращает следующую строку:
N – номер ошибки, может принимать следующие значения:
Значение
Описание
1
Ошибка в параметрах.
2
Неверный логин или пароль. Также возникает при попытке отправки сообщения с IP-адреса, не входящего в список разрешенных Клиентом (если такой список был настроен Клиентом ранее).
3
Группа заданий не найдена.
4
IP-адрес временно заблокирован.
9
Попытка отправки более пяти одинаковых запросов на отправку уведомления в течение минуты.
Данная ошибка возникает также при попытке отправки пятнадцати и более запросов одновременно с разных подключений под одним логином (too many concurrent requests).
В случае успешного запроса Сервер возвращает ответ в виде строки.
при fmt = 0 и fmt = 1:
OK
при fmt = 2:
<result>OK</result>
при fmt = 3:
{
"result": "OK"
}
Сервер не принимает более пяти одинаковых запросов на отправку уведомления в течение минуты для снижения
нагрузки и защиты от ошибок и зацикливаний в программе на стороне Клиента.