Уведомления о событиях
Что это такое и зачем нужно
В UIS есть сервис уведомлений о различных событиях, связанных с работой сервиса. Уведомления можно использовать для мгновенного оповещения сотрудников с помощью e-mail или sms: например, о потерянном звонке или о потере регистрации SIP-линии. Еще одно применение — интеграция со сторонними сервисами, например, http-передача данных (вебхук) о входящем звонке для автоматического создания карточки в CRM, передача записей звонков в CRM и многое другое.
Подключение
Чтобы подключить e-mail или sms уведомления, в Личном кабинете UIS войдите в Администратор — Аккаунт — Тарифы и опции и включите Уведомления о событиях:
Если хотите использовать HTTP-уведомления, в разделе Тарифы и опции разверните Все опции:
И подключите API Базовый:
После этого можно переходить к настройке: войдите в раздел Уведомления и кликните Добавить:
Настройка и логика работы
Принцип работы уведомлений един и для e-mail, и для sms, и для HTTP: при наступлении заданного события UIS отправляет набор данных об этом событии на указанный в настройках адрес. Количество событий не ограничивается тарифным планом, поэтому вы можете настроить столько уведомлений, сколько требуется для решения вашей задачи.
Название уведомления может быть произвольным, оно нужно, чтобы вы могли отличить одно уведомление от другого, не открывая настройки.
Событие — это как раз то, о чем система будет вас уведомлять. Выберите тип события из предложенного списка в соответствии с задачей, которую хотите решить.
Логика звонковых событий
В уведомлениях для событий, связанных с телефонией, существует идеология, разделяющая звонок на вызов и на «плечи». Плечо — это часть вызова, соединяющая участника звонка и платформу UIS. Таким образом, плечо может быть входящим (часть соединения между вызывающей стороной и платформой) и исходящим (часть соединения между вызываемой стороной и платформой). Звонок, в свою очередь, может также иметь два направления: входящий вызов — вызов на виртуальный номер из внешнего мира, и исходящий вызов — вызов от сотрудников компании.
Условия уведомлений
Условия, при выполнении которых уведомление будет отправлено. Например, если вы хотите получать уведомления только о входящих потерянных звонках, необходимо настроить условие «Направление звонка — Точно соответствует — Входящий звонок»
Для каждого типа события можно добавить одну или несколько групп условий: условия в рамках одной группы работают по принципу «и», а условия, находящиеся в разных группах — по принципу «или».
Способы получения уведомлений
SMS: введите один или несколько номеров в международном формате (без плюса перед кодом страны, например 79539996688). Чтобы не получать sms в нерабочее время, выберите расписание рабочего времени в поле График:
E-mail: введите один или несколько адресов электронной почты, при необходимости так же можно задать время отправки и тему письма:
Telegram: позволяет отправлять уведомления в телеграм через бота UIS. Для настройки необходим следующий порядок действий:
1. Найдите в Telegram пользователя с именем @uis_notify_bot
2. Добавьте его в чат, в который Вы хотите получать уведомления
3. Бот пришлет Вам сообщение с ID чат
4. Введите в строке ниже полученный ID чата
Тело уведомления генерируется автоматически в зависимости от выбранного события, его можно редактировать под свои задачи: добавить произвольный текст и нужные параметры — время наступления события, номер телефона абонента и многие другие. Для это кликните Добавить параметр:
Список доступных параметров зависит от выбранного типа события: например, в событии «входящий звонок на виртуальный номер» не будет параметра, передающего ссылку на запись звонка, потому что разговор еще даже не начал записываться.
Нужный параметр также можно добавить, набрав в теле уведомления символы {{ или %. После ввода этих символов вы можете вводить название нужного параметра прямо на русском языке, и вам будет выводиться наилучшее совпадение.
HTTP-уведомления
В поле URL укажите адрес сервиса, на который должны приходить уведомления. Выберите метод — GET или POST — в зависимости от возможностей принимающей стороны:
Метод GET
Шаблон может представлять собой как JSON (при этом JSON структура может начинаться только с символа «{»),
так и классический query string:
Структура шаблона никак не ограничена — исключение составляют лишь те данные, которые представлены специальными тегами. Для каждого тега указан тип данных, в котором будет передаваться его значение. Тип данных необходимо учитывать при формировании собственной JSON структуры уведомления.
При этом теги, у которых не строковый тип, вы всегда можете превратить в строку, заключив тег в кавычки. Например, номер обращения может быть представлен как число:
и как строка:
Кликните Добавить параметр, чтобы добавить в тело уведомления нужные данные:
Список доступных параметров зависит от выбранного типа события: например, в событии «входящий звонок на виртуальный номер» не будет параметра, передающего ссылку на запись звонка, потому что разговор еще даже не начал записываться.
Нужный параметр также можно добавить, набрав в теле уведомления символы {{ или %. После ввода этих символов вы можете вводить название нужного параметра прямо на русском языке, и вам будет выводиться наилучшее совпадение.
Если на принимающей стороне выполняется проверка по IP-адресу, скопируйте IP нашего сервера из соответствующей строки:
На случай сбоя во время отправки уведомления предусмотрено четыре дополнительных попытки отправки:
- через 2 часа
- через 4 часа
- через 8 часов
- через 16 часов
Тест уведомления
Кликните на Протестировать уведомление и на указанный адрес будет отправлен шаблон со случайными данными.
Важно:
для SMS-уведомлений тестовые уведомления идут в счет доступного вам лимита.