Skip to content

Основные API методы

Публичные методы, не требующие авторизации

Системные настройки

https://demo.iqtek.ru/dialer/api/v1/docs#/system%3A%20settings

  • GET/system/settings - посмотреть настройку
  • PUT/system/settings - изменить настройку
  • POST/settings/search - поиск по настройкам

Лицензии

https://demo.iqtek.ru/dialer/api/v1/docs#/system%3A%20licenses

  • GET/system/licenses - посмотреть лицензию
  • POST/system/licenses - создать лицензию

История создания/обновления сущности

https://demo.iqtek.ru/dialer/api/v1/docs#/entity_history

  • GET/entity_history - посмотреть историю
  • POST/entity_history/search - поиск
  • POST/entity_history/search/full - полная информация о создании и обновлении сущности

Описание полей метода GET/entity_history:

  • "entity_name" - имя сущности
  • "entity_type" - тип сущности
  • "event_type" - событие над этой сущностью
  • "entity_id" - идентификатор сущности
  • "data" - набор данных
  • "id"
  • "user_id" - идентификатор пользователя, который сделал действие
  • "user_login" - логин пользователя, совершившего действие
  • "created_at" - когда было совершено действие над сущностью

Провайдеры уведомлений

https://demo.iqtek.ru/dialer/api/v1/docs#/notification_providers

  • POST/notification_providers - создать провайдер уведомлений
  • GET/notification_providers - посмотреть провайдер уведомлений
  • PUT/notification_providers - обновить
  • DELETE/notification_providers - удалить
  • POST//notification_providers/check - проверить настройки
  • POST/notification_providers/search - найти в общем списке

Сервера телефонии

https://demo.iqtek.ru/dialer/api/v1/docs#/telephony_server_providers

  • POST/telephony_server_providers/check - проверить настройки
  • GET/telephony_server_providers - посмотреть сервер телефонии
  • POST/telephony_server_providers - создать сервер телефонии
  • PUT/telephony_server_providers - изменить сервер телефонии
  • DELETE/telephony_server_providers - удалить сервер телефонии
  • POST/telephony_server_providers/search - найти сервер телефонии
  • POST/telephony_server_providers/context/check - проверить, что вводимый контекст есть на телефонии
  • GET/telephony_server_providers/context - проверить, какие контексты есть на телефонии
  • POST/telephony_server_providers/queues/check - проверить, что вводимая очередь есть на телефонии
  • GET/telephony_server_providers/queues - проверить, какие есть очереди на телефонии
  • POST/telephony_server_providers/agents/check
  • POST/telephony_server_providers/agents/queue/add - добавить оператора в очередь
  • POST/telephony_server_providers/agents/queue/remove - убрать оператора из очереди

Методы, которые используются для АРМа оператора:

  • POST/telephony_server_providers/agents/login - залогинить оператора на конкретном сервере телефонии
  • POST/telephony_server_providers/agents/logout - разлогинить оператора
  • POST/telephony_server_providers/agents/paused - поставить оператора на паузу
  • POST/telephony_server_providers/agents/unpaused - снять с паузы

Провайдеры хранения лидов

https://demo.iqtek.ru/dialer/api/v1/docs#/lead_storage_providers

  • POST/lead_storage_providers/check - проверить настройки
  • GET/lead_storage_providers - посмотреть провайдер уведомлений
  • POST/lead_storage_providers - создать провайдер хранения лидов
  • PUT/lead_storage_providers - изменить провайдер хранения лидов
  • DELETE/lead_storage_providers - удалить провайдер хранения лидов
  • POST/lead_storage_providers/search - найти провайдер хранения лидов

Календари

https://demo.iqtek.ru/dialer/api/v1/docs#/calendars

  • POST/calendars - создать календарь
  • PUT/calendars - изменить календарь
  • DELETE/calendars - удалить календарь
  • GET/calendars - посмотреть календарь
  • POST/calendars/search - найти календарь

Маршруты

