Інструкція з налаштування інтеграції Planfix

Підключення в інтерфейсі Planfix (https://planfix.com/ru/help/API_для_телефонии)

Для підключення та налаштування інтеграції перейдіть у розділ Інтеграції — Віртуальні АТС.

У розділі, що відкрився, виберіть Api ПланФікса для телефоній (наприкінці списку).

Відкриється вікно налаштувань інтеграції.

1 Значення з цих полів необхідні будуть для налаштування підключення на стороні Unitalk.

2. У полі Адреса АТС вказується посилання, на яке надходитимуть запити з Planfix за шаблоном (на скріні вище субдомен акаунта Planfix має значення testic):

https://planfix.unitalk.cloud/planfix/telephone?name=<субдомен акаунта Planfix>

У полі Ключ авторизації АТС — Api ключ з особистого кабінету Unitalk. У розділі Інтеграції — API необхідно його створити.

3. У пункті Короткі номери співробітників вказується зв’язок співробітник — SIP номер, тобто. кожен SIP-номер внутрішньої лінії в Unitalk має відповідати співробітнику в Planfix. Без їхнього зазначення буде лише інформація про пропущені вхідні дзвінки. Обов’язково вказувати.

4. Можливо налаштувати яким чином зберігати запис розмови.

5. Якщо необхідна переадресація виклику на відповідального менеджера, використовуємо цей пункт. За наявності у Вхідних сценаріях Unitalk пункту Дзвінок на відповідального менеджера із запитом за API і вимкненого перенаправлення дзвінка в Planfix повертатиметься тільки ім’я контакту, якщо він є. Опціонально.

6. Якщо потрібна інформація про зовнішню лінію в аналітиці, на яку надійшов дзвінок. Телефонний номер лінії (може бути не тільки номером) відповідає значенню зовнішньої лінії Unitalk. Опціонально.

Так само можливо в аналітику зберігати додаткову інформацію про завершений дзвінок, для цього необхідно в самій аналітиці створити поле з ім’ям потрібної мітки аналітики Unitalk, доступні такі значення:

• • utmSource
  • utmMedium
  • utmCampaign
  • utmTerm
  • utmContent
  • googleId
  • facebookClientId
  • referer

Щоб додати поля аналітики, перейдіть Управління акаунтом — Аналітики — Телефонія.

Для сутностей Дзвінок і Пропущений дзвінок додайте поля із зазначеними назвами і типом даних “Рядок”.

Для успішного збереження сутностей Дзвінок і Пропущений дзвінок необхідно для поля “Тривалість (сек)” встановити значення за замовчуванням 0.

Якщо ці дані не будуть збиратися, то у відповідному полі під час заповнення необхідно вказати “0”.

Підключення в інтерфейсі Unitalk

(https://docs.google.com/document/d/17hqVTVDxvdPKH-71RDg399laQJ9Q9NVI75apjYiNUz0)

1. У розділі Обробка подій вибираємо ДОДАТИ ДІЮ.

2. У випадаючому меню Дія вибираємо Відправити вебхук.

3. Вказуємо назву обробника подій (як приклад planfix calls) трохи згодом за ним налаштовують Вихідні вебхуки. URL має значення: https://planfix.unitalk.cloud/unitalk/call. HTTP метод залишаємо POST/

4. Додаємо параметри в URL. Ключ name приймає значення субдомена акаунта Planfix. Якщо необхідні мітки аналітики, додаємо так само ключ with_utm з довільним значенням без спец. символів (&=;%№”! тощо), можна залишити порожнім, важлива сама наявність ключа для обробки міток. Приклад налаштованих полів із мітками аналітики:

5. Додаємо ключі в HTTP Header. Використовуються такі ключі та значення:

• • • • planfix-url – значення вказуємо з першого пункту з налаштування на стороні Planfix, Адреса для прийняття запитів;
      • planfix-token – значення вказуємо з першого пункту з налаштування на стороні Planfix, Ключ авторизації (token) ПланФікса;
      • token – значення вказуємо Api ключа, який був створений у розділі Інтеграції —API і введений у другому пункті з налаштування на стороні Planfix, Ключ авторизації АТС.

Приклад налаштованого HTTP Header:

6. Не забуваємо зберегти.

7. Переходимо в розділ Інтеграції — API, у формі Обробка подій дзвінків (Вихідні вебхуки) на кожну з 4 наданих подій додаємо оброблювач, створений раніше. Результат:

8. Опціонально. Якщо необхідна переадресація виклику на відповідального менеджера, у розділі IP телефонія — Вхідні сценарії в наявному сценарії або в новоствореному додаємо пункт Дзвінок на відповідального менеджера.

У випадаючому списку Шукати відповідального вибираємо Запит у Ваш API. У полі Вкажіть URL вводимо посилання за таким шаблоном:

https://planfix.unitalk.cloud/unitalk/call_route?planfix–url=<Адреса для прийманнтя запитів із п.5>&planfix–token=<Ключ авторизації (token) ПланФікса з п.5>&name=<субдомен з п.5>

Приклад готового посилання:

https://planfix.unitalk.cloud/unitalk/call_route?planfix-url=https://testic.planfix.ua/tel/api&planfix-token=f418f1be8e69310ccc80290ec2c7a74e&name=testic

• Інтеграція
• Налаштування
• Підключення