Ссылка скопирована
Поиск

Подключение Телефонии UIS по API (⚠️ Скоро!)

Содержание:


Настройка функционала API в USI

Подключите тариф

Важно! Для того, чтобы использовать телефония по API в МедЛоке необходимо иметь тариф включающий в себя телефонию в UIS.

Для подключения телефонии в личном кабинете UIS потребуется:

  1. Подключите функциональность API.

Для работы с МедЛок достаточно будет данных следующих модулей:

  • Call API Базовый набор.
  • Call API Управление вызовами.
  • Data API.
  • Data API для получения отчётов и статистики.
  • Data API для настройки.

2. Подключите пакет «Загрузка коммуникаций из внешних систем» в дополнение к «Базовые отраслевые решения».

Настройте пользователя и его права

  1. Создайте (или использовуйте имеющегося) пользователя с правами доступа к Data API и Call API.
OLD_LK_API_settings

2. Включите ключ API.

Api_settigs

3. Сгенерируйте ключ API и сохраните его, он понадобится при подключении модуля в МедЛок.

generate_key

Выполните настройки безопасности

  1. Для корректной работы функционала перейдите в раздел «Аккаунт» и затем в подраздел «Правила и настройки безопасности».
настройка uis

2. Во вкладке «API» нажмите кнопку «+ Добавить» и добавьте IP 0.0.0.0/0 в белый список. Не забудьте сохранить изменения, нажав на иконку дискеты справа.

Если в личном кабинете UIS IP-адрес МедЛока не добавлен в список разрешенных, то при подключении модуля Телефония отобразится ошибка.

Ошибка на первом шаге если не указан IP

Если личный кабинет UIS обновился, настройки правил безопасности можно открыть в разделе «Безопасность» и затем в подразделе «Настройки безопасности».

Настройки безопасности в новом ЛК

Подключите модуль «Телефония» в МедЛок

Подключите и настройте модуль «Телефония» в МедЛок.

Подробную инструкцию читайте в статье Как подключить модуль «Телефония».

Настройте HTTP-уведомления в UIS

После подключения модуля в МедЛок, для отображения звонков необходимо настроить уведомления в личном кабинете UIS.

Если у вас старый личный кабинет UIS

  1. Перейдите в личный кабинет UIS.
  2. Откройте раздел «Уведомления».
  3. Выберите подраздел «HTTP-уведомления».
  4. Нажмите кнопку «+ Добавить HTTP-уведомление».
Старый ЛК UIS

Если у вас обновленный личный кабинет UIS

  1. Перейдите в личный кабинет UIS
  2. Откройте раздел «HTTP-уведомления»
  3. нажмите кнопку «+ Добавить HTTP-уведомление»
Новый ЛК UIS

Создайте HTTP уведомления

Создайте 5 типов уведомлений по инструкциям ниже.

Noti


Уведомление №1

  • Название - Начало разговора
  • Тип события - Начало разговора
  • Настройка HTTP - POST
  • URL - вставить URL скопированный на шаге 10
  • Текст уведомления:
{
"notification_name":{{notification_name}},
"notification_time":{{notification_time}},
"external_id": {{external_id}},
"contact_info":{
"contact_phone_number":{{contact_phone_number}},
"contact_id": {{contact_id}}
},
"employee_info": {
"employee_full_name": {{employee_full_name}},
"employee_id": {{employee_id}}
},
"call_source": {{call_source}},
"call_session_id":{{call_session_id}},
"direction": {{direction}},
"leg_ids": {{leg_ids}}
}

Уведомление №2

  • Название - Завершение звонка
  • Тип события - Завершение звонка
  • Настройка HTTP - POST
  • URL - вставить URL скопированный на шаге 10
  • Текст уведомления:
{
"notification_name": "call_finished",
"lost_reason": {{lost_reason}},
"finish_reason": {{finish_reason}},
"is_lost": {{is_lost}},
"call_status": {{call_status}},
"call_session_id": {{call_session_id}},
"notification_timestamp": {{notification_timestamp}},
"direction": {{direction}},
"virtual_phone_number": {{virtual_phone_number}},
"contact_phone_number": {{contact_phone_number}},
"external_id": {{external_id}}
}

Уведомление №3

  • Название - Окончание разговора
  • Тип события - Окончание разговора
  • Настройка HTTP - POST
  • URL - вставить URL скопированный на шаге 10
  • Текст уведомления:
{
"notification_name": "conversation_ended",
"call_session_id": {{call_session_id}},
"notification_timestamp": {{notification_timestamp}},
"direction": {{direction}},
"virtual_phone_number": {{virtual_phone_number}},
"contact_phone_number": {{contact_phone_number}},
"external_id": {{external_id}}
}

Уведомление №4

  • Название - Завершение плеча
  • Тип события - Завершение плеча
  • Настройка HTTP - POST
  • URL - вставить URL скопированный на шаге 10
  • Текст уведомления:
{
"notification_name": "leg_ended",
"call_session_id": {{call_session_id}},
"notification_timestamp":{{notification_timestamp}},
"external_id": {{external_id}},
"employee_phone_number": {{employee_phone_number}},
"leg_id": {{leg_id}},
"direction": {{direction}},
"virtual_phone_number": {{virtual_phone_number}},
"contact_phone_number": {{contact_phone_number}}
}

Уведомление №5

  • Название - Исходящее плечо
  • Тип события - Исходящее плечо
  • Настройка HTTP - POST
  • URL - вставить URL скопированный на шаге 10
  • Текст уведомления:
{
"notification_name": "outbound_leg",
"call_session_id": {{call_session_id}},
"notification_timestamp":{{notification_timestamp}},
"external_id": {{external_id}},
"employee_phone_number": {{employee_phone_number}},
"leg_id": {{leg_id}},
"direction": {{direction}},
"virtual_phone_number": {{virtual_phone_number}},
"contact_phone_number": {{contact_phone_number}}
}

Проверьте настройки

Если не сохранили URL адрес его можно получить открыв страницу редактирования модуля Телефония

reload_url

Itog

После настройки уведомлений рекомендуем провести тестовый звонок.

В МедЛок должна отобразится карточка звонка с возможностью принять или отклонить звонок.

Совершенные действия со звонком отобразятся в истории звонков в МедЛок.