[:en]API requests and API documentation in Oki-Toki[:ru]API-запросы и документация API в Оки-Токи[:ua]API-запити та документація API в Окі-Токі[:pl]Zapytania API i dokumentacja API w Oki-Toki[:es]Solicitudes de API y documentación de API en Oki-Toki[:tr]API istekleri ve Oki-Toki API dokümantasyonu[:]

[:en]

What are API requests?

API is a method through which one program can \”negotiate\” with another. You can ask Oki-Toki to transfer or receive the necessary data. For example, automatically send customer information to your CRM or load data back into Oki-Toki.

What is the benefit of API for a call center?

• Automation: API takes on routine tasks. For example, a new contact is sent to your CRM, automatically updating the data;
• Integration: with the help of API, it is easy to link Oki-Toki with other systems – CRM, analytics, chatbots, etc. All tools work together as a whole, which makes business processes simpler and faster.
• Real-time data: the system sends or receives information as soon as it appears. This is convenient for analysis, monitoring;
• Easy scaling: you can add new features and tools without complex changes. This is especially convenient if your project is growing;
• Reducing the number of errors: less manual work — lower risk of making mistakes. Everything happens automatically, quickly, and accurately.

Types of API requests in Oki-Toki

Oki-Toki uses the standard method of interaction with web services – REST API. The system receives information on request and provides a response in the desired format, most often JSON. The following request methods are available in Oki-Toki:

• GET – used to retrieve information, such as contacts from CRM or call statistics;
• POST – sends new data to the system, such as mass adding or removing dialer tasks, turning the dialer on/off.

To test a request, check the correctness of data, or find an error, Postman is suitable.

Documentation and API setup in Oki-Toki

Oki-Toki API documentation is your guide to working, describing request methods, usage examples, and data structure. For convenience, the API technical documentation is divided into sections based on Oki-Toki main functions and tools.

Access to API

Access to API is done using tokens – these are keys that let the system understand who is accessing it. With them, it\’s easy to work with the API and securely transfer data. In Oki-Toki, a user can create their token when they have the \”Manage users\” right in their Role. Such a right is available in default roles \”Admin\”  and \”Supervisor\” , but it can also be added to any role you create.

\”Managing external resources, integrations, and events (Webhook)\” is another right needed for working with API. Without it, creating an integration or adding a Webhook won’t be possible.

Learn more about roles in a separate article on the blog.

How to get an API key?

To create any API request, you need a token. To generate it, go to the Users list section. Select the \”Security\”  item in the profile settings. Here you can create, view, or delete a token.

API request error codes

Everyone can make mistakes – even professionals encounter difficulties in transferring data or performing tasks. The main thing is to know how to fix it. We have prepared a list of the most common errors when making an api request:

• 401 (Unauthorized) – the request specifies an nonexistent object or your token is incorrect;
• 403 (Forbidden) – it means that the server understood the request but refuses access. You may not have the rights and permissions to execute this request;
• 404 (Not Found) – in the URL-link there are errors, check the accuracy of the entered data;
• 405 Method Not Allowed – incorrect request type. For example, you tried to use the POST method instead of GET;
• 422 (Unprocessable Entity) – the request is accepted, but was not processed due to a semantic error in the \”body\” of the data;
• 429 Too Many Requests – exceeding the request limit;
• 500 (Internal Server Error)– problems with the server\’s operation or processing your request.

Each API error is accompanied by a code and a message that will help determine the cause of the problem and fix it.

Examples of using API in Oki-Toki

Oki-Toki API is a tool for solving many tasks in a call center. Here are some examples where its use can save time and simplify processes:

1. Adding customers to a dialer for post-processing of incoming calls/cold base – after a successful connection with an agent, the data is automatically transferred for further dialing. This saves time and reduces the risk of errors by eliminating manual processing;
2. Deleting tasks from a dialer – tasks that have been processed and are no longer relevant because customers have declined will be removed from the dialer list;
3. Transferring call data to CRM – all necessary call data needed for further work with the customer will be transferred to the CRM; 
4. Updating contact in CRM – For example, changing the status of tasks or adding new parameters for analysis.

How to create an API request?

To create a request for working with data in Oki-Toki, first familiarize yourself with the API documentation. Here is collected information about what data can be transferred or received. Choose the necessary request and see what additional information may be needed, for example, ID of the dialer. 

To find this data, go to the required dialer. The ID will be indicated in the link in the browser address bar — this is the number after the name of the tool.

Example of an API request in Postman: adding to the blacklist

We will formulate a request link in the Postman program, which will need to be installed on your device.

We find in the Documentation the section \”Lists\”, select the request \”Adding a value to a list\”. The request adds data to your Lists. It doesn’t necessarily have to be the \”Blacklist\”, maybe you want to supplement the \”VIP client list\” or any other that suits your business processes.

Let\’s proceed to formulating the API link:

• look in the documentation for the type of request – in our case, it\’s post and copy the URL-link https://home.oki-toki.net/api/v1/lists/add. Go to Postman, set the type and insert the link.

• the next step – your token. How to generate a token we described above in the article;
• in the request, it is necessary to specify the list ID parameter. To do this, go to the Lists section, find the required one, copy the number from the address bar and transfer it to Postman. 
• The \”values\” parameter needs to be supplemented with the data that will end up in the list, for example, a phone number; 

After entering all parameters, we form a link in this form: https://home.oki-toki.net/api/v1/lists/add?api_token=(YOUR TOKEN)list_id=101&values=(PHONE NUMBER)We generate a request, if everything is correct we receive a response – 200 OK. Now the required number is added to the blacklist.

To set up different conditions for requests to be triggered, use events. They allow not only transmitting data about calls and customers but also information about violations, user statuses and the triggering of speech analytics. This allows monitoring key performance indicators of agents, their activity, recording deviations from scripts or disciplinary violations to maintain a high level of service quality.

