Флора AI - Вклад [ru]

CLS. Руководство администратора

2025-09-01T09:50:29Z

YurchenkoV:

CLS. Руководство администратора (в разработке)

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

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

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

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

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

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

'''Конфигурирование параметров сервиса'''
{| class="wikitable"
|+
!Параметр
!По умолчанию
!Назначение
|-
! colspan="3" |logs
|-
|logs.path
|logs/
|Директория для хранения логов. Примеры абсолютного пути: "/var/log/ups/"
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер одного логфайла.
|-
! colspan="3" |
|-
|list_log_dir
|/opt/cls/logs/lists/
|<nowiki>Директория для хранения логов обзвона | уведомления по каждому списку</nowiki>
|-
|call_log_dir
|/opt/cls/logs/calls/
|Директория для хранения логов одиночных звонков
|-
! colspan="3" |freeswitch
|-
|freeswitch.server
|127.0.0.1
|Адрес, на котором работает FreeSWITCH
|-
|freeswitch.port
|8021
|Порт, на котором работает FreeSWITCH
|-
|freeswitch.auth
|ClueCon
|Пароль для аутентификации при подключении к Event Socket у FreeSwitch
|-
|freeswitch.src_profile
|internal
|Какой SIP-профиль FreeSWITCH должен использовать в качестве '''источника''' для исходящего звонка
|-
|freeswitch.dst_profile
|internal
|В какой SIP-профиль будет отправлен вызов после его обработки внутри FreeSWITCH
|-
|freeswitch.src_context
|ses
|Диалплан (Dialplan) FreeSWITCH, который будет использоваться для '''обработки вызова на этапе его происхождения (origination)'''. Диалплан — это набор правил и инструкций, которые определяют, как обрабатывать вызов.
|-
|freeswitch.dst_trunk
|10.2.0.220:5060
|Куда именно отправить вызов.
|-
! colspan="3" |ses
|-
|ses.host
|127.0.0.1
|Адрес сервиса ses для рассылки уведомлений
|-
|ses.port
|6190
|Порт сервиса ses для рассылки уведомлений
|}

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

2025-08-25T11:41:17Z

YurchenkoV:

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

