Интеграция собственной CRM и телефонии

3.1 Виджет на WebRTC для звонков из браузера.

Если ваша CRM использует https вы можете встроить наш виджет. Внимание: Не размещайте виджет в открытом доступе в сети, иначе через ваш аккаунт сможет позвонить любой желающий. При каждой загрузке страницы со стороны серверного кода вам необходимо генерировать ключ для webrtc, полученный с помощью метода GET /v1/webrtc/get_key нашего API (Время жизни ключа - 72 часа).

В личном кабинете на странице Настройки - Интеграции и API в секции "Интеграция WebRTC виджета" необходимо ввести домен вашей CRM и выбрать настройки внешнего вида и расположения виджета. Далее используйте полученный код для интеграции в вашу CRM. Вместо YOUR_KEY подставьте сгенерированный через API ключ; вместо YOUR_SIP подставьте ваш SIP-номер или полный логин внутреннего номера АТС, с которого будут совершаться звонки.

Пример кода:

<script src="https://my.zadarma.com/webphoneWebRTCWidget/v8/js/loader-phone-lib.js?v=17"></script>
<script src="https://my.zadarma.com/webphoneWebRTCWidget/v8/js/loader-phone-fn.js?v=17"></script> 
<script>
  if (window.addEventListener) { 
    window.addEventListener('load', function() { 
      zadarmaWidgetFn('YOUR_KEY', 'YOUR_SIP', 'square' /*square|rounded*/, 'en' /*ru, en, es, fr, de, pl, ua*/, true, "{right:'10px',bottom:'5px'}"); 
    }, false); 
  } else if (window.attachEvent) { 
    window.attachEvent('onload', function(){ 
      zadarmaWidgetFn('YOUR_KEY', 'YOUR_SIP', 'square' /*square|rounded*/, 'en' /*ru, en, es, fr, de, pl, ua*/, true, "{right:'10px',bottom:'5px'}"); 
    }); 
  } 
</script>

Виджет в скрытом состоянии:

Виджет в развернутом положении:

3.2 Звонки с помощью обратного звонка (Callback)

В интерфейсе CRM возле каждого номера телефона добавляем иконку/кнопку для инициации звонка на этот номер телефона, также рекомендуем реализовать веб-телефон с номеронабирателем для звонка на новый номер, ранее не сохраненный в CRM. Исходящие звонки осуществляются по принципу Callback. На внутреннем номере виртуальной атс должен быть настроен IP телефон или софтфон для приема и совершения звонков. Пользователь в CRM кликает на иконку рядом с номером телефона или на кнопку звонка в веб-телефоне, со стороны CRM отправляется Callback.

Метод GET /v1/request/callback/

Параметры:

• from – трехзначный внутренний номер АТС который назначен пользователю.
• to – номер телефона, на который хочет позвонить пользователь.

Пользователь получает входящий звонок на свой софтфон, снимает трубку и ожидает соединения с номером, на который он хочет позвонить.

Пример реализации:

Когда внутренний номер атс получает или совершает звонок, необходимо чтобы в CRM отображалось соответствующее уведомление. Уведомление должно быть показано только у того пользователя, внутренний номер которого участвует в звонке. В уведомлении о звонке может отображаться следующая информация:

• Номер телефона
• Имя контакта/компании/лида если номер телефона ранее сохранен в CRM, имя является ссылкой для перехода непосредственно к сущности (контакт/компания/лид)
• Если звонок от нового клиента - кнопка создания контакта/компании/лида
• Имя ответственного сотрудника, если звонок от существующего клиента
• Виртуальный номер, на который поступил входящий звонок(Номер подключенный в Zadarma)

Триггером для появления всплывающего уведомления является событие NOTIFY_INTERNAL (начало входящего звонка на внутренний номер АТС.) либо событие NOTIFY_OUT_START (начало исходящего звонка с АТС.)

Когда снимут трубку и начнется разговор, в CRM будет отправлено уведомление NOTIFY_ANSWER (ответ при звонке на внутренний или на внешний номер.) которое в свою очередь является триггером для всплывающего уведомления, при получении NOTIFY_ANSWER в уведомлении может запуститься отсчет времени показывающий длительность звонка в реальном времени, также например заголовок уведомления “Звонок от 442037691880” может быть заменен на “Разговор с 442037691880”