How to set up API integration?

If you need to connect Oki-Toki with an external resource, integration API can help. For example, transferring customer data or adding a number to dialer can be automated through the API. The settings consist of two stages:

Stage 1. Creating a webhook

First, you need to create a webhook in the External resources section:

• Specify the name;
• In the URL line, transfer the link, depending on the task at hand. For example, to add a task to dialer, you need to find the API request \”Adding a task (number) to a call\” in the technical documentation, copy the link and paste it into the URL line;
• Choose the data transfer method from the list: GET, POST, JSON;
• In the \”Common request parameters\” line, enter your access key in the format: api_token= YOUR TOKEN.

The example shows how to create a webhook for automating tasks within Oki-Toki. If the URL line specifies a link to an external system, then oki-toki will integrate with it. Read how to integrate a chatbot with Telegram on our blog.

Stage 2. Creating an event

Go to the Events and Integrations section and create a new binding.

• Indicate the name and type of event (user actions, calls, violations);
• External integration – select from the list or add a new external resource;
• Trigger conditions – set a trigger for the event to occur. The list of conditions depends on the type of event;

• Action parameters – this line must contain data to detail the request. Available parameters that can be used in the request are indicated in the documentation;
• Variables are listed. Clicking on the needed one will copy it for filling in action parameters. 

Reporting and costs for API requests

You can monitor how requests are executed using API call log. The report is generated by date, users, duration of execution, and type of request – select API. The ready report contains information about the date, time, duration, and the name of the user who created the request, as well as the URL and parameters of the request. Export is available in HTML, Google Sheets, and Microsoft Excel formats.

In the Event log you will find information about which events were processed and with what result. The report contains the name, type of event, integration, date of creation and processing, current state (successful, unsuccessful, or pending), as well as data involved in creating events and integrations using API.

API requests – a paid feature, you can find out information about the cost in the section Service Management. You can conveniently track your daily debits in the Balance Log.

Following this guide and using the documentation of Oki-Toki, you can setup data transfer and API requests. Integrations and webhooks from Oki-Toki will solve most practical tasks quickly, efficiently, and without extra effort. This will optimize many of your company\’s business processes and allow you to focus on the main thing — quality work with clients.[:ru]

Что такое 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 Оки-Токи — инструмент для решения множества задач в колл-центре. Вот несколько примеров, где его использование поможет сэкономить время и упростить процессы:

1. Добавление клиентов в автообзвон для пост-обработки входящих звонков/ холодной базы – после успешного соединения с оператором, данные автоматически передаются для дальнейшего прозвона. Это экономит время и снижает риск ошибок, исключая ручную обработку;
2. Удаление задач из автообзвона – задачи, которые были обработаны и больше неактуальны, так как клиенты  дали отказ, будут удаляться из списка обзвона;
3. Передача данных о звонках в CRM – все нужные данные о звонках, которые нужны для дальнейшей работы с клиентом будут переданы в CRM; 
4. Обновление контакта в 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 – платная функция, узнать информацию о стоимости можно в разделе Управление услугами. Прослеживать свои ежедневные списания удобно по Журналу баланса.  

По этой инструкции и с помощью документации Оки-Токи, вы сможете настроить передачу данных и АПИ запросы. Интеграции и вебхуки Оки-Токи решат большинство практических задач быстро, эффективно и без лишних усилий. Это оптимизирует многие бизнес-процессы вашей компании и даст сосредоточиться на главном — качественной работе с клиентами.[:ua]

Що таке 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 Окі-Токі — інструмент для вирішення багатьох завдань у кол-центрі. Ось кілька прикладів, де його використання допоможе заощадити час і спростити процеси:

1. Додавання клієнтів в автообдзвоні для пост-обробки вхідних дзвінків/ холодної бази – після успішного з\’єднання з оператором, дані автоматично передаються для подальшого обдзвону. Це економить час і знижує ризик помилок, виключаючи ручну обробку;
2. Видалення завдань з автодзвону – завдання, які були оброблені і більше неактуальні, оскільки клієнти дали відмову, будуть видалятися зі списку обдзвону;
3. Передача даних про дзвінки в CRM – всі необхідні дані про дзвінки, якіпотрібні для подальшої роботи з клієнтом будуть передані в CRM; 
4. Оновлення контакту в 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 запити. Інтеграції та вебхуки Окі-Токі вирішать більшість практичних завдань швидко, ефективно та без зайвих зусиль. Це оптимізує багато бізнес-процесів вашої компанії та дасть зосередитися на головному — якісній роботі з клієнтами.[:pl]

Co to są zapytania API?

API to metoda, za pomocą której jeden program może \”negocjować\” z innym. Możesz poprosić oki-toki o przesłanie lub odbiór potrzebnych danych. Na przykład, automatycznie wysyłać informacje o kliencie do twojego CRM lub wczytywać dane z powrotem do Oki-Toki.

Jakie korzyści niesie za sobą API dla call center?

• Automatyzacja procesów: API przejmuje zadania rutynowe. Na przykład nowy kontakt jest wysyłany do twojego CRM, automatycznie aktualizując dane;
• Integracja: dzięki API łatwo połączyć Oki-Toki z innymi systemami – CRM, analityką, chatbotami itp. Wszystkie narzędzia pracują razem jako całość, co upraszcza i przyspiesza procesy biznesowe.
• Dane w czasie rzeczywistym: system wysyła lub odbiera informacje, jak tylko się pojawią. To jest wygodne do analiz, monitoringu;
• Łatwa skalowalność: możesz dodawać nowe funkcje i narzędzia bez skomplikowanych zmian. To jest szczególnie wygodne, jeśli Twój projekt rośnie;
• Zmniejszenie liczby błędów: mniej pracy manualnej — mniejsze ryzyko popełnienia błędów. Wszystko dzieje się automatycznie, szybko i dokładnie.

