CLS. Руководство пользователя

Общее описание

Сервис массового обзвона и уведомлений, поддерживающий множественные каналы связи и гибкую настройку

Основные возможности:

• Выбор канала связи
  • голосовые звонки - интеграция с FreeSWITCH для исходящих звонков
  • telegram | VK - интеграция с SES для последующей отправки уведомления в мессенджер
• Управление списками обзвона
  • CRUD операции - создание, чтение, изменение, удаление списков
  • Импорт/Экспорт - загрузка и выгрузка контактов из CSV
  • Автозагрузка - динамическое расширение списков через скрипт
  • Планировщик - cron-подобное расписание запуска обзвонов
• Конфигурация и лимиты
  • Глобальные настройки - централизованное управление конфигурацией
  • Временные интервалы - точное управление временем работы
  • Праздники - учет выходных дней при обзвонах
  • Лимиты обзвона - контроль нагрузки и таймаутов
• Мониторинг и отчетность
  • Реальное время - отслеживание статуса обзвонов
  • Логирование - детальные логи всех звонков / уведомлений
  • API - полный программный доступ ко всем функциям

Термины и определения

CLS (Call List Service) - сервис массового обзвона и уведомлений с поддержкой множественных каналов связи.

Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису CLS в реальном времени.

Список обзвона (Call List) - набор контактов с метаданными для выполнения массовой рассылки или обзвона.

ListCaller - основной класс, управляющий выполнением кампании по конкретному списку.

Instance - активный экземпляр ListCaller, выполняющий обзвон.

Описание методов API

Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом CLS. По умолчанию используется порт 6188/tcp.

Авторизация запросов не требуется. HTTP-запросы должны содержать заголовок "accept: application/json"

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6188 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

Описание методов API

Управление обзвонами
POST /calls/call	Прямой звонок с номера на номер
GET/cls/calls/list/tasks	Получение задач для списка
GET/cls/calls/queues/status	Получение статуса всех очередей
POST /calls/start	Старт списка обзвона | оповещения
POST /calls/stop	Остановка списка обзвона | оповещения
Управление списками обзвона | оповещения
POST /lists/add	Добавление нового списка для обзвона | оповещения
DELETE /lists/delete/{id}	Удаление существующего списка для обзвона | оповещения
GET /lists/export/{id}	Экспорт списка для обзвона | оповещения в CSV файл
POST /lists/import/{id}	Экспорт списка для обзвона | оповещения из CSV файла
GET /lists/list	Получения всех списков для обзвона | оповещения из БД
GET /lists/{id}	Получение конкретного списка для обзвона | оповещения из БД
POST /lists/load/{id}	Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта
PUT /lists/modify/{id}	Изменение существующего списка для обзвона | оповещения
GET /lists/status/{id}	Получение статуса существующего списка для обзвона | оповещения
Управление инстанциями обзвона | оповещения
POST /instances/add/{list_id}	Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения
GET /instances/get/{instance_id}	Получить детальную информацию о конкретной инстанции
GET /instances/list	Получение списка инстанций
DELETE /instances/remove/{instance_id}	Удаление инстанции обзвона | оповещения
Управление временными интервалами
POST /timeintervals/add	Создание временного интервала
DELETE /timeintervals/delete/{id}	Удаление существующего интервала времени
GET /timeintervals/get/{id}	Получение конкретного временного интервала
GET /timeintervals/list	Получение списка временных интервалов
PUT /timeintervals/modify/{id}	Изменение существующего временного интервала
Управление конфигурациями
GET /configs/get/{id}	Получение конкретной конфигурации
GET /configs/list	Получения списка доступных конфигураций
PUT /configs/modify/{id}	Изменение существующей конфигурации
Логирование
GET /logs/logs	Получение логов с указанной даты
Лицензия
GET /license/check	Получение состояния лицензии