|
|
| Строка 1: |
Строка 1: |
| CLS. Руководство пользователя | | CLS. Руководство администратора |
| | |
| ===== '''Общее описание''' =====
| |
| | |
| | |
| ===== '''Термины и определения''' =====
| |
| Сервис Call List Service (CLS) – сервис обзвона списков
| |
| | |
| Swagger UI – интерактивная веб-консоль с кратким описанием методов API и возможностью выполнять запросы к сервису CLS.
| |
| | |
| | |
| | |
| ===== '''Описание методов API BSS''' =====
| |
| Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом CLS. По умолчанию используется порт 6188/tcp.
| |
| | |
| Авторизация запросов не требуется. HTTP-запросы должны иметь заголовок <code>"accept: application/json"</code>
| |
| | |
| | |
| {| class="wikitable" style="width: 110%"
| |
| |+'''''Описание методов API'''''
| |
| ! style="color:green;width: 15%" |'''POST/bss/backup/{ip}'''
| |
| ! colspan="3" style="width: 85%" |<small>Принудительный бэкап сервера. На выходе id задания или сообщение об ошибке</small>
| |
| |-
| |
| | colspan="2" style="width: 50%" |
| |
| * <small>'''ip''' - ip адрес сервера данные с которого будут сохранены. IP адрес и каталоги с данными должны быть в конфиге</small>
| |
| | colspan="2" style="width: 50%" |<small>{ "task_id": "73c8b134-4883-445c-ba9d-3058962bda43" }</small>
| |
| |-
| |
| ! style="color:green;width: 15%" |'''POST/bss/config'''
| |
| ! colspan="3" style="width: 85%" |<small>Обновить конфигурацию. Установит новый конфиг и заставит сервис его перечитать.</small>
| |
| |-
| |
| | colspan="2" style="width: 50%" |<small>config - json новой конфигурации, структура как у config.json</small>
| |
| | colspan="2" style="width: 50%" |<small>{ "message": "Configuration updated and reload requested" }</small>
| |
| |-
| |
| ! style="color:blue;width: 15%" |'''GET/bss/config'''
| |
| ! colspan="3" style="width: 85%" |<small>Получить текущую конфигурацию</small>
| |
| |-
| |
| | colspan="2" style="width: 50%" |<small>Нет параметров</small>
| |
| | colspan="2" style="width: 50%" |<small>Содержимое файла cjnfig.json</small>
| |
| |-
| |
| ! style="color:blue;width: 15%" |'''GET/bss/tasks'''
| |
| ! colspan="3" style="width: 85%" |<small>Получить список всех заданий и их результатов за последние два дня</small>
| |
| |-
| |
| | colspan="2" style="width: 50%" |<small>Нет параметров</small>
| |
| | colspan="2" style="width: 50%" |<small>Список словарей заданий. в каждом элементы:</small>
| |
| <small>task_id, ip_address, status, result, timestamp</small>
| |
| |}
| |