Typy zapytań API w Oki-Toki

Oki-Toki używa standardowej metody interakcji z usługami sieciowymi – REST API. System odbiera informacje na żądanie i dostarcza odpowiedź w pożądanym formacie, najczęściej JSON. W Oki-Toki dostępne są następujące metody zapytań:

• GET – używane do pobierania informacji, takich jak kontakty z CRM czy statystyki połączeń;
• POST – wysyła nowe dane do systemu, na przykład masowe dodawanie lub usuwanie zadań автодозвона, włączanie/wyłączanie автодозвона.

Do testowania żądania, sprawdzenia poprawności danych lub znalezienia błędu, Postman jest odpowiedni.

Dokumentacja i konfiguracja API w Oki-Toki

Dokumentacja API oki-toki to Twój przewodnik po pracy, opisujący metody żądań, przykłady użycia i strukturę danych. Dla wygody, dokumentacja techniczna API jest podzielona na sekcje w oparciu o główne funkcje i narzędzia Oki-Toki.

Dostęp do API

Dostęp do API odbywa się za pomocą tokenów – to klucze, które pozwalają systemowi zrozumieć, kto do niego uzyskuje dostęp. Dzięki nim łatwo pracuje się z API i bezpiecznie przekazuje dane.

W Oki-Toki użytkownik może stworzyć swój token, gdy ma prawo \”Zarządzanie użytkownikami\” w swojej Roli. Takie prawo jest dostępne w domyślnych rolach \”Admin\” i \”Supervisor\” , ale może być również dodane do dowolnej roli, którą stworzysz. 

\”Zarządzanie zewnętrznymi zasobami, integracjami i zdarzeniami (Webhook)\” to kolejne prawo potrzebne do pracy z API. Bez niego tworzenie integracji lub dodanie Webhooka nie będzie możliwe.

Dowiedz się więcej o rolach w osobnym artykule na blogu.

Jak zdobyć klucz API?

Aby stworzyć jakiekolwiek żądanie API, potrzebujesz tokenu. Aby go wygenerować, przejdź do sekcji Lista użytkowników. Wybierz pozycję \”Bezpieczeństwo\” w ustawieniach profilu. Tutaj możesz stworzyć, zobaczyć lub usunąć token.

Kody błędów żądania API

Każdy może popełnić błąd – nawet profesjonaliści napotykają trudności w przekazywaniu danych lub wykonywaniu zadań. Najważniejsze, to wiedzieć, jak to naprawić. Przygotowaliśmy listę błędów API najczęstszych podczas wykonywania zapytań API:

• 401 (Unauthorized) – żądanie określa nieistniejący obiekt lub Twój token jest niepoprawny;
• 403 (Forbidden) – oznacza, że serwer zrozumiał żądanie, ale odmawia dostępu. Możesz nie mieć praw i uprawnień do wykonania tego żądania;
• 404 (Not Found) – w linku URL są błędy, sprawdź dokładność wprowadzonych danych;
• 405 Method Not Allowed – niepoprawny typ żądania. Na przykład, próbowałeś użyć metody POST zamiast GET;
• 422 (Unprocessable Entity) – żądanie zostało przyjęte, ale nie zostało przetworzone z powodu błędu semantycznego w \”ciele\” danych;
• 429 Too Many Requests – przekroczenie limitu żądań;
• 500 (Internal Server Error)– problemy z działaniem serwera lub przetwarzaniem twojego żądania.

Każdy błąd API jest zaopatrzony w kod i wiadomość, które pomogą określić przyczynę problemu i naprawić go.

Przykłady użycia API w Oki-Toki

API oki-toki to narzędzie do rozwiązywania wielu zadań w call center. Oto kilka przykładów, gdzie jego użycie może zaoszczędzić czas i uprościć procesy:

1. Dodawanie klientów do dialers do ponownej obróbki przychodzących połączeń/bazy zimnej – po udanym połączeniu z operatorem, dane są automatycznie przekazywane do dalszego обзвона. Oszczędza to czas i zmniejsza ryzyko błędów poprzez eliminację obróbki ręcznej;
2. Usuwanie zadań z dialers – zadania, które zostały przetworzone i nie są już aktualne, bo klienci zrezygnowali, zostaną usunięte z listy автодозвона;
3. Przekazywanie danych rozmowy do CRM – wszystkie niezbędne dane rozmowy potrzebne do dalszej pracy z klientem zostaną przekazane do CRM; 
4. Aktualizacja kontaktu w CRM – Na przykład, zmiana statusu zadań lub dodawanie nowych parametrów do analizy.

Jak stworzyć żądanie API?

Aby stworzyć żądanie do pracy z danymi w oki-toki, najpierw zapoznaj się z dokumentacją API. Tutaj zebrane są informacje o tym, jakie dane można przekazać lub odbierać. Wybierz potrzebne żądanie i zobacz, jakie dodatkowe informacje mogą być potrzebne, na przykład ID Dialer. 

Aby znaleźć te dane, przejdź do wymaganego автодозвона. ID będzie wskazane w linku w pasku adresu przeglądarki — to numer po nazwie narzędzia.

Przykład żądania API w Postman: dodanie do czarnej listy

Sformułujemy link żądania w programie Postman, który będzie musiał być zainstalowany na Twoim urządzeniu. Znajdujemy w Dokumentacji sekcję \”Listy\”, wybieramy żądanie \”Dodawanie wartości do listy\” . Żądanie dodaje dane do Twoich List. Nie musi to być koniecznie \”Czarna lista\”, może chcesz uzupełnić \”Listę klientów VIP\” lub jakąkolwiek inną, która pasuje do Twoich procesów biznesowych.Przejdźmy do formułowania linku API:

• szukaj w dokumentacji typu żądania – w naszym przypadku to post i kopiuj link URL https://home.oki-toki.net/api/v1/lists/add. Przejdź do Postmana, ustaw typ i wklej link.