====== '''Основные возможности:''' ======
* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/{id}'''
! colspan="2" |<nowiki>Получение конкретного списка для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code>"error": 0,</code>
<code>"list": {}</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" |'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
! style="color:blue;width: 15%" |'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
! style="color:blue;width: 15%" |'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
! style="color:blue;width: 15%" |'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-25T11:39:52Z

YurchenkoV:

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

====== '''Основные возможности:''' ======
* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
!'''GET /lists/{id}'''
! colspan="2" |<nowiki>Получение конкретного списка для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code>"error": 0,</code>
<code>"list": {}</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" |'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
! style="color:blue;width: 15%" |'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
! style="color:blue;width: 15%" |'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
! style="color:blue;width: 15%" |'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

QAS. Руководство администратора

2025-08-25T11:26:01Z

YurchenkoV:

====='''Общее описание'''=====
Сервис предназначен для поиска ответа на заданный вопрос. Входным значением для сервиса являются данные в текстовом формате. В ответ на входящий запрос сервис возвращает данные в формате JSON.
====='''Термины и определения'''=====
Question Answering System (QAS) – сервис ответов на вопросы.

====='''Системные требования'''=====
Для нормальной работы сервиса без GPU необходимо не менее 8 CPU (минимальные требования для использования метода ask) >= 2.20 GHz с поддержкой инструкций AVX2 или новее:
*Intel Haswell
*Intel Broadwell
*Intel Skylake
*Intel Kaby Lake
*Intel Coffee Lake
*Intel Comet Lake
*Intel Rocket Lake
*Intel Alder Lake
*AMD Excavator
*AMD Zen (AMD Ryzen)
*AMD Zen 2 (AMD Ryzen)
*AMD Zen 3 (AMD Ryzen)
Работа на CPU при использовании метода ask крайне не рекомендуется. Оперативной памяти необходимо не менее 16Gb для работы без GPU.

====='''Установка/обновление сервиса'''=====
[https://cloud.connect2ai.net/index.php/apps/files/?dir=/qas&fileid=26891 Дистрибутив] распространяется в виде установочных пакетов для окружения и сервиса. Загрузите установочные пакеты на сервер и выполните команды для вашей системы в каталоге с пакетом.

Перед установкой непосредственно сервиса необходимо [[PVE. Установка сервисного пакета окружения|установить сервисный пакет окружения]].

* Установка/обновление QAS осуществляется скриптом <code>chmod +x ./qas-<версия>-<релиз>.sh && ./qas-<версия>-<релиз>.sh -i</code> с правами администратора. Список всех ключей инсталлятора можно посмотреть, запустив инсталлятор <code>./qas-<версия>-<релиз>.sh</code> без ключей.
* Загрузить последнюю версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/new</nowiki>" --user '[user]:[pass]' 2>&1 | bash</code> или в интерактивном режиме <code>bash -c "$(curl -s https://repo.connect2ai.net/api/qas --user '[user]:[pass]' 2>&1)"</code>.
* Обновить QAS <code>/opt/qas/inupdate</code> в интерактивном режиме. Или запустить с ключом:
** <code>/opt/qas/inupdate -b</code> – обновить до последней beta версии;
** <code>/opt/qas/inupdate -r</code> – обновить до последней release версии;
** <code>/opt/qas/inupdate -n</code> – обновить до последней версии (неважно beta или release).
* Установить модели <code>/opt/qas/inmodel</code> в интерактивном режиме.
* Проверить актуальную версию продукта <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/version</nowiki></code>.
* Посмотреть лог изменений <code>curl -s "<nowiki>https://repo.connect2ai.net/api/qas/changelog</nowiki>" --user '[user]:[pass]'</code>.
* Полное описание всех команд API репозитория можно найти по ссылке '''https://repo.connect2ai.net/api'''. <code>[user]:[pass]</code> – это тот же логин и пароль, что и от [https://cloud.connect2ai.net '''Nextcloud'''.]
* В папке с продуктом можно добавить 2 файла конфигурации (допускается один общий файл на все продукты в папке с окружением /opt/pve/):
** echo -n <code>"[user]:[pass]"</code> > /opt/qas/.userapi (это файл авторизации в API, нужен для обновления и загрузки моделей)
** echo -n <code>"<nowiki>http://example.com:3128</nowiki> [user] [password]"</code> > /opt/qas/.proxy (это файл конфигурации proxy, необходим для обновления и загрузки моделей, при отсутствующем прямом подключении к интернету)

При обновлении следующий список файлов и папок сохраняется: .userapi, .proxy, logs, nnets, config.json, cache, pretrained, pve, data. Сервис не требует остановки и возвращается в актуальное состояние после обновления.

Не забудьте запустить сервис и включить в автозапуск в системе:

<code>sudo systemctl enable qas.service && sudo systemctl start qas.service</code>

Удостоверьтесь, что сервис стартовал:

<code>systemctl status qas.service</code>

Разрешите доступ к порту 6187 на нужном интерфейсе по протоколу tcp.

===== '''Лицензия''' =====
Сервис не функционирует без действующей лицензии. Информация о лицензии хранится в файле:

<code>/opt/qas/license.json</code>

Файл лицензии должен соответствовать следующему формату:

<code>{"service": "qas", "expire": "2045-01-01", "licenses": , "key": ""}</code>

Для получения лицензии необходимо:

1. Запустить сервис <code>systemctl start qas</code> и извлечь UUID, указанный в файле <code>/opt/qas/logs/log.txt</code>

2. Передать полученный UUID руководителю проекта для оформления лицензии.

====='''Установка моделей'''=====

В составе QAS используются модели векторизации, и генеративные модели LLM.

Модели векторизации располагаются в папках:

* /opt/qas/pretrained/embeddings/questions - для работы с кэшем вопросов
* /opt/qas/pretrained/embeddings/docs - для работы с документами

