Действия

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

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

(Новая страница: «CLS. Руководство пользователя ===== '''Общее описание''' ===== ===== '''Термины и определения''' ===== Сервис Call List Service (CLS) – сервис обзвона списков Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису CLS. ===== '...»)
 
Нет описания правки
 
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
CLS. Руководство пользователя
CLS. Руководство администратора (в разработке)


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


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


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


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


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


===== '''Описание методов API BSS''' =====
'''Instance''' (Инстанция) - активный экземпляр ListCaller, выполняющий обзвон.
Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом CLS. По умолчанию используется порт 6188/tcp.


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


 
'''Конфигурирование параметров сервиса'''
{| class="wikitable" style="width: 110%"
{| class="wikitable"
|+'''''Описание методов API'''''
|+
! style="color:green;width: 15%" |'''POST/bss/backup/{ip}'''
!Параметр
! colspan="3" style="width: 85%" |<small>Принудительный бэкап сервера. На выходе id задания или сообщение об ошибке</small>
!По умолчанию
!Назначение
|-
! 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
|-
|-
| colspan="2" style="width: 50%" |
|freeswitch.src_profile
* <small>'''ip''' - ip адрес сервера данные с которого будут сохранены. IP адрес и каталоги с данными должны быть  в конфиге</small>
|internal
| colspan="2" style="width: 50%" |<small>{  "task_id": "73c8b134-4883-445c-ba9d-3058962bda43"  }</small>
|Какой SIP-профиль FreeSWITCH должен использовать в качестве '''источника''' для исходящего звонка
|-
|-
! style="color:green;width: 15%" |'''POST/bss/config'''
|freeswitch.dst_profile
! colspan="3" style="width: 85%" |<small>Обновить конфигурацию. Установит новый конфиг и заставит сервис его перечитать.</small>
|internal
|В какой SIP-профиль будет отправлен вызов после его обработки внутри FreeSWITCH
|-
|-
| colspan="2" style="width: 50%" |<small>config - json новой конфигурации, структура как у config.json</small>
|freeswitch.src_context
| colspan="2" style="width: 50%" |<small>{  "message": "Configuration updated and reload requested"  }</small>
|ses
|Диалплан (Dialplan) FreeSWITCH, который будет использоваться для '''обработки вызова на этапе его происхождения (origination)'''. Диалплан — это набор правил и инструкций, которые определяют, как обрабатывать вызов.
|-
|-
! style="color:blue;width: 15%" |'''GET/bss/config'''
|freeswitch.dst_trunk
! colspan="3" style="width: 85%" |<small>Получить текущую конфигурацию</small>
|10.2.0.220:5060
|Куда именно отправить вызов.
|-
|-
| colspan="2" style="width: 50%" |<small>Нет параметров</small>
! colspan="3" |ses
| colspan="2" style="width: 50%" |<small>Содержимое файла cjnfig.json</small>
|-
|-
! style="color:blue;width: 15%" |'''GET/bss/tasks'''
|ses.host
! colspan="3" style="width: 85%" |<small>Получить список всех заданий и их результатов за последние два дня</small>
|127.0.0.1
|Адрес сервиса ses для рассылки уведомлений
|-
|-
| colspan="2" style="width: 50%" |<small>Нет параметров</small>
|ses.port
| colspan="2" style="width: 50%" |<small>Список словарей заданий. в каждом элементы:</small>
|6190
<small>task_id, ip_address, status, result, timestamp</small>
|Порт сервиса ses для рассылки уведомлений
|}
|}

Текущая версия от 12:50, 1 сентября 2025

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

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

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

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

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

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

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

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

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


Конфигурирование параметров сервиса

Параметр По умолчанию Назначение
logs
logs.path logs/ Директория для хранения логов. Примеры абсолютного пути: "/var/log/ups/"
logs.backups 10 Количество файлов ротации.
logs.maxSize 5242880 Максимальный размер одного логфайла.
list_log_dir /opt/cls/logs/lists/ Директория для хранения логов обзвона | уведомления по каждому списку
call_log_dir /opt/cls/logs/calls/ Директория для хранения логов одиночных звонков
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 Куда именно отправить вызов.
ses
ses.host 127.0.0.1 Адрес сервиса ses для рассылки уведомлений
ses.port 6190 Порт сервиса ses для рассылки уведомлений
Источник — https://wiki.connect2ai.net/index.php?title=CLS._Руководство_администратора&oldid=3082