• następny krok – Twój token. Jak wygenerować token opisaliśmy powyżej w artykule;
• w żądaniu niezbędne jest określenie parametru ID listy. Aby to zrobić, przejdź do sekcji Listy, znajdź wymaganą, skopiuj numer z paska adresu i przekaż go do Postmana. 
• Parametr “values” należy uzupełnić danymi, które trafią na listę, na przykład numerem telefonu; 

Po wprowadzeniu wszystkich parametrów formułujemy link w tej formie: https://home.oki-toki.net/api/v1/lists/add?api_token=(TWÓJ TOKEN)list_id=101&values=(NUMER TELEFONU)Generujemy żądanie, jeśli wszystko jest poprawne otrzymujemy odpowiedź – 200 OK. Teraz wymagany numer jest dodany do czarnej listy.

Aby ustawić różne warunki dla wyzwalania żądań, użyj zdarzeń. Umożliwiają one nie tylko przekazywanie danych o rozmowach i klientach, ale także informacje o naruszeniach, statusach użytkowników i wyzwalaniu analizy mowy. Pozwala to monitorować kluczowe wskaźniki wydajności operatorów, ich aktywność, rejestrowanie odchyleń od scenariuszy lub naruszeń dyscyplinarnych w celu utrzymania wysokiego poziomu jakości obsługi.

Jak skonfigurować integrację API?

Jeśli potrzebujesz połączyć oki-toki z zewnętrznym zasobem, integracja API może pomóc. Na przykład, transfer danych klienta lub dodanie numeru do автодозвона może być zautomatyzowany przez API. Ustawienia składają się z dwóch etapów:

Etap 1. Tworzenie webhooka

Na początku należy utworzyć webhook w sekcji Zewnętrzne zasoby:

• Podaj nazwę;
• W linii URL przekaż link, w zależności od zadania do wykonania. Na przykład, aby dodać zadanie do автодозвона, należy znaleźć w dokumentacji technicznej żądanie \”Dodawanie zadania (numeru) do rozmowy\”, skopiować link i wkleić go w linii URL;
• Wybierz metodę przekazywania danych z listy: GET, POST, JSON;
• W linii \”Wspólne parametry żądania\” wpisz swój klucz dostępu w formacie: api_token= TWÓJ TOKEN.

Przykład pokazuje, jak stworzyć webhook do automatyzacji zadań wewnątrz Oki-Toki. Jeśli w linii URL podano link do zewnętrznego systemu, wtedy oki-toki zintegruje się z nim. Czytaj jak zintegrować chatbota z Telegramem na naszym blogu.

Etap 2. Tworzenie zdarzenia

Przejdź do sekcji Zdarzenia i Integracje i stwórz nowe powiązanie.

• Wskaż nazwę i typ zdarzenia (akcje użytkowników, połączenia, naruszenia);
• Integracja zewnętrzna – wybierz z listy lub dodaj nowy zewnętrzny zasób;
• Warunki wyzwolenia – ustawiają trigger dla wystąpienia zdarzenia. Lista warunków zależy od typu zdarzenia;

• Parametry akcji – ta linia musi zawierać dane do szczegółowego opisu żądania. Dostępne parametry, które można wykorzystać w żądaniu, są wskazane w dokumentacji;
• Zmienne są wylistowane. Kliknięcie na potrzebną skopiuje ją do wypełnienia parametrów akcji. 

Raporty i koszty za zapytania API

Możesz monitorować, jak wykonywane są żądania, korzystając z dziennika wywołań API. Raport jest generowany według daty, użytkowników, czasu wykonania i typu żądania – wybierz API. Gotowy raport zawiera informacje o dacie, godzinie, czasie trwania i nazwie użytkownika, który utworzył żądanie, a także o URL i parametrach żądania. Dostępny jest eksport do formatów HTML, Google Sheets i Microsoft Excel.

W dzienniku zdarzeń znajdziesz informacje o tym, które zdarzenia zostały przetworzone i z jakim wynikiem. Raport zawiera nazwę, typ zdarzenia, integrację, datę utworzenia i przetwarzania, bieżący stan (udany, nieudany lub oczekujący), a także dane używane do tworzenia zdarzeń i integracji przy użyciu API.

Żądania API – funkcja płatna, informacje o kosztach można znaleźć w sekcji Zarządzanie usługami. Możesz wygodnie śledzić swoje codzienne obciążenia w Dzienniku Salda.

Postępując zgodnie z tym przewodnikiem i korzystając z dokumentacji Oki-Toki, możesz skonfigurować przekazywanie danych i żądania API. Integracje i webhooks z Oki-Toki rozwiązują większość praktycznych zadań szybko, skutecznie i bez zbędnego wysiłku. To optymalizuje wiele procesów biznesowych Twojej firmy i pozwala skoncentrować się na głównej rzeczy — jakościowej pracy z klientami.[:es]

¿Qué son las solicitudes API?

API es un método a través del cual un programa puede \”negociar\” con otro. Puedes pedirle a Oki-Toki que transfiera o reciba los datos necesarios. Por ejemplo, enviar automáticamente la información del cliente a tu CRM o cargar datos de vuelta en Oki-Toki.

¿Cuál es el beneficio de la API para centros de contacto?

• Automatización: La API asume tareas rutinarias. Por ejemplo, un nuevo contacto se envía a tu CRM, actualizando automáticamente los datos;
• Datos integración: con la ayuda de la API, es fácil vincular Oki-Toki con otros sistemas – CRM, análisis, chatbots, etc. Todas las herramientas trabajan juntas como un todo, lo que hace que los procesos comerciales sean más simples y rápidos.
• Datos en tiempo real: el sistema envía o recibe información tan pronto como aparece. Esto es conveniente para análisis, monitoreo;
• Escalabilidad fácil: puedes agregar nuevas funciones y herramientas sin cambios complejos. Esto es especialmente conveniente si tu proyecto está creciendo;
• Reducción del número de errores: menos trabajo manual — menor riesgo de cometer errores. Todo sucede automáticamente, rápidamente y con precisión.

