Действия

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

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

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


<small><code>  "limits": {</code></small>
<small><code>  "limits": {</code> - лимиты для вызова</small>


<small><code>    "no_answer_timeout": 10,</code></small>
<small><code>    "no_answer_timeout": 10,</code></small>
Строка 130: Строка 130:
<small><code>  "timeintervals": [</code></small>
<small><code>  "timeintervals": [</code></small>


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


<small><code>  ],</code></small>
<small><code>  ],</code></small>


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


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


<small><code>    "robot_id": "",</code></small>
<small><code>    "robot_id": "",</code></small>
Строка 144: Строка 144:
<small><code>  },</code></small>
<small><code>  },</code></small>


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


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


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


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


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


<small><code>  ],</code></small>
<small><code>  ],</code></small>
Строка 160: Строка 160:
<small><code>    {</code></small>
<small><code>    {</code></small>


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


<small><code>        "6000"</code></small>
<small><code>        "6000"</code></small>
Строка 166: Строка 166:
<small><code>      ],</code></small>
<small><code>      ],</code></small>


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


<small><code>    }</code></small>
<small><code>    }</code></small>

Версия от 15:44, 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 Добавление нового списка для обзвона | оповещения
{

  "name": "Test Call List", - имя списка

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

  "limits": { - лимиты для вызова

    "no_answer_timeout": 10,

    "dial_tries": 1,

    "max_channels": 2,

    "redial_timeout": 600,

    "watchdog": 240

  },

  "dialed": 0,

  "timeintervals": [

    "default" - id временного интервала

  ],

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

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

    "robot_id": "",

    "endpoint": ""

  },

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

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

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

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

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

  ],

  "items": [

    {

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

        "6000"

      ],

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

    }

  ]

}

DELETE /lists/delete/{id} Удаление существующего списка для обзвона | оповещения
GET /lists/export/{id} Экспорт списка для обзвона | оповещения в CSV файл
POST /lists/import/{id} Экспорт списка для обзвона | оповещения из CSV файла
GET /lists/list Получения всех списков для обзвона | оповещения из БД
POST /lists/load/{id} Дозагрузка в существующую инстанцию списка обзвона | оповещения элементов из скрипта
PUT /lists/modify/{id} Изменение существующего списка для обзвона | оповещения
GET /lists/status/{id} Получение статуса существующего списка для обзвона | оповещения
Управление инстанциями обзвона | оповещения
Источник — https://wiki.connect2ai.net/index.php?title=CLS._Руководство_пользователя&oldid=2970