Расположение моделей LLM: /opt/qas/pretrained/gpt/<имя_модели>/. Например , встроенная модель LLM: /opt/qas/pretrained/gpt/default/. Модели после установки QAS должны быть добавлены системным администратором.

QAS допускает использование дополнительных моделей LLM. Каждая из таких моделей должна быть в отдельной папке каталога /opt/qas/pretrained/gpt/<имя_модели>/. Если модель формата GGUF, то достаточно поместить ее в свою папку в /opt/qas/pretrained/gpt/. В остальных случаях (в том числе и если необходимо обращаться к стороннему api) в папке модели должен быть файл handler.py с функцией handler(prompt='тут текст',params={параметры запроса, см. в руководстве пользователя в метода добавления шаблона запроса}), которая возвращает сгенерированный текст.

====='''Работа в составе кластера'''=====

Для высоконагруженных систем сервис можно расположить на нескольких нодах (виртуальных машинах). В этом случае, чтобы не потерять документы и изменения, полученные на одной из нод, выделяется один основной сервис и вспомогательные сервисы:

* База файловая, в папке data.
* lsync настроен через конфиг QAS для репликации базы на все указанные серверы в списке cluster.nodes: [], указываем все слейв-сервера.
* На всех слейвах прописан в конфиге master, чтобы все операции добавления и изменения данных при автокешировании они производили через мастер. Параметр в конфиге questions.master, на мастере значение «<nowiki>http://127.0.0.1:6187»</nowiki>.
* Векторная база на каждом сервере своя, она следит за своей папкой data и обновляет в оперативке по этой папке данные у себя.
* UPS при изменении данных работает только с мастером QAS, а при запросе данных — со всеми серверами cluster, распределяя нагрузку.
* В конфигурации UPS: в servers.qas.trainer указываем мастер-сервер, в servers.qas.cluster перечисляем все сервера кластера QAS, в том числе и мастер.

===== '''Конфигурирование параметров сервиса''' =====
Настройка параметров сервиса qas производится в файле /opt/qas/config.json.

Описание параметров приведено в таблице.
{| class="wikitable"
|+
!style="width: 20%"|Параметр
!По умолчанию
!Назначение
|-
|reloader.period
|60
|Период обновления векторов базы вопросов и документов.
|-
|gpt.instances
|1
|Количество экземпляров встроенной нейросети
|-
|gpt.gpu_layers
|12
|Количество слоёв встроенной нейросети.
|-
|gpt.context
|32768
|Размер контекста встроенной нейросети.
|-
|logs.path
|logs/
|Папка для хранения логов. Примеры абсолютного пути: "/var/log/qas/".
|-
|logs.backups
|10
|Количество файлов ротации.
|-
|logs.maxSize
|5242880
|Максимальный размер файла в байтах, триггер для ротации.
|-
|cache.size
|2560000
|Максимальный размер кэша векторов
|-
|cache.update
|3600
|Период сохранения кэша на диск (секунды)
|-
|fragments.context
|8192
|Максимальная длина текста, которая будет подана в генератор для поиска ответа на вопрос.
|-
|fragments.threshold
|0.6
|Уровень достоверности при векторном поиске фрагментов в загруженных документах.
|-
|fragments.limit
|1
|Максимальное количество фрагментов, которые должны быть найдены в документах в порядке убывания доверия.
|-
|questions.master
|"<nowiki>http://127.0.0.1:6187</nowiki>"
|Адрес мастер-сервера для работы в кластере. Необходим, чтобы добавленные вопросы распространились на серверы кластера.
|-
|questions.threshold
|0.9
|Минимальный уровень достоверности ответа для попадания в кеш.
|-
|cluster.logfile
|logs/sync.log
|Расположение лог-файла синхронизации (актуально для мастер-сервера).
|-
|cluster.logfile
|logs/sync.status
|Расположение файла статуса lsyncd (актуально для мастер-сервера)
|-
|cluster.nodes
|[ ]
|Ноды кластера, на которые с мастер-сервера будут распространяться изменения.
|}

===== '''Сбор данных об ошибках''' =====
Логи сервиса по умолчанию находятся в файле /opt/qas/logs/log.txt