Tipos de solicitudes API en Oki-Toki

Oki-Toki utiliza el método estándar de interacción con servicios web – API REST. El sistema recibe información a pedido y proporciona una respuesta en el formato deseado, más a menudo JSON. En Oki-Toki están disponibles los siguientes métodos API REST:

• GET – se usa para recuperar información, como los contactos del CRM o estadísticas de llamadas;
• POST – envía nuevos datos al sistema, como la adición masiva o eliminación de tareas del marcador, encendiendo/apagando el marcador.

Para probar una solicitud, verificar la corrección de los datos o encontrar un error, Postman es adecuado.

Documentación y configuración de API en Oki-Toki

Documentación de API de oki-toki es tu guía para trabajar, describiendo métodos de solicitud, ejemplos de uso y estructura de datos. Para comodidad, la documentación técnica de API está dividida en secciones basadas en las principales funciones y herramientas de Oki-Toki.

Acceso a API

El acceso a API se realiza utilizando tokens – estas son llaves que permiten al sistema entender quién está accediendo a él. Con ellos, es fácil trabajar con la API y transferir datos de forma segura.

En Oki-Toki, un usuario puede crear su token cuando tiene el derecho de \”Gestionar usuarios\” en su Rol. Tal derecho está disponible en roles predeterminados \”Admin\” y \”Supervisor\” , pero también puede agregarse a cualquier rol que crees.

\”Gestionar recursos externos, integraciones y eventos (Webhook)\” es otro derecho necesario para trabajar con API. Sin él, crear una integración o agregar un Webhook no será posible.Aprende más sobre roles en un artículo separado en el blog.

¿Cómo obtener una clave API?

Para crear cualquier solicitud API, necesitas un token. Para generararlo, ve a la sección Lista de usuarios. Selecciona el elemento \”Seguridad\” en la configuración del perfil. Aquí puedes crear, ver o eliminar un token.

Códigos de error de solicitud API

Todos pueden cometer errores, incluso los profesionales encuentran dificultades en la transferencia de datos o la ejecución de tareas. Lo importante es saber cómo solucionarlo. Hemos preparado una lista de los errores más comunes al hacer una solicitud api:

• 401 (No Autorizado) – la solicitud especifica un objeto inexistente o tu token es incorrecto;
• 403 (Prohibido) – significa que el servidor entendió la solicitud pero se niega al acceso. Puede que no tengas los derechos y permisos para ejecutar esta solicitud;
• 404 (No Encontrado) – en el enlace URL hay errores, verifica la precisión de los datos ingresados;
• 405 Método No Permitido – tipo de solicitud incorrecto. Por ejemplo, intentaste usar el método POST en lugar de GET;
• 422 (Entidad No Procesable) – la solicitud es aceptada, pero no se procesó debido a un error semántico en el \”cuerpo\” de los datos;
• 429 Demasiadas Solicitudes – excediendo el límite de solicitudes;
• 500 (Error Interno del Servidor)– problemas con el funcionamiento del servidor o el procesamiento de tu solicitud.

Cada error de API viene acompañado por un código y un mensaje que ayudará a determinar la causa del problema y corregirlo.

Ejemplos de uso de API en Oki-Toki

La API de oki-toki es una herramienta para resolver muchas tareas en un call center. Aquí hay algunos ejemplos donde su uso puede ahorrar tiempo y simplificar procesos:

1. Agregar clientes a un marcador para el post-procesamiento de llamadas entrantes/base fría – después de una conexión exitosa con un agente, los datos se transfieren automáticamente para su marcación posterior. Esto ahorra tiempo y reduce el riesgo de errores eliminando el procesamiento manual;
2. Eliminar tareas de un marcador – tareas que han sido procesadas y ya no son relevantes porque los clientes han declinado serán eliminadas de la lista de marcadores;
3. Transferir datos de llamada al CRM – todos los datos necesarios de la llamada necesarios para el trabajo posterior con el cliente se transferirán al CRM; 
4. Actualizar contacto en CRM – Por ejemplo, cambiando el estado de las tareas o agregando nuevos parámetros para análisis.

¿Cómo crear una solicitud API?

Para crear una solicitud para trabajar con datos en Oki-Toki, primero familiarízate con la documentación de API. Aquí se recopila información sobre qué datos pueden transferirse o recibirse. Elige la solicitud necesaria y ve qué información adicional puede ser necesaria, por ejemplo, ID del marcador. 

Para encontrar estos datos, ve al marcador requerido. El ID se indicará en el enlace en la barra de direcciones del navegador — este es el número después del nombre de la herramienta.

Ejemplo de una solicitud API en Postman: añadiendo a la lista negra

Formularemos un enlace de solicitud en el programa Postman, que deberá estar instalado en tu dispositivo. Encontramos en la Documentación la sección \”Listas\”, seleccionamos la solicitud \” Añadiendo un valor a una lista\” .

La solicitud agrega datos a tus Listas. No necesariamente tiene que ser la \”Lista Negra\”, tal vez quieras complementar la \”lista de clientes VIP\” o cualquier otra que se adapte a tus procesos comerciales.

Procedemos a formular el enlace API:

• busca en la documentación el tipo de solicitud – en nuestro caso, es post y copia el enlace URL https://home.oki-toki.net/api/v1/lists/add. Ve a Postman, establece el tipo e inserta el enlace.