Когда звонок завершен, будет отправлено уведомление NOTIFY_END (конец входящего звонка на внутренний номер АТС.) или NOTIFY_OUT_END (конец исходящего звонка с АТС.)

После получения NOTIFY_END или NOTIFY_OUT_END всплывающее уведомление должно закрыться.

Пример реализации:

Для подгрузки аудиозаписей из Zadarma в CRM необходимо чтобы в настройках внутреннего номера АТС была включена запись звонков в облако. После завершения звонка, когда аудиозапись будет готова для скачивания, в CRM будет отправлено уведомление NOTIFY_RECORD (запись звонка готова для скачивания.)

В параметре call_id_with_rec содержится идентификатор используя который можно получить запись звонка, для этого используем метод GET /v1/pbx/record/request/. В ответе будет содержаться ссылка на файл с записью звонка, если в вашей CRM есть собственное облако для хранения файлов, запись может автоматически загружаться в облако CRM. Если своего хранилища нет, можно реализовать кнопку play для воспроизведения аудиозаписи по полученной ссылке. Кнопку воспроизведения записи звонка можно размещать рядом с информацией о звонке, например в ленте лида/контакта/сделки и в общей статистике звонков.

Для формирования общей статистики звонков в CRM необходимо использовать информацию о звонках полученную из уведомлений NOTIFY_END и NOTIFY_OUT_END.

Автоматическое создание сущностей или событий в CRM при входящих звонках с неизвестных номеров или исходящих звонках на неизвестные номера. При поступлении входящего звонка или инициации исходящего звонка, номер телефона сверяется с базой данных из CRM и если номер не найден, можно создавать новый контакт/лид/сделку/заявку и назначать эту сущность пользователю который совершал звонок. Рекомендуем делать отдельные опции автосоздания событий для входящих и исходящих звонков. Для исходящего звонка создавать сущность можно: когда звонок инициирован (уведомление NOTIFY_OUT_START), когда звонок отвечен (уведомление NOTIFY_ANSWER), по завершению звонка (уведомление NOTIFY_OUT_END). Номер телефона, на который совершается звонок передается в параметре destination

Для входящего звонка создавать сущность можно когда звонок поступил на внутренний номер пользователя CRM (уведомление NOTIFY_INTERNAL, номер звонящего передается в параметре caller_id) для того чтобы во время разговора пользователь уже мог открыть только что созданную карточку звонящего клиента, редактировать её, вносить пометки и т.д. По завершению входящего звонка будет отправлено уведомление NOTIFY_END в котором в параметре internal будет передан внутренний номер АТС, который принял этот звонок, сопоставив этот номер с списком пользователей CRM, система поймет какого пользователя назначить ответственным. Либо можно создавать сущность по завершению входящего звонка после получения NOTIFY_END. Некоторые CRM системы вообще не используют автоматическое создание сущностей, давая возможность менеджеру принявшему звонок определить целевой звонок или нет и вручную создать лид/контакт/задачу.

При входящем звонке от существующего клиента (Его номер телефона уже сохранен в CRM) звонок автоматически направляется на пользователя ответственного по этому клиенту, звонящий при каждом звонке к вам не слушает голосовое приветствие и затем не просит соединить с его персональным менеджером с которым он разговаривал минуту назад, его звонок автоматически будет направлен на телефон ответственного менеджера, пользователя CRM. Реализуется с помощью уведомления NOTIFY_START

В параметре caller_id передается номер звонящего, если этот номер ранее сохранен в CRM например как контактный номер одного из клиентов и по этому клиенту есть ответственный, можно выполнить направление входящего звонка на внутренний номер ответственного. Также можно указать длительность дозвона до ответственного пользователя, например 15 секунд, если ответственный отлучился и не может снять трубку, через 15 секунд входящий звонок от его клиента будет возвращен на голосовое меню и далее звонок пойдет по сценарию атс. Реализуется с помощью ответа на POST запрос NOTIFY_START

{
    "redirect": “101”,
    "return_timeout": “15”
}

где,

• redirect - внутренний номер АТС (трехзначный номер).
• return_timeout - Значение в секундах >= 3 - продолжительность звонка внутреннего номера, прежде чем звонок вернется на меню, рекомендуемое значение 15 или 20.