https://demo.iqtek.ru/dialer/api/v1/docs#/routes

  • GET/routes - посмотреть маршрут
  • POST/routes - создать маршрут
  • PUT/routes - изменить маршрут
  • DELETE/routes - удалить маршрут
  • POST/routes/search - найти маршрут
  • POST/routes/check - проверить настройки

Кампании

https://demo.iqtek.ru/dialer/api/v1/docs#/campaigns

  • POST/campaigns/routes - привязать маршрут к кампании
  • PUT/campaigns/routes - изменить маршрут, привязанный к кампании
  • DELETE/campaigns/routes - удалить маршрут из кампании
  • POST/campaigns - создать кампанию
  • PUT/campaigns - изменить кампанию
  • DELETE/campaigns - удалить кампанию
  • GET/campaigns - посмотреть кампанию
  • POST/campaigns/search - поиск кампаний
  • POST/campaigns/search/full - показать все привязанные к кампании сущности
  • DELETE/campaigns/bulk - массовое удаление кампаний
  • PATCH/campaigns/bulk - массовое изменение определенных полей кампании
  • GET/campaigns/batch_repository - посмотреть, какие лиды сейчас находятся в батчинге
  • GET/campaigns/call_repository - посмотреть, какие звонки сейчас находятся в системе
  • POST/campaigns/queues - привязать очередь к кампании
  • PUT/campaigns/queues - изменить очередь, привязанную к кампании
  • DELETE/campaigns/queues - отвязать очередь от кампании
  • POST/campaigns/agent_pauses/search - поиск кодов пауз, прикрепленных к кампании

Бакеты

https://demo.iqtek.ru/dialer/api/v1/docs#/buckets

  • GET/buckets - посмотреть бакет
  • POST/buckets - создать бакет
  • PUT/buckets- изменить бакет
  • DELETE/buckets- удалить бакет
  • POST/buckets/search- поиск бакета
  • DELETE/buckets/bulk - массовое удаление бакетов
  • PATCH/buckets/bulk - массовое изменение активности бакетов

Очереди

https://demo.iqtek.ru/dialer/api/v1/docs#/queues

  • GET/queues - посмотреть очередь
  • POST/queues - создать очередь
  • PUT/queues - изменить очередь
  • DELETE/queues - удалить очередь
  • POST/queues/search - поиск очередей
  • POST/queues/campaigns - привязать кампанию к очереди
  • PUT/queues/campaigns - изменить все кампании, привязанные к очереди
  • DELETE/queues/campaigns - удалить кампании из очереди
  • POST/queues/agents - привязать агента к очереди
  • PUT/queues/agents - изменить всех агентов, привязанных к очереди
  • DELETE/queues/agents - удалить агентов из очереди

Лиды

https://demo.iqtek.ru/dialer/api/v1/docs#/leads

  • POST/leads/search - поиск по лидам
  • GET/leads - посмотреть лида
  • POST/leads - создать лида
  • PUT/leads - изменить лида
  • PATCH/leads - изменить у лида данные активности, имени, приоритета или поля "data"
  • DELETE/leads - удалить лида
  • GET/leads/full - посмотреть информацию о лиде, включая номера телефона и бакеты
  • POST/leads/bulk - массовое создание лидов
  • DELETE/leads/bulk - массовое удаление лидов
  • PATCH/leads/bulk - массовое изменение полей активность, приоритет и время следующего звонка
  • POST/leads/continue_calling - метод, с помощью которого можно восстановить лиду текущую попытку обзвона по планировщику с передачей времени следующего звонка
  • POST/leads/import - импорт лидов
  • POST/leads/export - экспорт лидов
  • POST/leads/bulk/transfer - перенести лидов по фильтру
  • DELETE/leads/bulk/soft - мягкое удаление лидов
  • POST/leads/phones/search - найти номера телефона
  • GET/leads/phones - посмотреть номер телефона
  • POST/leads/phones - добавить номер телефона
  • PUT/leads/phones - изменить все номера телефона
  • DELETE/leads/phones - удалить номер телефона
  • PUT/leads/phone - изменить конкретный номер телефона

