RES. Руководство пользователя

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

Данный сервис предназначен для сбора статистических данных с сервисов SES, их передачи в Elasticsearch для последующей обработки и последующего перенаправления разработанных в Kibana отчетов в интерфейс UPS.

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

Report engine service (RES) — сервис отчетов.

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

Описание методов API

Запросы осуществляются по протоколу HTTP 1.1 на адрес сервера с доступным сервисом RES. По умолчанию используется порт 6189/tcp.

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

Ответ сервиса представляет собой JSON или текстовый документ в кодировке UTF-8, или двоичный файл.

Содержимое документа зависит от результата выполнения запроса. При наличии ошибки в качестве ответа вернется переменная error=1 и описание в переменной message. Для удобства проверки методов по ссылке http://АДРЕС:6189 будет отображен интерфейс Swagger со всеми методами с возможностью их проверки.

Описание методов API

GET/res/dashboards	Вывод списка отчетов. Метод для использования в UPS
Входные параметры отсутствуют		{  "error": 0,   "message": "success",   "dashboards": {     "Названиа отчета1": "ссылка на отчет1", ...........    "Названиа отчетаN": "ссылка на отчетN",  } }
POST/res/log/upload	Загрузка статистики с сервисов SES. Метод для использования в UPS
date — день, за который требуется загрузить статистику, в формате %Y-%m-%d (например, 2024-11-01).rewrite — перезаписывать индексы (yes/no).		{  "error": 0,   "message": "success"}
GET/res/archive/list	Список диалогов за период.
uuid - id диалога startdate - дата и время начала периода поиска, формат %Y-%m-%d %H:%M enddate - дата и время окончания периода поиска, формат %Y-%m-%d %H:%M phone - телефон позвонившего variable - фильтр по переменной вида variable=value robot - id робота text - текст для фильтрации содержимого диалогов data - элемент данных, который должен содержаться в диалогах channel - канал, который должен содержаться в диалогах		[ { "uuid": "4be3f281-bff0-4199-aa94-cda9225dc4b9", "datetime": "2025-06-02T05:52:31.419766Z", "phone": "73832177052", "channel": [ "web" ], "robot": [ "МФЦ-черновик" ] } ]
GET/res/dialog/{uuid}	Массив с данным всего диалога.
uuid - id диалога		{   "error": 0,   "message": "success",   "dialog": [     {       "id": "a7c853bd-2640-4bc8-b740-7e76fff50b58",       "robot": "МФЦ-черновик",       "channel": "default",       "unknown": false,       "closed": false,       "endpoint": "9040fce6-8524-4741-bc0c-e62f9e45c9cf",       "answered": false,       "models": [         "smc:МФЦ НСК",         "see:Лаврентьевская карта НСО",       ],       "variables": {},       "current": {         "id": "9040fce6-8524-4741-bc0c-e62f9e45c9cf",         "qas": "",         "answered": false,         "category": null,         "nearest": null,         "entry": [           "640bd050-aa0c-4762-ae19-efc26c7cdc76"         ],         "missingRunData": [           null         ],         "waitingRunData": null,         "border": 0       },       "request": {         "datetime": "2025-06-02T07:00:33.771076",         "message": "привет",         "data": [           {             "id": "640bd050-aa0c-4762-ae19-efc26c7cdc76",             "name": "Приветствие",             "model": "МФЦ НСК",             "type": "smc",             "param": "Приветствие",             "reply": {               "class": "Приветствие",               "confidence": 1             },             "rtype": "service"           },           {             "id": "ca5bc776-b3c2-4190-b598-1ddbf686c57a",             "name": "Ответ из модели МФЦ",             "model": "МФЦ НСК",             "type": "smc",             "param": "1",             "reply": {},             "rtype": "service"           }         ]       },       "reply": {         "answers": [           {             "messages": [               "С добрым утром!"             ],             "voice": "Коля",             "interruptible": false,             "file": null           },           {             "messages": [               "Пожалуйста сформулируйте свой вопрос"             ],             "voice": "Коля",             "interruptible": false,             "file": null           }         ],         "datetime": "2025-06-02T07:00:33.874627"       }     }   ] }

Создание отчетов

Раздел в разработке