====='''Удаление'''=====
Для удаления выполните команду: <code>/opt/qas/uninstall</code>. Команда деинсталлирует сервис и удалит рабочий каталог, включая все установленные модели.

CLS. Руководство администратора

2025-08-19T09:11:21Z

YurchenkoV:

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

2025-08-19T09:09:44Z

YurchenkoV:

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

====== '''Основные возможности:''' ======
* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" |'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
! style="color:blue;width: 15%" |'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
! style="color:blue;width: 15%" |'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
! style="color:blue;width: 15%" |'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T09:01:54Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" |'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
! style="color:blue;width: 15%" |'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
! style="color:blue;width: 15%" |'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
! style="color:blue;width: 15%" |'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T08:59:40Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" |'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
! style="orange:blue;width: 15%" |'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
!'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
!'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T08:57:39Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |'''Управление обзвонами'''
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление списками обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |'''<nowiki>Управление инстанциями обзвона | оповещения</nowiki>'''
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление временными интервалами'''
|-
! style="color:green;width: 15%" '''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Управление конфигурациями'''
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |'''Логирование'''
|-
!'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |'''Лицензия'''
|-
!'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T08:45:11Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление временными интервалами
|-
!'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление конфигурациями
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Логирование
|-
!'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "uuid",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |Лицензия
|-
!'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "uuid",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T08:43:50Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление временными интервалами
|-
!'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление конфигурациями
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Логирование
|-
!'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "1a0abdf7-fe64-45c1-a1a8-399820299b03",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|-
! colspan="3" |Лицензия
|-
!'''GET /license/check'''
! colspan="2" |Получение состояния лицензии
|-
| colspan="2" |No parameters
|
<code>{</code>
<code>"error": 0,</code>

<code>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</code>

<code>"remaining_licenses": "infinity",</code>

<code>"threshold": 0</code>

<code>}</code>
|}

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

2025-08-19T08:37:02Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление временными интервалами
|-
!'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление конфигурациями
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Логирование
|-
!'''GET /logs/logs'''
! colspan="2" |Получение логов с указанной даты
|-
| colspan="2" |
* '''date''' - стартовая дата (формат: 2025-01-01)
* '''id -''' id списка для фильтрации (опционально)
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"logs": [</code>

<code>[</code>

<code>{</code>

<code>"uuid": "1a0abdf7-fe64-45c1-a1a8-399820299b03",</code>

<code>"channel": "voice",</code>

<code>"source": "8000",</code>

<code>"destination": "8000",</code>

<code>"message": "Call to 8000 ended",</code>

<code>"duration": "44",</code>

<code>"status": "CALL_ENDED",</code>

<code>"hangup_cause": "NORMAL_TEMPORARY_FAILURE",</code>

<code>"sip_hangup_init": "<nowiki>sip:200</nowiki>",</code>

<code>"metadata": null</code>

<code>}</code>

<code>]</code>

<code>]</code>

<code>}</code>
|}

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

2025-08-19T08:28:44Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление временными интервалами
|-
!'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление конфигурациями
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": []</code>

<code>}</code>
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|-
| colspan="2" |
<code>{</code>

<code> "id": "string",</code>

<code> "params": {}</code>

<code>}</code>
|
<code>{</code>

<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|}

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

2025-08-19T08:24:44Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |Управление временными интервалами
|-
!'''POST /timeintervals/add'''
! colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''DELETE /timeintervals/delete/{id}'''
! colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
!'''GET /timeintervals/get/{id}'''
! colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
!'''GET /timeintervals/list'''
! colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
!'''PUT /timeintervals/modify/{id}'''
! colspan="2" |Изменение существующего временного интервала
|-
| colspan="2" |
*'''payload''' как в '''POST /timeintervals/add'''
* '''id''' - id списка
|
|-
! colspan="3" |Управление конфигурациями
|-
!'''GET /configs/get/{id}'''
! colspan="2" |Получение конкретной конфигурации
|-
| colspan="2" |
* '''id''' - id конфигурации
|
<code>{</code>

<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"data": {</code>

<code>"id": "limits",</code>

<code>"params": {</code>

<code>"watchdog": 60,</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600</code>

<code>}</code>

<code>}</code>

<code>}</code>
|-
!'''GET /configs/list'''
! colspan="2" |Получения списка доступных конфигураций
|-
!'''PUT /configs/modify/{id}'''
! colspan="2" |Изменение существующей конфигурации
|}

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

