Що таке API?
API — це спосіб, за допомогою якого одна програма може “домовитися” з іншою. Можна попросити Окі-Токі передати або отримати потрібні дані. Наприклад, автоматично відправляти інформацію про клієнтів у вашу CRM або завантажувати дані назад в Окі-Токі.
У чому користь API для кол-центру?
- Автоматизація процесів: API бере на себе рутинні завдання. Наприклад, новий контакт відправляється у вашу CRM, автоматично оновлюючи дані;
- Інтеграція: за допомогою API легко зв’язати Окі-Токі з іншими системами — CRM, аналітикою, чат-ботами і т.д. Всі інструменти працюють разом, як одне ціле, що робить бізнес-процеси простішими і швидшими.
- Дані в реальному часі: система віддає або приймає інформацію відразу, як тільки вона з’являється. Це зручно для аналізу, моніторингу;
- Просте розширення: можна додавати нові функції та інструменти без складних змін. Це особливо зручно, якщо ваш проєкт росте;
- Зменшення кількості помилок: менше ручної роботи — менше ризиків помилитися. Все відбувається автоматично, швидко і точно.
Типи запитів API в Окі-Токі
В Окі-Токі використовується стандартний спосіб взаємодії з веб-сервісами – REST API. Система отримує інформацію за запитом і надає відповідь у потрібному форматі, частіше за все JSON. У Окі-Токі доступні такі методи запитів:
- GET – використовується для отримання інформації, наприклад, контактів із CRM або статистики дзвінків;
- POST – відправляє нові дані в систему, як, наприклад, масове додавання чи видалення завдань автодзвінка, включення/виключення дайлера.
Щоб протестувати запит, перевірити правильність даних або знайти помилку підійде Postman.
Документація та налаштування API в Окі-Токі
API-документація Окі-Токі — це ваша інструкція з роботи, де описані методи запитів, приклади використання та структура даних. Для зручності технічна документація API поділена на розділи за основними функціями та інструментами Окі-Токі.
Доступ до API
Доступ до API виконується за допомогою токенів – це ключі, які дають системі зрозуміти, хто до неї звертається. З ними легко працювати з API та безпечно передавати дані.
В Окі-Токі користувач може створити власний токен за наявності права “Управління користувачами” у його Ролі. Таке право є у стандартних ролях “Адмін” та “Супервайзер” , але його також можна додати до будь-якої, створеної вами.
“Управління зовнішніми ресурсами, інтеграціями та подіями (Webhook)”- ще одне право, необхідне для роботи з API. Без нього створити інтеграцію або додати Webhook не вийде.
Більше про ролі можете дізнатися в окремій статті на блозі.
Як отримати ключ API?
Для створення будь-якого API- запиту вам необхідний токен. Щоб його згенерувати, перейдіть у розділ Список користувачів. Виберіть у налаштуваннях профілю пункт “Безпека”. Тут можна створити, переглянути або видалити токен.
Коди помилок API запитів
Помилятися може кожен – навіть професіонали постають перед труднощами при передачі даних або виконанні завдань. Головне – знати, як це виправити. Ми підготували список найчастіших помилок при виконанні запиту api:
- 401 (Unauthorized) – у запиті вказано неіснуючий об’єкт або ваш токен неправильний;
- 403 (Forbidden) – це означає, що сервер зрозумів запит, але відмовляє в доступі. Можливо у вас немає прав і дозволів на виконання цього запиту;
- 404 (Not Found) – в URL-посиланні присутні помилки, перевірте правильність внесених даних;
- 405 Method Not Allowed – невірний тип запиту. Наприклад, ви намагалися використовувати метод POST замість GET;
- 422 (Unprocessable Entity) – запит прийнято, але не було оброблено через семантичну помилку в “тілі” даних;
- 429 Too Many Requests – перевищення ліміту запитів;
- 500 (Internal Server Error)– проблеми з роботою сервера або з обробкою вашого запиту.
Кожна помилка API запитів супроводжується кодом і повідомленням, які допоможуть визначити причину проблеми та виправити її.
Приклади використання API в Окі-Токі
API Окі-Токі — інструмент для вирішення багатьох завдань у кол-центрі. Ось кілька прикладів, де його використання допоможе заощадити час і спростити процеси:
- Додавання клієнтів в автообдзвоні для пост-обробки вхідних дзвінків/ холодної бази – після успішного з’єднання з оператором, дані автоматично передаються для подальшого обдзвону. Це економить час і знижує ризик помилок, виключаючи ручну обробку;
- Видалення завдань з автодзвону – завдання, які були оброблені і більше неактуальні, оскільки клієнти дали відмову, будуть видалятися зі списку обдзвону;
- Передача даних про дзвінки в CRM – всі необхідні дані про дзвінки, якіпотрібні для подальшої роботи з клієнтом будуть передані в CRM;
- Оновлення контакту в CRM – Наприклад, зміна статусу завдань або додавання нових параметрів для аналізу.
Як створити запит API?
Щоб створити запит для роботи з даними в Окі-Токі, спочатку ознайомтеся з документацією API. Тут зібрана інформація про те, які дані можна передавати або отримувати. Виберіть потрібний запит і подивіться, яка додаткова інформація може знадобиться, наприклад, ID Автодзвону. Щоб знайти ці дані, зайдіть в потрібний Автодозвін. ID буде вказаний у посиланні в адресному рядку браузера — це число після назви інструмента.
Приклад API запиту у Postman: додавання у ЧС
Посилання запиту сформуємо в програмі Postman, яку потрібно буде встановити на ваш пристрій.Знаходимо в Документації розділ “Lists”, вибираємо запит “Adding a value to a list” . Запит додає дані у ваші Списки. Це не обов’язково має бути “Чорний список” , можливо ви хочете доповнити “Список VIP клієнтів” або будь-який інший, що відповідає вашим бізнес-процесам.Процедуємо до формування API- посилання:
- дивимося в документації тип запиту – у нашому випадку це post і копіюємо URL-посилання https://home.oki-toki.net/api/v1/lists/add. Переходимо в Postman, встановлюємо тип і посилання;
- наступний крок – ваш токен. Як згенерувати токен ми описали вище в статті;
- в запиті потрібно вказати параметр “ID списку”. Для цього перейдіть в розділ Списки, знайдіть потрібний, скопіюйте номер з адресної стрічки й перенесіть його в Postman.
- Параметр “values” необхідно доповнити даними, які потраплять у список, наприклад, номером телефону;
Після внесення всіх параметрів, у нас формується посилання у такому вигляді: https://home.oki-toki.net/api/v1/lists/add?api_token=(ВАШ ТОКЕН)list_id=101&values=(НОМЕР ТЕЛЕФОНУ). Генеруємо запит, якщо все вірно отримуємо відповідь – 200 ОК. Тепер у чорному списку доданий потрібний номер.
Щоб налаштувати різні умови спрацьовування запитів, використовуйте події. Вони дозволяють передавати не тільки дані про дзвінки та клієнтів, але й інформацію про порушення, статуси користувачів і спрацьовування мовної аналітики. Це дозволяє моніторити ключові показники роботи операторів, їх активність, фіксувати відхилення від скриптів або дисциплінарні порушення для підтримання високого рівня якості обслуговування.
Як налаштувати API інтеграцію?
Якщо потрібно зв’язати Окі-Токі з зовнішнім ресурсом, то допоможе інтеграція API. Наприклад, передачу даних про клієнтів або додавання номера в автообдзвоні можна автоматизувати через API. Налаштування складаються з двох етапів:
Етап 1. Створення webhook
Для початку потрібно створити webhook у розділі Зовнішні ресурси:
- Вкажіть назву;
- В рядок URL перенесіть посилання, залежно від поставленого завдання. Наприклад, для додавання завдання в автообдзвоні, потрібно знайти в технічній документації API запит “Adding a task (number) to a call” скопіювати посилання та вставити її у рядок URL;
- Виберіть метод передачі даних зі списку: GET, POST, JSON;
- В рядок “Загальні параметри запитів” впишіть свій ключ доступу у форматі: api_token= ВАШ ТОКЕН.
У прикладі показано як створити webhook для автоматизації процесів всередині Окі-Токі. Якщо в рядку URL буде вказано посилання на сторонню систему, то Окі-Токі буде інтегруватися з нею. Як інтегрувати чат-бота з Telegram читайте у нас на блозі.
Етап 2. Створення події
Перейдіть у розділ Події та інтеграції і створіть нове прив’язування.
- Вкажіть назву та тип події (дії користувачів, дзвінки, порушення);
- Зовнішня інтеграція – виберіть зі списку або додайте новий зовнішній ресурс;
- Умови спрацьовування – задайте тригер для спрацьовування. Список умов залежить від типу події;
- Параметри дії – у цьому рядку необхідно внести дані для деталізації запиту. Доступні параметри, які можна використовувати в запиті вказані в документації;
- Змінні виведено списком. Клікнувши на потрібній, вона скопіюється для заповнення параметрів дії.
Звітність та витрати за API-запитами
Моніторити як виконуються запити можна за допомогою Журналу API викликів. Звіт формується за датою, користувачами, тривалістю виконання та типом запиту – виберіть API. Готовий звіт містить інформацію про дату, час, тривалість та ім’я користувача, який створив запит, а також URL і параметри запиту. Доступний експорт у форматах HTML, Google Sheets та Microsoft Excel.
У Журналі подій ви знайдете інформацію про те, які події були оброблені та з яким результатом. Звіт містить назву, тип події, інтеграцію, дату створення та обробки, поточний стан (успішно, невдало або в очікуванні), а також дані, задіяні при створенні події та інтеграцій за допомогою API.
Запити API – платна функція, дізнатися інформацію про вартість можна в розділі Управління послугами. Відстежувати свої щоденні списання зручно за Журналом балансу.
За цією інструкцією та з допомогою простої документації Окі-Токі, ви зможете налаштувати передачу даних та API запити. Інтеграції та вебхуки Окі-Токі вирішать більшість практичних завдань швидко, ефективно та без зайвих зусиль. Це оптимізує багато бізнес-процесів вашої компанії та дасть зосередитися на головному — якісній роботі з клієнтами.
