CLS. Руководство пользователя: различия между версиями
Материал из Флора AI
Нет описания правки |
Нет описания правки |
||
| Строка 49: | Строка 49: | ||
! colspan="2" style="width: 85%" |<small>Прямой звонок с номера на номер</small> | ! colspan="2" style="width: 85%" |<small>Прямой звонок с номера на номер</small> | ||
|- | |- | ||
| colspan="2" style="width: 50%" | | | colspan="2" style="width: 50%" |<small><code>{</code></small> <small><code>"source": "8000",</code></small> | ||
<small>{</small> | |||
<small>" | <small><code>"destination": "6000",</code></small> | ||
<small>" | <small><code>"limits": {</code></small> | ||
<small>" | <small><code>"no_answer_timeout": 10,</code></small> | ||
<small>" | <small><code>"dial_tries": 1,</code></small> | ||
<small>" | <small><code>"max_channels": 2,</code></small> | ||
<small>" | <small><code>"redial_timeout": 600,</code></small> | ||
<small>" | <small><code>"watchdog": 240</code></small> | ||
<small> | <small><code>},</code></small> | ||
<small>} | <small><code>"metadata": {}</code></small> | ||
<small> | <small><code>}</code></small> | ||
| style="width: 50%" |<small><code>{</code></small><small><code> "error": 0,</code></small> | | style="width: 50%" |<small><code>{</code></small><small><code> "error": 0,</code></small> | ||
Версия от 15:21, 18 августа 2025
Общее описание
Сервис массового обзвона и уведомлений, поддерживающий множественные каналы связи и гибкую настройку
Основные возможности:
- Выбор канала связи
- голосовые звонки - интеграция с 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 со всеми методами с возможностью их проверки.
| Управление обзвонами | ||
|---|---|---|
| POST /calls/call | Прямой звонок с номера на номер | |
{ "source": "8000",
|
{ "error": 0,
| |
| POST /calls/start | ||
| POST /calls/stop | ||
| Управление списками | ||
| POST /lists/add | ||
| DELETE /lists/delete/{id} | ||
| GET /lists/export/{id} | ||
| POST /lists/import/{id} | ||
| GET /lists/list | ||