2025-08-19T07:54:32Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''DELETE /timeintervals/delete/{id}'''
| colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''GET /timeintervals/get/{id}'''
| colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
|'''GET /timeintervals/list'''
| colspan="2" |Получение списка временных интервалов
|-
| colspan="2" |No parameters
|
<code>{</code>

<code>"error": 0,</code>

<code>"timeintervals": []</code>

<code>}</code>
|-
|'''PUT /timeintervals/modify/{id}'''
|
|
|}

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

2025-08-19T07:52:21Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''DELETE /timeintervals/delete/{id}'''
| colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''GET /timeintervals/get/{id}'''
| colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|
<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
|'''GET /timeintervals/list'''
| colspan="2" |
|-
| colspan="2" |
|
|-
|'''PUT /timeintervals/modify/{id}'''
|
|
|}

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

2025-08-19T07:50:26Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''DELETE /timeintervals/delete/{id}'''
| colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''GET /timeintervals/get/{id}'''
| colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code>"error": 0,</code>

<code>"timeinterval": {</code>

<code>"id": "default",</code>

<code>"name": "default",</code>

<code>"days": "all",</code>

<code>"weekdays": [</code>

<code>1</code>

<code>],</code>

<code>"months": [</code>

<code>1</code>

<code>],</code>

<code>"dates": [</code>

<code>1</code>

<code>],</code>

<code>"intervals": [</code>

<code>[0, 1440]</code>

<code>]</code>

<code>}</code>

<code>}</code>
|-
|'''GET /timeintervals/list'''
| colspan="2" |
|-
| colspan="2" |
|
|-
|'''PUT /timeintervals/modify/{id}'''
|
|
|}

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

2025-08-19T07:50:05Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''DELETE /timeintervals/delete/{id}'''
| colspan="2" |Удаление существующего интервала времени
|-
| colspan="2" |
* '''id''' - id интервала времени
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
|'''GET /timeintervals/get/{id}'''
| colspan="2" |Получение конкретного временного интервала
|-
| colspan="2" |
* '''id''' - id интервала времени
|{
"error": 0,

"timeinterval": {

"id": "default",

"name": "default",

"days": "all",

"weekdays": [

1

],

"months": [

1

],

"dates": [

1

],

"intervals": [

[0, 1440]

]

}

}
|-
|'''GET /timeintervals/list'''
| colspan="2" |
|-
| colspan="2" |
|
|-
|'''PUT /timeintervals/modify/{id}'''
|
|
|}

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

2025-08-19T07:42:11Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [[0,1440],]</code>

<code>}</code>
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:41:33Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |
<code>{</code>

<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [0,1440]</code>

<code>}</code>
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:40:37Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" | <code>{</code>
<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [0,1440]</code>

<code>}</code>
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:39:45Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" | <code>{</code>
<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [0,1440]</code>

<code>}</code>
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:38:47Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" | <code>{</code>
<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>

<code>"name": "Новый интервал 2",</code>

<code>"days": "all",</code>

<code>"weekdays": [1],</code>

<code>"months": [1],</code>

<code>"dates": [1],</code>

<code>"intervals": [0,1440]</code>

<code>}</code>
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:37:45Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" <code>{</code>
<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>
<code>"name": "Новый интервал 2",</code>
<code>"days": "all",</code>
<code>"weekdays": [1],</code>
<code>"months": [1],</code>
<code>"dates": [1],</code>
<code>"intervals": [[0,1440]]</code>
<code>}</code>
|
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:36:41Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2"
|<code>{</code>
<code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code>
<code>"name": "Новый интервал 2",</code>
<code>"days": "all",</code>
<code>"weekdays": [1],</code>
<code>"months": [1],</code>
<code>"dates": [1],</code>
<code>"intervals": [[0,1440]]</code>
<code>}</code>
|
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-19T07:32:05Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|-
|'''POST /timeintervals/add'''
| colspan="2" |Создание временного интервала
|-
| colspan="2" |<code>{</code><code>"id": "02f2d1ce-bb0b-4856-904b-2db13250bb90",</code><code>"name": "Новый интервал 2",</code><code>"days": "all",</code><code>"weekdays": [</code><code>1</code><code>],</code><code>"months": [</code><code>1</code><code>],</code><code>"dates": [</code><code>1</code><code>],</code><code>"intervals": [</code><code>[0,1440]</code><code>]</code><code>}</code>
|
|-
|
| colspan="2" |
|-
| colspan="2" |
|
|}

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

2025-08-18T14:15:34Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code>
<code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|}

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

2025-08-18T14:15:13Z

YurchenkoV:

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

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

* Выбор канала связи
** голосовые звонки - интеграция с '''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-запросы должны содержать заголовок <code>"accept: application/json"</code>

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