• el siguiente paso – tu token. Cómo generar un token lo describimos arriba en el artículo;
• en la solicitud, es necesario especificar el parámetro ID de la lista. Para hacerlo, ve a la sección Listas, encuentra la requerida, copia el número de la barra de direcciones y transfiérelo a Postman. 
• El parámetro “valores” necesita ser complementado con los datos que terminarán en la lista, por ejemplo, un número de teléfono; 

Después de ingresar todos los parámetros, formulamos un enlace en esta forma: https://home.oki-toki.net/api/v1/lists/add?api_token=(TU TOKEN)list_id=101&values=(NÚMERO DE TELÉFONO)Generamos una solicitud, si todo está correcto recibimos una respuesta – 200 OK. Ahora el número requerido se añade a la lista negra.

Para configurar diferentes condiciones para que se activen las solicitudes, utiliza eventos. Estos permiten no solo transmitir datos sobre llamadas y clientes, sino también información sobre infracciones, estados de usuario y el desencadenamiento de análisis de voz. Esto permite monitorear indicadores clave de desempeño de agentes, su actividad, registrar desviaciones de scripts o infracciones disciplinarias para mantener un alto nivel de calidad de servicio.

¿Cómo configurar la integración API?

Si necesitas conectar oki-toki con un recurso externo, la integración API puede ayudar. Por ejemplo, transferir datos del cliente o añadir un número al marcador se puede automatizar a través de la API. La configuración consta de dos etapas:

Etapa 1. Creación de un webhook

Primero, necesitas crear un webhook en la sección Recursos externos:

• Especificar el nombre;
• En la línea de URL, transferir el enlace, dependiendo de la tarea en cuestión. Por ejemplo, para añadir una tarea al marcador, necesitas encontrar la solicitud de API \”Añadir una tarea (número) a una llamada\”  en la documentación técnica, copiar el enlace y pegarlo en la línea de URL;
• Elige el método de transferencia de datos de la lista: GET, POST, JSON;
• En la línea \”Parámetros comunes de solicitud\”, introduce tu clave de acceso en el formato: api_token=TU TOKEN.

El ejemplo muestra cómo crear un webhook para automatizar tareas dentro de Oki-Toki. Si la línea URL especifica un enlace a un sistema externo, entonces Oki-Toki se integrará con él. Lee cómo integrar un chatbot con Telegram en nuestro blog.

Etapa 2. Creación de un evento

Ve a la sección Eventos e Integraciones y crea una nueva vinculación.

• Indica el nombre y tipo de evento (acciones del usuario, llamadas, infracciones);
• Integración externa – selecciona de la lista o añade un nuevo recurso externo;
• Condiciones del disparador – establece un disparador para que ocurra el evento. La lista de condiciones depende del tipo de evento;

• Parámetros de acción – esta línea debe contener datos para detallar la solicitud. Los parámetros disponibles que pueden usarse en la solicitud se indican en la documentación;
• Variables se enumeran. Al hacer clic en la necesaria se copiará para llenar en parámetros de acción. 

Reportes y costos por solicitudes API

Puedes monitorear cómo se ejecutan las solicitudes usando registro de llamadas API. El informe se genera por fecha, usuarios, duración de ejecución y tipo de solicitud – selecciona API. El informe listo contiene información sobre la fecha, hora, duración y el nombre del usuario que creó la solicitud, así como la URL y los parámetros de la solicitud. La exportación está disponible en formatos HTML, Google Sheets y Microsoft Excel.

En el registro de eventos encontrarás información sobre cuáles eventos fueron procesados y con qué resultado. El informe contiene el nombre, tipo de evento, integración, fecha de creación y procesamiento, estado actual (exitoso, no exitoso o pendiente), así como datos involucrados en la creación de eventos e integraciones usando API.

Las solicitudes API son una característica de pago, puedes encontrar información sobre el costo en la sección Gestión de Servicios. Puedes rastrear convenientemente tus débitos diarios en el Registro de Saldo.

Siguiendo esta guía y utilizando la documentación de Oki-Toki, puedes configurar la transferencia de datos y solicitudes API. Las integraciones y webhooks de Oki-Toki resolverán la mayoría de las tareas prácticas de manera rápida, eficiente y sin esfuerzo extra. Esto optimizará muchos de los procesos comerciales de tu empresa y te permitirá enfocarte en lo principal: el trabajo de calidad con los clientes.[:tr]

API istekleri nedir?

API, bir programın başka bir programla \”pazarlık\” yapmasının bir yöntemidir. Oki-toki\’ye gerekli verileri aktarmasını veya almasını isteyebilirsiniz. Örneğin, müşteri bilgilerini otomatik olarak CRM\’inize göndermek veya verileri tekrar Oki-Toki\’ye yüklemek gibi.

Bir çağrı merkezi için API\’nin faydası nedir?

• Süreç otomasyonu: API, rutin görevleri üstlenir. Örneğin, yeni bir iletişim CRM\’inize gönderilir, veriler otomatik olarak güncellenir;
• Api dış hizmet entegrasyonu : API yardımıyla, Oki-Toki\’yi diğer sistemlerle – CRM, analitik, chatbotlar vb. ile kolayca bağlayabilirsiniz. Tüm araçlar bir bütün olarak çalışır, bu da iş süreçlerini daha basit ve daha hızlı hale getirir.
• Gercek zamanlı veri: sistem, bilgi geldiği gibi gönderir veya alır. Bu, analiz ve izleme için uygundur;
• Kolay ölçeklendirme: karmaşık değişiklikler olmadan yeni özellikler ve araçlar ekleyebilirsiniz. Bu, özellikle projeniz büyüyorsa rahattır;
• Hataların azaltılması: manuel iş daha az — hata yapma riski daha düşük. Her şey otomatik, hızlı ve doğru bir şekilde gerçekleşir.

Oki-Toki\’deki API istek türleri

Oki-Toki, web hizmetleriyle etkileşimde standart metod olan REST API\’yi kullanır. Sistem, istek üzerine bilgi alır ve genellikle JSON olmak üzere istenilen biçimde bir yanıt sağlar. Oki-Toki\’de aşağıdaki istek metotları mevcuttur:

