Что такое 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 Оки-Токи — инструмент для решения множества задач в колл-центре. Вот несколько примеров, где его использование поможет сэкономить время и упростить процессы:
- Добавление клиентов в автообзвон для пост-обработки входящих звонков/ холодной базы — после успешного соединения с оператором, данные автоматически передаются для дальнейшего прозвона. Это экономит время и снижает риск ошибок, исключая ручную обработку;
- Удаление задач из автообзвона — задачи, которые были обработаны и больше неактуальны, так как клиенты дали отказ, будут удаляться из списка обзвона;
- Передача данных о звонках в 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.
В Журнале событий вы найдете информацию о том, какие события были обработаны и с каким результатом. Отчет содержит название, тип события, интеграцию, дату создания и обработки, текущее состояние (успешно, неудачно или в ожидании), а также данные, задействованные при создании события и интеграций c помощью API.
Запросы API — платная функция, узнать информацию о стоимости можно в разделе Управление услугами. Прослеживать свои ежедневные списания удобно по Журналу баланса.
По этой инструкции и с помощью документации Оки-Токи, вы сможете настроить передачу данных и АПИ запросы. Интеграции и вебхуки Оки-Токи решат большинство практических задач быстро, эффективно и без лишних усилий. Это оптимизирует многие бизнес-процессы вашей компании и даст сосредоточиться на главном — качественной работе с клиентами.
