Действия

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

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

Нет описания правки
Нет описания правки
Строка 46: Строка 46:
! colspan="3" |Управление обзвонами
! colspan="3" |Управление обзвонами
|-
|-
! style="color:blue;width: 15%" |'''POST /calls/call'''
! style="color:green;width: 15%" |'''POST /calls/call'''
! colspan="2" style="width: 85%" |<small>Прямой звонок с номера на номер</small>
! colspan="2" style="width: 85%" |<small>Прямой звонок с номера на номер</small>
|-
|-
Строка 78: Строка 78:
<small><code>}</code></small>
<small><code>}</code></small>
|-
|-
! style="color:blue;width: 15%" |'''POST /calls/start'''
! style="color:green;width: 15%" |'''POST /calls/start'''
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
! colspan="2" style="width: 85%" |<nowiki>Старт списка обзвона | оповещения</nowiki>
|-
|-
Строка 90: Строка 90:
<small><code>}</code></small>
<small><code>}</code></small>
|-
|-
! style="color:blue;width: 15%" |'''POST /calls/stop'''
! style="color:green;width: 15%" |'''POST /calls/stop'''
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
! colspan="2" style="width: 85%" |<nowiki>Остановка списка обзвона | оповещения</nowiki>
|-
|-

Версия от 15:27, 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 со всеми методами с возможностью их проверки.

Описание методов API
Управление обзвонами
POST /calls/call Прямой звонок с номера на номер
{ 
   "source": "8000",

   "destination": "6000",

   "limits": {

       "no_answer_timeout": 10,

       "dial_tries": 1,

       "max_channels": 2,

       "redial_timeout": 600,

       "watchdog": 240

   },

   "metadata": {}

}

{ 
     "error": 0,

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

}

POST /calls/start Старт списка обзвона | оповещения
  • id - id списка
 { 
     "error": 0,

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

}

POST /calls/stop Остановка списка обзвона | оповещения
  • id - id списка
 { 
     "error": 0,

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

}

Управление списками
POST /lists/add
DELETE /lists/delete/{id}
GET /lists/export/{id}
POST /lists/import/{id}
GET /lists/list
Источник — https://wiki.connect2ai.net/index.php?title=CLS._Руководство_пользователя&oldid=2964