Звонки

https://demo.iqtek.ru/dialer/api/v1/docs#/calls

  • POST/calls/export - экспорт звонков
  • POST/calls/search - поиск звонков
  • GET/calls - посмотреть звонок
  • POST/calls/tracking - позволяет добавлять к звонку произвольные данные

Агенты

https://demo.iqtek.ru/dialer/api/v1/docs#/agents

  • GET/agents/info - этот метод используется при входе в АРМ оператора (авторизация)
  • GET/agents - посмотреть агента
  • POST/agents - создать агента
  • PUT/ agents - изменить агента
  • DELETE/agents - удалить агента
  • POST/agents/search - поиск агентов
  • POST/agents/search/full - посмотреть информацию об агенте, включая очереди, к которым он привязан
  • POST/agents/import - импорт агентов
  • POST/agents/export - экспорт агентов
  • POST/agents/logs/change_status - метод для логирования смены статусов в АРМе оператора
  • GET/agents/logs - посмотреть логи
  • DELETE/agents/logs - удалить логи
  • POST/agents/logs/search - найти логи
  • POST/agents/logs/report_work - создать отчет по логам (лог операторов)
  • POST/agents/queues/search - поиск очередей, привязанных к агенту
  • POST/agents/queues - привязать очередь к агенту
  • PUT/agents/queues - изменить очереди, к которым привязан агент
  • DELETE/agents/queues - удалить агента из очереди
  • GET/agents/pauses - просмотр пауз, доступных для агента
  • POST/agents/pauses - привязать модуль пауз к агенту
  • PUT/agents/pauses - изменить модуль пауз, привязанный к агенту
  • DELETE/agents/pauses - удалить модуль пауз, привязанный к агенту
  • GET/agents/pauses/for_agent - посмотреть доступные паузы для агента через привязку к кампании
  • GET/agents/pauses/campaigns/for_agent - посмотреть, какие коды пауз зашиты в конкретных кампаниях
  • POST/agents/pauses/search - поиск кодов пауз
  • DELETE/agents/pauses/bulk - массовое удаление кодов пауз

Черные списки

https://demo.iqtek.ru/dialer/api/v1/docs#/black_lists

  • GET/black_lists - посмотреть черный список
  • POST/black_lists - создать черный список
  • DELETE/black_lists - удалить черный список
  • PUT/black_lists - изменить черный список
  • POST/black_lists/search - найти черный список
  • POST/black_lists/export - экспортировать черный список
  • POST/black_lists/import - импортировать черный список из файла
  • DELETE/black_lists/bulk - массовое удаление черных списков

Определение таймзоны

https://demo.iqtek.ru/dialer/api/v1/docs#/phone_identify

  • POST/phone_identify/region - создать регион
  • PUT/phone_identify/region - изменить регион
  • GET/phone_identify/region - посмотреть регион
  • DELETE/phone_identify/region - удалить регион
  • POST/phone_identify/region/import - импортировать регионы из файла
  • DELETE/phone_identify/region/bulk - массовое удаление регионов
  • PATCH/phone_identify/region/bulk - массовое изменение отдельных полей
  • POST/phone_identify/region/export - экспорт регионов
  • POST/phone_identify/region/search - поиск регионов
  • POST/phone_identify/region/merge - объединение регионов
  • POST/phone_identify/operator - создать оператора
  • PUT/phone_identify/operator - изменить оператора
  • GET/phone_identify/operator - посмотреть оператора
  • DELETE/phone_identify/operator - удалить оператора
  • POST/phone_identify/operator/import - импортировать операторов из файла
  • POST/phone_identify/operator/export - экспортировать операторов
  • POST/phone_identify/operator/search - поиск операторов
  • PATCH/phone_identify/operator/merge - объединение операторов
  • DELETE/phone_identify/operator/bulk - массовое удаление операторов
  • POST/phone_identify/def_code - создать def-код
  • PUT/phone_identify/def_code - изменить def-код
  • GET/phone_identify/def_code - посмотреть def-код
  • DELETE/phone_identify/def_code - удалить def-код
  • POST/phone_identify/def_code/import - импортировать def-коды из файла
  • GET/phone_identify/def_code/phone - поиск по номеру телефона, какому оператору и региону принадлежит
  • POST/phone_identify/def_code/export - экспортировать def-коды
  • POST/phone_identify/def_code/search - поиск
  • GET/phone_identify/stats - статистика по количеству регионов, операторов и def-кодов
  • DELETE/phone_identify/def_code/bulk - массовое удаление def-кодов

System: file

https://demo.iqtek.ru/dialer/api/v1/docs#/system%3A%20file

  • POST/system/file/preview

Доступы

https://demo.iqtek.ru/dialer/api/v1/docs#/permissions

  • POST/acl/permissions/search - поиск по доступам при редактировании ролей

Роли

https://demo.iqtek.ru/dialer/api/v1/docs#/roles

  • POST/acl/roles - создать роль
  • GET/acl/roles - посмотреть роль
  • PUT/acl/roles - изменить роль
  • DELETE/acl/roles - удалить роль
  • POST/acl/roles/search - поиск
  • PUT/acl/roles/permissions - замена доступов для роли
  • PATCH/acl/roles/reorder - смена приоритетов ролей

Пользователи

https://demo.iqtek.ru/dialer/api/v1/docs#/users

  • POST/acl/users - создать пользователя
  • PUT/acl/users - изменить пользователя
  • PATCH/acl/users - изменить некоторые поля пользователя
  • DELETE/acl/users - удалить пользователя
  • GET/acl/users - посмотреть пользователя
  • DELETE/acl/users/bulk - удалить пользователя
  • PUT/acl/users/password - изменить пароль
  • PUT/acl/users/password/my
  • POST/acl/users/search - поиск
  • GET/acl/users/whoami - по токену покажет пользователя, включая роль и набор прав. Используется при входе в АРМ оператора, а также в панель супервайзера.
  • POST/acl/users/sync
  • POST/acl/users/import - импортировать пользователей из файла
  • POST/acl/users/export - экспорт пользователей
  • POST/acl/users/login
  • POST/acl/users/relogin
  • GET/acl/users/login/oauth/{provider_code}
  • POST/acl/users/login/oauth/{provider_code}
  • POST/acl/users/login/ldap/{provider_code}
  • POST/acl/users/api_key_login - авторизация по API-key

Аккаунты

Работа с многими клиентами в рамках одной инсталяции продукта. https://demo.iqtek.ru/dialer/api/v1/docs#/accounts

  • POST/acl/accounts - создать аккаунт
  • PUT/acl/accounts - изменить аккаунт
  • DELETE/acl/accounts - удалить аккаунт
  • GET/acl/accounts - посмотреть аккаунт
  • POST/acl/accounts/search - поиск
  • GET/acl/accounts/sub_tree - посмотреть, какие аккаунты доступны пользователю
  • GET/acl/accounts/my - посмотреть, в каком аккаунте находится пользователь
  • POST/acl/accounts/relogin - переключение между аккаунтами

Задачи

Используются для долгих операций. https://demo.iqtek.ru/dialer/api/v1/docs#/tasks

  • GET/tasks
  • DELETE/tasks
  • POST/tasks/search

SSO-провайдеры

https://demo.iqtek.ru/dialer/api/v1/docs#/sso-providers

  • GET/acl/sso-providers/{code} - посмотреть SSO-провайдера
  • DELETE/acl/sso-providers/{code} - удалить SSO-провайдера
  • PUT/acl/sso-providers/{code} - изменить SSO-провайдера
  • PATCH/acl/sso-providers/{code} - изменить некоторые поля SSO-провайдера
  • POST/acl/sso-providers/search - поиск
  • GET/acl/sso-providers
  • POST/acl/sso-providers