Опция позволяет передавать имя клиента из CRM на ip-телефон или софтфон пользователя в котором он принимает входящий звонок. Реализуется с помощью уведомления NOTIFY_START и ответа на него, в уведомлении в параметре caller_id передается номер звонящего, если номер уже сохранен в CRM и закреплен за клиентом/контактом/лидом, в ответе на NOTIFY_START можно передать латиницей имя клиента:

{
    "caller_name": "IBM"
}

где,

• caller_name - имя клиента/компании из CRM.

При входящем звонке от клиента при получении уведомления NOTIFY_END из параметра caller_id можно получить номер звонящего и найти клиента/контакт/лид с этим номером и менеджера ответственного по этому клиенту. Если звонок не был отвечен, статус звонка не answered в параметре disposition, ответственному менеджеру можно создать задачу/напоминание/уведомление о том что был пропущенный звонок от клиента.

Вы можете создать список номеров звонки с которых будут отклоняется, вносить номера в список можно на странице настроек телефонии, либо сделать для каждого пользователя кнопку добавления номера в черный список. Реализуется также на основе уведомления NOTIFY_START и ответа на него, если номер звонящего из параметра caller_id находится в черном списке CRM в ответе на NOTIFY_START передаем:

{
    "redirect": "blacklist" 
}

После успешного выполнения предыдущих шагов и успешном тестировании на уровне отдельного пользователя можно подать заявку на добавление интеграции в маркетплейс Zadarma (если ежемесячная посещаемость сайта вашей системы превышает 30 000 пользователей). Это позволит пользоваться данной интеграцией любому пользователю Zadarma, имеющему активированный аккаунт и настроенную АТС. Также это позволит конечному пользователю быстро и удобно сохранять все необходимые настройки. Заявки необходимо отправлять на электронный адрес integration@zadarma.com с пометкой "Запрос на добавление интеграции c системой [Имя вашей СRM] в маркетплейс Zadarma". Заявка должна содержать следующие дополнительные данные:

URL-адрес в Вашей CRM для включения интеграции

На данный адрес будет отправляться информации о пользователе Zadarma, который пытается осуществить интеграцию телефонии и Вашей СRM. В выбранном формате передачи данных (GET, POST) Вам будет передан уникальный идентификатор пользователя в формате строки md5 hash. В ответ вы должны отправить случайно сгенерированный ключ, который будет привязан к данному пользователю. В дальнейшем при каждом запросе к Вашей CRM системе идентификатор пользователя и отправленный вами хэш будут использоваться как подтверждающие данные с использованием заголовка:

Authorization: Bearer [userId . hash]

Также идентификатор пользователя будет передаваться в каждом уведомлении о звонке в поле zdUserId. Необходимы примеры возможных ответов.

URL-адрес в Вашей CRM для отключения интеграции

На данный адрес будет отправляться запрос при попытке отключения пользователем интеграции. Используется стандартная авторизация Bearer

URL-адрес в Вашей CRM для получения уведомлений о звонках

Передаются уведомления о звонках для всех интегрированных пользователей. Определить пользователя можно используя поле zdUserId. Формат уведомлений можно найти на странице описания API. Используется стандартная авторизация Bearer.

URL-адрес в Вашей CRM, при обращении на который можно получить имя клиента по номеру телефона

Необходимо для использования функции "Отображение имени клиента на софтфоне". Необходим пример запроса и возможных ответов. Используется стандартная авторизация Bearer.

(Опционально) URL-адрес в Вашей CRM, при обращении на который можно получить список менеджеров

Необходимо для использования функции "Привязка менеджеров ко внутренним номерам АТС". Это позволит пользователю сразу из личного кабинета Zadarma сопоставить менеджеров CRM и внутренние номера АТС Zadarma. В случае необходимости синхронизации этих данных с Вашей CRM необходимо также указать URL адрес, на который можно отправить эти данные в JSON-формате. Необходим пример запроса и возможных ответов. Используется стандартная авторизация Bearer.

Отображаемое имя автора интеграции (можно отправить название Вашей компании и ссылку на главную страницу)

Логотип интеграции в формате PNG, на прозрачном фоне и с размерами 500 x 150px