Действия

CLS. Руководство пользователя: различия между версиями

Материал из Флора AI

(Новая страница: «===== '''Общее описание''' ===== Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл. ====='''Термины и определения'''===== Text-to-speech server (TTS) – сервис синтеза речи. Модель (голос) – мод...»)
 
 
(не показаны 73 промежуточные версии 2 участников)
Строка 1: Строка 1:
===== '''Общее описание''' =====
===== '''Общее описание''' =====
Сервис предназначен для преобразования текста в речь. Входными данными для сервиса является текст, результатом работы будет аудиофайл.
Сервис массового обзвона и уведомлений, поддерживающий множественные каналы связи и гибкую настройку


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


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


Модель (голос) – модель нейронной сети, отвечающая за синтез спектрограммы из текста. От модели зависит, каким голосом будет синтезирован текст.
Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису CLS в реальном времени.
 
Вокодер – модель нейронной сети, отвечающая за синтез аудиоданных из спектрограммы.
 
Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису TTS в реальном времени


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


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


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


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


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


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


{| class="wikitable" style="width: 110%"
{| class="wikitable" style="width: 110%"
|+''Описание методов API''
|+''Описание методов API''
! style="color:blue;width: 15%" |'''GET/tts/'''
! colspan="3" style="text-align: center"|'''<u>Управление обзвонами</u>'''
! colspan="2" style="width: 85%" |<small>Вывод списка моделей (голосов синтеза).</small>
|-
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
! style="color:green;width: 20%" |'''POST /calls/call'''
| style="width: 50%" |<small><code>{ models: [model1,...,modelN] }</code></small>
! colspan="2" style="width: 80%" |Прямой звонок с номера на номер. Используется для проверки прохождения звонка.
|-
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/export'''
! style="color:blue|'''GET/cls/calls/list/tasks'''
! colspan="2" style="width: 85%" |<small>Выгрузка пользовательского словаря ударений.</small>
! colspan="3" |Получение задач для списка
|-
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
! style="color:blue" |'''GET/cls/calls/queues/status'''
| style="width: 50%" |<small>простой текст - строки с словом и его интерперетацией с ударением</small>
! colspan="3" |Получение статуса всех очередей
|-
|-
! style="color:blue;width: 15%" |'''GET/tts/dictionary/get'''
! style="color:green" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<small>Выгрузка пользовательского словаря ударений в виде json.</small>
! colspan="2" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
! style="color:green" |'''POST /calls/stop'''
| style="width: 50%" |<small><code>[</code></small>  <small><code>[   "слово",   "замена слова с удар+ением"],</code></small>
! colspan="2"  |<nowiki>Остановка списка обзвона | оповещения</nowiki>
 
|-
<small><code>[   "слово2",   "замена слова2 с удар+ением"],</code></small>
! colspan="3" style="text-align: center"|'''<u><nowiki>Управление списками обзвона | оповещения</nowiki></u>'''
 
|-
<small><code>...</code></small>
! style="color:green" |'''POST /lists/add'''
 
! colspan="2"  |<nowiki>Добавление нового списка для обзвона | оповещения</nowiki>
<small><code>]</code></small>
|-
! style="color:red" |'''DELETE /lists/delete/{id}'''
! colspan="2"  |<nowiki>Удаление существующего списка для обзвона | оповещения</nowiki>
|-
! style="color:blue" |'''GET /lists/export/{id}'''
! colspan="2"  |<nowiki>Экспорт списка для обзвона | оповещения в CSV файл</nowiki>
|-
! style="color:green" |'''POST /lists/import/{id}'''
! colspan="2" |<nowiki>Экспорт списка для обзвона | оповещения из CSV файла</nowiki>
|-
! style="color:blue" |'''GET /lists/list'''
! colspan="2" |<nowiki>Получения всех списков для обзвона | оповещения из БД</nowiki>
|-
! style="color:blue" |'''GET /lists/{id}'''
! colspan="2" |<nowiki>Получение конкретного списка для обзвона | оповещения из БД</nowiki>
|-
! style="color:green" |'''POST /lists/load/{id}'''
! colspan="2" |<nowiki>Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта</nowiki>
|-
! style="color:orange" |'''PUT /lists/modify/{id}'''
! colspan="2"  |<nowiki>Изменение существующего списка для обзвона | оповещения</nowiki>
|-
! style="color:blue" |'''GET /lists/status/{id}'''
! colspan="2" |<nowiki>Получение статуса существующего списка для обзвона | оповещения</nowiki>
|-
! colspan="3" style="text-align: center"|'''<u><nowiki>Управление инстанциями обзвона | оповещения</nowiki></u>'''
|-
! style="color:green" |'''POST /instances/add/{list_id}'''
! colspan="2" |<nowiki>Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения</nowiki>
|-
! style="color:blue" |'''GET /instances/get/{instance_id}'''
! colspan="2" |Получить детальную информацию о конкретной инстанции
|-
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/import'''
! style="color:blue" |'''GET /instances/list'''
! colspan="2" style="width: 85%" |<small>Загрузка пользовательского словаря ударений. Текущий словарь будет переписан.</small>
! colspan="2" |Получение списка инстанций
|-
|-
| colspan="2" style="width: 50%" |
! style="color:red" |'''DELETE /instances/remove/{instance_id}'''
* <small>'''csv''' — файл строк со словом и его интерпретацией с ударением.</small>
! colspan="2" |<nowiki>Удаление инстанции обзвона | оповещения</nowiki>
| style="width: 50%" |<small><code>{</code></small>
 
<small><code>  "error": 0,</code></small>
 
<small><code>  "message": "сообщение о статусе результата"</code></small>
 
<small><code>}</code></small>
|-
|-
! style="color:green;width: 15%" |'''POST/tts/dictionary/put'''
! colspan="3" style="text-align: center"|'''<u>Управление временными интервалами</u>'''
! colspan="2" style="width: 85%" |<small>Загрузка пользовательского словаря ударений в виде json. Текущий словарь будет переписан.</small>
|-
|-
| colspan="2" style="width: 50%" |
! style="color:green" |'''POST /timeintervals/add'''
* <small>'''json''' — строка следующего вида:</small>
! colspan="2" |Создание временного интервала
 
<small><code>[</code></small>
 
<small><code>[   "слово",   "замена слова с удар+ением" ],</code></small>
 
<small><code>[ "слово2",   "замена слова2 с удар+ением" ],</code></small>
 
<small><code>...</code></small>
 
<small><code>]</code></small>
| style="width: 50%" |<small><code>{</code></small>
 
<small><code>  "error": 0,</code></small>
 
<small><code>  "message": "сообщение о статусе результата"</code></small>
 
<small><code>}</code></small>
|-
|-
! style="color:green;width: 15%" |'''POST/tts/normalize'''
! style="color:red" |'''DELETE /timeintervals/delete/{id}'''
! colspan="2" style="width: 85%" |<small>Нормализация текста — перевод цифр в слова и расстановка ударений (ударения только в нормализованной части фразы), например «в понедельник 10.10.2025» -> «в понедельник дес+ятого октябр+я две т+ысячи дв+адцать п+ятого г+ода».</small>
! colspan="2" |Удаление существующего интервала времени
|-
|-
| colspan="2" style="width: 50%" |
! style="color:blue" |'''GET /timeintervals/get/{id}'''
* <small>'''text''' — фраза для нормализации.</small>
! colspan="2" |Получение конкретного временного интервала
| style="width: 50%" |<small><code>{</code></small>
 
<small><code>  "error": 0,</code></small>
 
<small><code>  "message": "success",</code></small>
 
<small><code>  "text": "нормализованный текст"</code></small>
 
<small><code>}</code></small>
|-
|-
! style="color:green;width: 15%" |'''POST/tts/revoice/{revoicer}'''
! style="color:blue" |'''GET /timeintervals/list'''
! colspan="2" style="width: 85%" |<small>Модификация или искажение голоса</small>
! colspan="2" |Получение списка временных интервалов
|-
|-
| colspan="2" style="width: 50%" |
! style="color:orange" |'''PUT /timeintervals/modify/{id}'''
* <small>'''wav''' — аудиофайл для обработки.</small>
! colspan="2" |Изменение существующего временного интервала
* <small>'''revoicer''' — модель модификации голоса.</small>
| style="width: 50%" |<small>wav файл с модифицированным (искаженным) голосом.</small>
|-
|-
! style="color:blue;width: 15%" |'''GET/tts/revoicers'''
! colspan="3" style="text-align: center"|'''<u>Управление конфигурациями</u>'''
! colspan="2" style="width: 85%" |<small>Перечень моделей модификации или искажения голоса. Модели поставляются только в составе дистрибутива. Модель distortion — искажение голоса, делает голос неузнаваемым и речь неразборчивой.</small>
|-
|-
| colspan="2" style="width: 50%" |<small>Входные параметры отсутствуют</small>
! style="color:blue" |'''GET /configs/get/{id}'''
| style="width: 50%" |<small>[  "distortion" ]</small>
! colspan="2" |Получение конкретной конфигурации
|-
|-
! style="color:blue;width: 15%" |'''GET/tts/split'''
! style="color:blue" |'''GET /configs/list'''
! colspan="2" style="width: 85%" |<small>Разбивка текста на фразы. Текст из нескольких предложений разбивает на отдельные фразы. Фразы отдаёт списком.</small>
! colspan="2" |Получения списка доступных конфигураций
|-
|-
| colspan="2" style="width: 50%" |
! style="color:orange" |'''PUT /configs/modify/{id}'''
* <small>'''text''' - текст для обработки</small>
! colspan="2" |Изменение существующей конфигурации
| style="width: 50%" |<small>{  "error": 0,</small>
 
<small>  "message": "success",</small>
 
<small>  "phrases": [ "фраза 1", "фраза 2", ....  "фраза N"  ] }</small>
|-
|-
! style="color:green;width: 15%" |'''POST/tts/synthesize/{id}'''
! colspan="3" style="text-align: center"|'''<u>Логирование</u>'''
! colspan="2" style="width: 85%" |<small>Синтез звукового файла из текста для фраз большого размера — тип запроса «POST» позволяет отправку больших текстов.</small><small><small>'''ВНИМАНИЕ''': аналогичный метод GET теперь отсутствует.</small>
|-
|-
| colspan="2" style="width: 50%" |
! style="color:blue" |'''GET /logs/logs'''
* <small>'''ID''' — имя модели</small>
! colspan="2" |Получение логов с указанной даты
* <small>'''text''' — текст синтезируемой фразы</small>
* <small>'''rate''' — скорость речи</small>
* <small>'''pitch''' — высота (тон)</small>
* <small>'''volume''' — громкость</small>
* <small>'''frequency''' — частота дискретизации (по умолчанию 22050 Гц)</small>
* <small>'''format''' - формат файла результата (wav, opus, ogg, mp3)</small>
* <small>'''link''' - если 1, то вернуть только ссылку на файл</small>
| style="width: 50%" |<small>файл с синтезированой фразой</small>
|-
|-
! style="color:blue;width: 15%" |'''GET/license/check'''
! colspan="3" style="text-align: center"|'''<u>Лицензия</u>'''
! colspan="2" |<small>Проверка лицензии</small>
|-
|-
| colspan="2" |<small>Входные параметры отсутствуют</small>
! style="color:blue" |'''GET /license/check'''
|<small>Пример '''неограниченной''' лицензии:
! colspan="2" |Получение состояния лицензии
 
|}
</small><code><small>{</small></code>
 
    <code><small>"error": 0,</small></code>
 
    <code><small>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</small></code>   
 
    <code><small>"remaining_licenses": "infinity",</small></code>
 
    <code><small>"threshold": 0</small></code>
 
<code><small>}</small></code>
 
<small>Пример '''ограниченной''' лицензии:
 
</small><code><small>{</small></code>
 
    <code><small>"error": 0,</small></code>
 
    <code><small>"uuid": "362e51300b1029f9b45fb8d58b2a91bf",</small></code>   
 
    <code><small>"remaining_licenses": 100,</small></code>
 
    <code><small>"threshold": 100</small></code>
 
<code><small>}</small></code>

Текущая версия от 17:45, 16 января 2026

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

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

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

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

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

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

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

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

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

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

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

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

Описание методов API
Управление обзвонами
POST /calls/call Прямой звонок с номера на номер. Используется для проверки прохождения звонка.
GET/cls/calls/list/tasks Получение задач для списка
GET/cls/calls/queues/status Получение статуса всех очередей
POST /calls/start Старт списка обзвона | оповещения
POST /calls/stop Остановка списка обзвона | оповещения
Управление списками обзвона | оповещения
POST /lists/add Добавление нового списка для обзвона | оповещения
DELETE /lists/delete/{id} Удаление существующего списка для обзвона | оповещения
GET /lists/export/{id} Экспорт списка для обзвона | оповещения в CSV файл
POST /lists/import/{id} Экспорт списка для обзвона | оповещения из CSV файла
GET /lists/list Получения всех списков для обзвона | оповещения из БД
GET /lists/{id} Получение конкретного списка для обзвона | оповещения из БД
POST /lists/load/{id} Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта
PUT /lists/modify/{id} Изменение существующего списка для обзвона | оповещения
GET /lists/status/{id} Получение статуса существующего списка для обзвона | оповещения
Управление инстанциями обзвона | оповещения
POST /instances/add/{list_id} Создание инстанции обзвона | оповещения на основе списка, без запуска обзвона | оповещения
GET /instances/get/{instance_id} Получить детальную информацию о конкретной инстанции
GET /instances/list Получение списка инстанций
DELETE /instances/remove/{instance_id} Удаление инстанции обзвона | оповещения
Управление временными интервалами
POST /timeintervals/add Создание временного интервала
DELETE /timeintervals/delete/{id} Удаление существующего интервала времени
GET /timeintervals/get/{id} Получение конкретного временного интервала
GET /timeintervals/list Получение списка временных интервалов
PUT /timeintervals/modify/{id} Изменение существующего временного интервала
Управление конфигурациями
GET /configs/get/{id} Получение конкретной конфигурации
GET /configs/list Получения списка доступных конфигураций
PUT /configs/modify/{id} Изменение существующей конфигурации
Логирование
GET /logs/logs Получение логов с указанной даты
Лицензия
GET /license/check Получение состояния лицензии
Источник — https://wiki.connect2ai.net/index.php?title=CLS._Руководство_пользователя&oldid=3550