Как начать пользоваться

Для работы интеграции необходимо создать учетную запись в сервисе Новофон.

Перед подключением выполните следующие шаги:

  1. Зарегистрируйтесь на сайте Новофон.
  2. Подтвердите мобильный номер РФ.
  3. Подпишите договор.
  4. Пополните баланс.
  5. Подключите виртуальный номер.

Разрешение доступа к API

По умолчанию доступ к API запрещен.

Чтобы разрешить выполнение запросов:

  1. Откройте личный кабинет администратора.
  2. Перейдите в раздел Настройки → Правила и настройки безопасности → API.

В поле IP/Маска укажите:

0.0.0.0/0

Получение API-ключей

Для подключения Новофон к Salebot необходимо включить доступ по API-ключу.

Для этого:

  1. Перейдите в раздел Телефония → Пользователи АТС.
  2. Откройте пользователя Администратор.
  3. Перейдите на вкладку API.
  4. Включите параметр Использовать ключ API.
  5. Для параметра Время жизни выберите значение Вечно.

В этом разделе понадобятся значения полей:

  • Key
  • Secret

После генерации обязательно сохраните значение Secret. Повторно посмотреть его невозможно.

При повторной генерации ключей их потребуется заменить во всех интеграциях, где они используются.

Подключение Новофон в Salebot

Перейдите в Salebot:

Телефония → Новофон

Введите полученные данные.

После сохранения настроек сервис будет подключен.

Настройка сотрудников

Для совершения звонков необходимо:

  1. Подключить виртуальные номера (Телефония → Виртуальные номера).
  2. Добавить сотрудников в разделе Пользователи АТС.
  3. Назначить каждому сотруднику виртуальный номер во вкладке ВАТС.

Без назначенного виртуального номера звонки из Salebot работать не будут.

Также понадобится ID сотрудника.

Его можно посмотреть в адресной строке страницы сотрудника.

Например:

.../users/111111

где:

111111

— ID сотрудника.

Как происходит сопоставление клиента

Для телефонии используются номера в формате:

71234567890

или с кодом другой страны, например:

375XXXXXXXXX

Требования к номеру:

  • начинается с кода страны;
  • содержит не менее 11 цифр;
  • не содержит пробелов и других символов.

Алгоритм поиска клиента

  1. Выполняется поиск клиента телефонии.
  2. Если клиент не найден, выполняется поиск по значениям всех переменных клиентов проекта.
  3. Первая найденная запись считается найденным клиентом.

Если клиент не найден:

  • при подключенном мессенджере (например WhatsApp) создается клиент этого мессенджера;
  • если мессенджеры не подключены — создается клиент телефонии.

Такому клиенту будут доступны только звонки.

WhatsApp и Instagram принадлежат компании Meta, деятельность которой признана экстремистской и запрещена на территории РФ.

Функция обратного звонка

Для совершения звонка используется функция:

novofon_call(client_phone, employee_phone, employee_id)

Параметры

Параметр Описание
client_phone телефон клиента, например '79004443322'
employee_phone виртуальный номер сотрудника, например '79500000033'
employee_id ID сотрудника в системе Новофон

Пример использования:

Настройка звонков из карточки клиента

Добавьте сотрудника в Salebot и откройте редактирование его профиля.

В поле Способ совершения телефонных звонков доступны варианты:

  • Отключить звонки — звонки недоступны.
  • Звонки через приложение — используется установленное приложение (Zoiper и др.).
  • Звонки по API Новофон — звонок проходит через АТС Новофон.

После выбора варианта Звонки по API Новофон появятся дополнительные поля:

  • виртуальный номер;
  • ID сотрудника.

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

Настройка вебхуков

Чтобы получать уведомления о звонках:

  1. Перейдите в Новофон:
    Интеграции → Уведомления о событиях v1.
  2. Нажмите Подключить интеграцию.

В поле URL для уведомлений о звонках АТС укажите адрес:

https://chatter.salebot.pro/novofon_webhook/<secret-key>

Например:

https://chatter.salebot.pro/novofon_webhook/4aa6************

где <secret-key> — значение Secret, полученное в Новофон.

Отметьте события, по которым необходимо получать уведомления.

Не забудьте включить переключатель Интеграция активна.

После сохранения появится уведомление:

Обработка событий звонков

После завершения звонка в Salebot приходит callback вида:

novofon_call_event EVENT

Возможные события

Событие Описание
NOTIFY_START начало входящего звонка
NOTIFY_OUT_START начало исходящего звонка
NOTIFY_END завершение входящего звонка
NOTIFY_OUT_END завершение исходящего звонка
NOTIFY_INTERNAL входящий звонок на внутренний номер АТС
NOTIFY_ANSWER ответ на внутренний или внешний звонок

Если разговор был записан, клиенту автоматически будет создана переменная:

novofon_record_link

Она содержит ссылку на запись разговора.

Дополнительные переменные

  • novofon_call_id
  • novofon_call_disposition
  • novofon_call_event
  • novofon_record_lifetime