Документация для разработчиков

Oki-Toki предоставляет REST API для интеграции колл-центра с вашими системами: CRM, сайтами, ботами и внутренними сервисами. Базовый адрес — https://home.oki-toki.net/api/v1/, ответы в формате JSON.

Ключ API создаётся в личном кабинете (раздел «Интеграции»). Каждый запрос авторизуется этим ключом — подробности в разделе Authenticating requests.

Полная интерактивная документация со всеми методами, параметрами и готовыми примерами кода (PHP, curl, JavaScript, Python) живёт по адресу one.oki-toki.net/docs/api. Ниже — карта разделов: что умеет каждая группа методов и где смотреть детали.

Возможности API по разделам

Звонки (Calls)

Данные о конкретном звонке: добавление и получение произвольной информации по звонку, скачивание записи разговора по идентификатору сессии.

Методы группы Calls →

Контакты (Contacts)

Работа с CRM Оки-Токи: создание и обновление контактов, выгрузка карточек и связанных с ними данных — для синхронизации с внешними CRM.

Методы группы Contacts →

Автообзвоны (Dialers)

Управление автообзвонами: список дайлеров, добавление задач (номеров) в обзвон, отмена задач, контроль состояния. Основной инструмент интеграции лидогенерации с обзвоном.

Методы группы Dialers →

Интеграции (Integrations)

Служебные методы для связи с внешними системами и вебхуков — события Оки-Токи в ваши сервисы.

Методы группы Integrations →

Списки (Lists)

Чёрные и белые списки номеров: проверка наличия значения, добавление и удаление записей.

Методы группы Lists →

Проекты (Projects)

Данные анкет и проектов: структура полей, записи анкет — всё, что операторы заполняют в карточках.

Методы группы Projects →

Очереди (Queues)

Состояние очередей входящих звонков: статусы, загрузка, операторы на линии — для дашбордов и мониторинга в реальном времени.

Методы группы Queues →

Отчёты (Reports)

Журнал звонков с фильтрами по датам и номерам, сводные отчёты по звонкам, очередям и пользователям — сырьё для вашей аналитики и BI.

Методы группы Reports →

SMS

Отправка SMS и работа с SMS-рассылками через подключённых провайдеров.

Методы группы SMS →

Пользователи (Users)

Управление операторами: смена статуса пользователя (например, перевод в перерыв из внешней системы), данные по занятости.

Методы группы Users →

С чего начать

Создайте ключ API в кабинете, откройте интерактивную документацию и выполните первый запрос из готового примера. Если что-то не получается — напишите в нашу техподдержку через тикет в кабинете, поможем с интеграцией.

Создание аккаунта





    Соглашение на обработку персональных данных