Документация API

Приблизительное время чтения: 2 минуты

Общие сведения о REST API #

API позволяет подключить к АТС Asterisk любую систему CRM или базу данных. Интеграция CRM и IP АТС решает несколько бизнес‑задач:

  • получение имени звонящего по номеру телефона, для того, чтобы его можно было отобразить на экране телефона или SIP‑клиента;
  • автоматическая маршрутизация входящего звонка от клиента на менеджера, который закреплен за этим клиентом;
  • отображение информации о входящем звонке непосредственно внутри CRM (всплывающая карточка клиента);
  • сохранение в CRM истории всех звонков и записей разговоров;
  • совершение исходящих звонков сразу из интерфейса CRM.

Модель взаимодействия #

Интеграция должна быть двухсторонней. Поэтому часть запросов CRM посылает в сторону АТС Asterisk на указанные точки входа, а часть запросов, наоборот, IP АТС посылает в сторону CRM на единую точку входа.

Взаимодействие производится по протоколу HTTPS. Запросы к АТС принимаются по протоколу HTTPS (допускается HTTP протокол). Это обеспечивает достаточный уровень безопасности для общения систем через сеть Интернет. В целях безопасности данных прием запросов на стороне CRM также рекомендуется реализовывать с использованием протокола HTTPS.

Авторизация осуществляется по адресу CRM или IP АТС, а также по авторизационному ключу (токен), полученному в процессе настройки интеграции.

Для работы с REST API необходимо реализовать ответную часть на стороне CRM системы или базы данных.

Настройка интерфейса REST API в IP АТС BOXPBX

Прейдите в раздел: УПРАВЛЕНИЕ Настройки сервера REST API

  1. Включите чек-бокс для использования REST API.
  2. Укажите название для интеграции.
  3. Сгенерируйте ключ для подключения к IP АТС.
  4. Укажите домен для отправки запросов в сторону CRM системы.
  5. Заполните поле ключ авторизации CRM системы, возьмите его из личного кабинета CRM.
  6. Укажите в настройках CRM системы домен АТС для приема запросов в сторону вашей IP АТС.
Прокрутить вверх