• GET – bilgi almak için kullanılır, örneğin CRM\’den kişiler veya çağrı istatistikleri;
• POST – sistemde yeni veriler gönderir, örneğin toplu dialer görevleri ekleme veya kaldırma, dialeri açma/kapama.

Bir isteği test etmek, veri doğruluğunu kontrol etmek veya bir hatayı bulmak için, Postman uygundur.

Dokümantasyon ve API ayarları Oki-Toki 

Oki-Toki API dokümantasyonu çalışmayla ilgili rehberinizdir, istek metotları, kullanım örnekleri ve veri yapısını açıklar. Kolaylık olması açısından, teknik dokümantasyon Oki-Toki\’nin ana fonksiyonları ve araçlarına dayanarak bölümlere ayrılmıştır.

API\’ye Erişim

API\’ye erişim, tokenlar kullanılarak yapılır – bunlar, sistemin kimin erişim sağladığını anlamasını sağlayan anahtarlardır. Bunlarla, API ile kolayca çalışabilir ve verileri güvenli bir şekilde aktarabilirsiniz. Oki-Toki\’de, bir kullanıcı, Rolünde \”Kullanıcıları yönet\” hakkına sahip olduğunda kendi tokenını oluşturabilir. Bu hak varsayılan rollerde \”Admin\” ve \”Supervisor\” da mevcuttur, ancak istediğiniz herhangi bir role de ekleyebilirsiniz. 

\”Harici kaynakları, entegrasyonları ve olayları (Webhook) yönetme\” başka bir hak daha olup API ile çalışmak için gereklidir. Bunu olmadan, bir entegrasyon dokümanı veya Webhook eklemek mümkün olmayacaktır.

Rolleri yönetme hakkında daha fazla bilgi edinin blogumuzdaki ayrı bir makalede.

API anahtarı nasıl alınır?

Herhangi bir API isteği oluşturmak için bir tokena ihtiyacınız vardır. Bunu oluşturmak için, Kullanıcılar listesi bölümüne gidin. Profil ayarlarında \”Güvenlik\” öğesini seçin. Burada bir token oluşturabilir, görüntüleyebilir veya silebilirsiniz.

API istek hata kodları

Herkes hata yapabilir – hatta profesyoneller bile veri aktarımında veya görevlerin gerçekleştirilmesinde zorluklarla karşılaşabilir. Önemli olan bunu nasıl düzelteceğinizi bilmektir. API isteği yaparken en yaygın hataların bir listesini hazırladık:

• 401 (Yetkisiz) – istek, mevcut olmayan bir nesneyi belirtiyor veya tokenınız yanlış;
• 403 (Yasak) – bu, sunucunun isteği anladığı ancak erişimi reddettiği anlamına gelir. Bu isteği gerçekleştirmek için gerekli hak ve izinlere sahip olmayabilirsiniz;
• 404 (Bulunamadı) – URL bağlantısında hatalar var, girilen verilerin doğruluğunu kontrol edin;
• 405 Method Not Allowed – yanlış istek türü. Örneğin, GET yerine POST metodu kullanmaya çalıştınız;
• 422 (İşlenemeyen Varlık) – istek kabul edildi, ancak verinin \”gövdesinde\” semantik bir hata nedeniyle işlenmedi;
• 429 Çok Fazla İstek – istek limitinin aşılması;
• 500 (Sunucu İç Hatası)– sunucunun işleyişi ya da isteğinizin işlenmesinde sorunlar.

Her API hatası, sorunun nedenini belirlemenize ve düzeltmenize yardımcı olacak bir kod ve mesajla birlikte gelir.

Oki-Toki\’de API kullanım örnekleri

Oki-Toki API, bir çağrı merkezinde birçok görevi çözmek için bir araçtır. İşte kullanımının zaman kazandırabileceği ve süreçleri basitleştirebileceği bazı örnekler:

1. Bir dialere müşteri ekleme gelen çağrılar/soğuk veri tabanını sonrasında işleme için – başarılı bir bağlantı sağlandıktan sonra, veriler daha sonraki aramalar için otomatik olarak aktarılır. Bu, zaman kazandırır ve manuel işleme dair hata riskini azaltır;
2. Bir dialerden görevleri silme – işlenmiş ve müşterilerin reddetmesi nedeniyle artık ilgili olmayan görevler dialer listesinden kaldırılacaktır;
3. CRM\’ye çağrı verilerini aktarma – müşteriyle daha fazla çalışmak için gerekli olan tüm çağrı verileri CRM\’e aktarılacak; 
4. CRM\’de iletişim güncelleme – Örneğin, görevlerin durumunu değiştirme veya analiz için yeni parametreler ekleme.

Bir API isteği nasıl oluşturulur?

Oki-toki\’de veri ile çalışmak için bir istek oluşturmak için öncelikle API dokümantasyonuyla tanışın. Burada hangi verilerin aktarılabilir veya alınabilir olduğu hakkında bilgiler toplanmıştır. Gerekli isteği seçin ve ek bilgilerin ne olabileceğini görün, örneğin dialerin ID\’si. Bu veriyi bulmak için gerekli dialere gidin.

ID, tarayıcının adres çubuğundaki araç adından sonra gelen numaradır — bu, aracın numarasıdır.

Postman\’de bir API isteği örneği: kara listeye ekleme

Postman programında bir istek bağlantısı formüle edeceğiz, bu program cihazınıza kurulmalıdır. Dokümantasyonda \”Listeler\” bölümüne bakın, \”Bir listeye değer ekleme\” isteğini seçin. İstek, verileri Listelerinize ekler. Mutlaka \”Kara Listeye\” olmak zorunda değildir, belki \”VIP müşteri listesi\” veya iş süreçlerinize uygun başka bir listeyi tamamlamak istersiniz.