{| class="wikitable" style="width: 110%"
|+''Описание методов API''
! colspan="3" |Управление обзвонами
|-
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |Прямой звонок с номера на номер
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code>"source": "8000",</code>

<code>"destination": "6000",</code>

<code>"limits": {</code>

<code>"no_answer_timeout": 10,</code>

<code>"dial_tries": 1,</code>

<code>"max_channels": 2,</code>

<code>"redial_timeout": 600,</code>

<code>"watchdog": 240</code>

<code>},</code>

<code>"metadata": {}</code>

<code>}</code>
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! colspan="3" |<nowiki>Управление списками обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /lists/add'''
! colspan="2" style="width: 85%" |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |<code>{</code>
<code> "name": "Test Call List",</code> - имя списка

<code> "source": "8000",</code> - источник вызова | оповещения

<code> "limits": {</code> - лимиты для вызова (опционально)

<code> "no_answer_timeout": 10,</code>

<code> "dial_tries": 1,</code>

<code> "max_channels": 2,</code>

<code> "redial_timeout": 600,</code>

<code> "watchdog": 240</code>

<code> },</code>

<code> "dialed": 0,</code>

<code> "timeintervals": [</code>

<code> "default"</code> - id временного интервала

<code> ],</code>

<code> "channel": "voice",</code> - используемый канал

<code> "channel_parameters": {</code> - используется для каналов telegram и vk

<code> "robot_id": "",</code>

<code> "endpoint": ""</code>

<code> },</code>

<code> "script_before_dial": "",</code> - скрипт для выполнения перед каждым вызовом | оповещением

<code> "script": "",</code> - скрипт дозагрузки элементов для обзвона

<code> "autoload": false,</code> - автоматическая дозагрузка элементов для обзвона при старте списка

<code> "scheduler": [</code> - планировщик выполнения обзвона | оповещения

<code> "35 14 * * *"</code> - cron-расписание запуска обзвона

<code> ],</code>

<code> "items": [</code>

<code> {</code>

<code> "destinations": [</code> - телефоны | user_id для каналов отличных от voice

<code> "6000"</code>

<code> ],</code>

<code> "metadata": {}</code> - дополнительная произвольная информация

<code> }</code>

<code> ]</code>

<code>}</code>
| style="width: 50%" |<code>{
<code>"error": 0,</code>

<code>"message": "success",</code>

<code>"id": "123e4567-e89b-12d3-a456-426614174000"</code>

<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /lists/delete/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/export/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/import/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
| colspan="2" |
* '''csv''' - csv файл с элементами списка

* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/list'''
! colspan="2" style="width: 85%" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
| colspan="2" style="width: 50%" |No parameters
| style="width: 50%" |<code>{</code>
<code>"error": 0,</code>
<code>"lists": []</code>
<code>}</code>
|-
! style="color:green;width: 15%" |'''POST /lists/load/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
| colspan="2" style="width: 50%" |
* id - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:orange;width: 15%" |'''PUT /lists/modify/{id}'''
! colspan="2" style="width: 85%" |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" style="width: 50%" |
* '''payload''' как в '''POST /lists/add'''
* '''id''' - id списка
| style="width: 50%" |<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
| colspan="2" |
* id - id списка
|<code>{</code>
<code>"error": 0,{</code>
<code>"status": {</code>
<code>"total_items": 0,</code>
<code>"processed_items": 0,</code>
<code>"completed": false,{</code>
<code>"reason": "",</code>
<code>"running": false</code>
<code>}</code>
<code>}</code>
|-
! colspan="3" |<nowiki>Управление инстанциями обзвона | оповещения</nowiki>
|-
! style="color:green;width: 15%" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
| colspan="2" |
* '''id''' - id списка
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
| colspan="2" |
* '''id''' - id списка | инстанции (одно и тоже)
|<code>{</code>
<code>"id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"name": "Test Call List",</code>
<code>"source": "8000",</code>
<code>"limits": {</code>
<code>"no_answer_timeout": 5,</code>
<code>"dial_tries": 1,</code>
<code>"max_channels": 2,</code>
<code>"redial_timeout": 200,</code>
<code>"watchdog": 60</code>
<code>},</code>
<code>"timeintervals": ["default"],</code>
<code>"holidays": ["2025-09-14"],</code>
<code>"channel": "voice",</code>
<code>"running": true,</code>
<code>"progress": {</code>
<code>"total_items": 1,</code>
<code>"processed_items": 1,</code>
<code>"completed": false,</code>
<code>"reason": ""</code>
<code>},</code>
<code>"job_info": {</code>
<code>"has_job": true,</code>
<code>"job_id": "86c08271-8415-4ba5-bcf1-e1115a602bd8",</code>
<code>"next_run": "2025-12-24 20:00:00+03:00"</code>
<code>},</code>
<code>"created": "2025-08-18T14:57:17.762777",</code>
<code>"items": [</code>
<code>{</code>
<code>"destinations": ["6000"],</code>
<code>"metadata": {}</code>
<code>}</code>
<code>]</code>
<code>}</code>
|-
! style="color:blue;width: 15%" |'''GET /instances/list'''
! colspan="2" |Получение списка инстанций
|-
| colspan="2" |No parameters
|<code>{</code> <code>"total": 0,</code>
<code>"instances": []</code>
<code>}</code>
|-
! style="color:red;width: 15%" |'''DELETE /instances/remove/{instance_id}'''
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
|-
| colspan="2" |'''id'''<nowiki> - id списка | инстанции (одно и тоже)</nowiki>
|<code>{</code>
<code> "error": 0,</code>

<code> "message": "сообщение о статусе результата"</code>

<code>}</code>
|-
| colspan="3" |Управление временными интервалами
|}

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

2025-08-18T14:13:46Z

YurchenkoV:

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

2025-08-18T14:10:46Z

YurchenkoV:

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

2025-08-18T14:09:25Z

YurchenkoV:

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

2025-08-18T14:08:13Z

YurchenkoV:

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

2025-08-18T14:05:56Z

YurchenkoV:

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

2025-08-18T14:05:17Z

YurchenkoV:

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

2025-08-18T14:02:13Z

YurchenkoV:

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

2025-08-18T13:49:14Z

YurchenkoV:

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

2025-08-18T13:45:53Z

YurchenkoV:

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

2025-08-18T13:45:11Z

YurchenkoV:

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

2025-08-18T13:43:17Z

YurchenkoV:

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

2025-08-18T13:12:44Z

YurchenkoV:

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

2025-08-18T13:11:40Z

YurchenkoV:

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

2025-08-18T13:11:07Z

YurchenkoV:

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

2025-08-18T13:10:46Z

YurchenkoV:

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

2025-08-18T13:09:39Z

YurchenkoV:

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

2025-08-18T13:08:16Z

YurchenkoV:

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

2025-08-18T13:06:43Z

YurchenkoV:

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

2025-08-18T13:05:33Z

YurchenkoV:

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

2025-08-18T12:56:29Z

YurchenkoV:

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

2025-08-18T12:53:02Z

YurchenkoV:

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

2025-08-18T12:48:22Z

YurchenkoV: