На случай, если Ваши бизнес-процессы требуют отправки уведомлений пользователям ботов по сценарию, определяемому Вашим ПО, то Вы можете отправлять API запросы в систему BotManager с указанием получателей и текста сообщения.
Таким образом, например, как только ваш клиент создал на Вашем сайте заказ, Вы можете прислать ему уведомление в мессенджер вместо SMS уведомлений (да, клиент конечно должен быть уже к этому моменту пользователем бота, и Ваше ПО должно знать ID пользователя в системе BotManager)
Отправка запроса
Для отправки уведомления через API запрос необходимо отправить HTTPS запрос на следующий URL:
https://<your_subdomain>.bot-manager.com/server/api/<any_of_your_messenger_tokens>/sendNotification
Вам необходимо указать Ваш под домен компании, а также любой из токенов подключенных мессенджеров. Если Вы используете несколько ботов, то не забывайте указывать токен именно того бота (любой из подключенных к этому боту мессенджеров), пользователям которого отправляется уведомление.
В заголовке запроса должно быть «Content-Type: application/json».
В теле запроса передается объект со следующими атрибутами, представленный в формате JSON.
|
Название |
Значение |
|
screen_id |
Номер отправляемого экрана уведомления, который можно узнать в дереве экранов при выборе этого экрана в поле «ID для API» |
|
receivers |
Одно из: · Массив ID пользователей в системе BotManager · Значение «*» – означает отправку абсолютно всем пользователям · Тег запроса данных из БД, возвращающий список ID пользователей (без квадратных скобок) |
|
text |
Текстовое значение, которое будет использоваться в специальном поле «[ТекстСообщения]». Необязательное поле |
Ответ сервера
В случае успешного запроса, сервер поставит отправку уведомлений в очередь и вернет 200 код.
Пример успешного ответа: {“status”: “success”, “expected_receivers_count”: 12340}
В случае ошибки сервер вернет: {“status”: “error”, “description”: “No ‘receivers’ parameter supplied”}
Формат уведомления
Пользователь получит обычное уведомление с текстом, указанным в настройках уведомления. Чтобы значение text вывелось пользователю, не забудьте вставить «[ТекстСообщения]» в тексте уведомления.