API bağlantısını formüle etme işlemine geçelim:

• dokümantasyonda istek türünü arayın – bizim durumumuzda bu post ve URL bağlantısını kopyalayın https://home.oki-toki.net/api/v1/lists/add. Postman\’a gidin, türü belirleyin ve bağlantıyı yapıştırın.

• bir sonraki adım – tokeniniz. Token nasıl oluşturulacağını yukarıdaki makalede anlattık;
• isteğe, list ID parametresini belirtmek gerekiyor. Bunu yapmak için, Listeler bölümüne gidin, gerekli olanı bulun, adres çubuğundan numarayı kopyalayın ve Postman\’a aktarın. 
• “values” parametresiyle, listeye eklenecek verileri, örneğin bir telefon numarasını, tamamlamanız gerekiyor; 

Tüm parametreleri girdikten sonra, bu formda bir bağlantı oluşturuyoruz: https://home.oki-toki.net/api/v1/lists/add?api_token=(SİZİN TOKENINIZ)list_id=101&values=(TELEFON NUMARASI)İsteği oluşturuyoruz, eğer her şey doğruysa 200 OK yanıtını alıyoruz. Şimdi gerekli numara kara listeye eklenmiştir.

İsteklerin tetiklenmesi için farklı koşullar ayarlamak amacıyla olayları kullanın. Bu, sadece çağrılar ve müşteriler hakkında veri aktarımına izin vermekle kalmaz, aynı zamanda ihlaller, kullanıcı durumları ve konuşma analitiğinin tetiklenmesi hakkında bilgiler sağlar. Bu, aracıların ana performans göstergelerini, aktivitelerini, scriptlerden sapmaları veya disiplin ihlallerini kaydetmeyi ve böylece hizmet kalitesinin yüksek düzeylerde tutulmasını sağlar.

API entegrasyonu nasıl kurulur?

Bir dış kaynakla Oki-Toki\’yi bağlamanız gerekiyorsa, entegrasyon API yardımcı olabilir. Örneğin, müşteri verilerini aktarmak veya bir numarayı dialere eklemek, API aracılığıyla otomatik hale getirilebilir. Ayarlar iki aşamadan oluşmaktadır:

Aşama 1. Bir webhook oluşturma

Öncelikle, webhook\’u Dış kaynaklar bölümünde oluşturmanız gerekir:

• İsmini belirtin;
• URL satırında, elinizdeki göreve bağlı olarak bağlantıyı aktarın. Örneğin, bir görevi dialere eklemek için, teknik dokümantasyonda \”Bir arama (numara) için görev ekleme\”  API isteğini bulun, bağlantıyı kopyalayın ve URL satırına yapıştırın;
• Veri aktarımı yöntemini listeden seçin: GET, POST, JSON;
• “Genel istek parametreleri” satırına, api_token= SİZİN TOKENINIZ formatında erişim anahtarınızı girin.

Örnek, Oki-Toki içindeki görevleri otomatikleştirmek için bir webhook oluşturma işlemini gösterir. URL satırında bir dış sisteme bağlantı belirtilirse, o zaman oki-toki onunla entegre olacaktır. Blogumuzda Telegram ile chatbot entegrasyonunu nasıl yapacağınızı okuyun.

Aşama 2. Bir olay oluşturma

Olaylar ve Entegrasyonlar bölümüne gidin ve yeni bir bağlama oluşturun.

• İsim ve olay türünü (kullanıcı eylemleri, çağrılar, ihlaller) belirtin;
• Dış entegrasyon – listeden seçin veya yeni bir dış kaynak ekleyin;
• Tetikleyici koşullar – olayın gerçekleşmesi için bir tetikleyici ayarlayın. Koşullar listesi, olayın türüne bağlıdır;

• Eylem parametreleri – bu satırda, isteği detaylandıracak veriler yer almalıdır. İstekte kullanılabilecek mevcut parametreler, dokümantasyonda belirtilmiştir;
• Değişkenler listelenir. Gereken birine tıklayarak, eylem parametrelerini doldurmak için kopyalanması sağlanır. 

API istekleri için raporlama ve maliyetler

İsteklerin nasıl gerçekleştirildiğini kullanarak API çağrı günlüğü izleyebilirsiniz. Rapor, tarih, kullanıcılar, uygulama süresi ve istek türüne göre oluşturulur – API\’yi seçin. Hazır rapor, isteği oluşturan kullanıcının adı, tarih, saat, süre, URL ve istek parametreleri hakkında bilgiler içerir. Veriler HTML, Google Sheets ve Microsoft Excel formatlarında dışa aktarılabilir.

Hangi olayların işlendiği ve ne sonuçla olduğu bilgisine Olay günlüğünde ulaşabilirsiniz. Rapor, adı, olay türü, entegrasyon, oluşturma ve işlenme tarihi, mevcut durumu (başarılı, başarısız veya bekleyen) ve API kullanılarak olaylar ve entegrasyonların oluşturulması sırasında dahil edilen verileri içerir.

API istekleri – ücretli bir özellik, maliyet hakkında bilgiyi Hizmet Yönetimi bölümünde bulabilirsiniz. Günlük borçlandırmalarınızı Bakiye Günlüğünde rahatça takip edebilirsiniz.

Bu rehberi takip ederek ve Oki-Toki\’nin dokümantasyonunu kullanarak, veri aktarımı ve API istekleri ayarlayabilirsiniz. Oki-Toki\’den entegrasyonlar ve webhooks, çoğu pratik görevi hızlı, etkili ve ekstra çaba harcamadan çözecektir. Bu, şirketinizin birçok iş sürecini optimize edecek ve sizin ana konu üzerinde — müşterilerle kaliteli çalışmak üzerinde odaklanmanızı sağlayacaktır.[:]