Osmi
Справочник API

Обратная связь

Список всех фидбэков для агентов

HTTP
GET /feedback/{id} Возвращает все фидбэки для указанного агента.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id (string) — агент ID
Query-параметры (опционально):
chatId (string) — фильтр по агент IDsortOrder (enum) — порядок сортировки фидбэковПо умолчанию: ascВозможные значения: asc, descstartDate (string · date-time) — фильтр «начиная с даты»endDate (string · date-time) — фильтр «до даты»

Коды ответов:

  • 200 — успешная операция (возвращается массив объектов)
  • 500 — внутренняя ошибка сервера
Пример ответа
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "chatflowid": "123e4567-e89b-12d3-a456-426614174000",
    "chatId": "text",
    "messageId": "123e4567-e89b-12d3-a456-426614174000",
    "rating": "THUMBS_UP",
    "content": "text",
    "createdDate": "2025-09-12T00:03:12.350Z"
  }
]

Создать фидбэк сообщения чата

HTTP
GET /feedback/Создаёт новый фидбэк для конкретного агента.
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id (string · uuid) — уникальный идентификатор фидбэка
Query-параметры (опционально):
chatflowid (string · uuid) — идентификатор агентаchatId (string) — идентификатор чатаmessageId (string · uuid) — идентификатор сообщенияrating (enum) — оценка сообщенияВозможные значения: THUMBS_UP, THUMBS_DOWNcontent (string) — текст фидбэкаcreatedDate (string · date-time) — дата и время создания

Коды ответов:

  • 200 — фидбэк успешно создан
  • 400 — некорректные входные данные
  • 500 — внутренняя ошибка сервера
Пример запроса
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chatflowid": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "text",
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "rating": "THUMBS_UP",
  "content": "text",
  "createdDate": "2025-09-12T00:03:12.350Z"
}
Пример ответа
{
    {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "chatflowid": "123e4567-e89b-12d3-a456-426614174000",
    "chatId": "text",
    "messageId": "123e4567-e89b-12d3-a456-426614174000",
    "rating": "THUMBS_UP",
    "content": "text",
    "createdDate": "2025-09-12T00:03:12.350Z"
    }
}

Обновить фидбэк сообщения чата

HTTP
PUT /feedback/{id}Обновляет существующий фидбэк
Авторизация
string required
bearerAuth JWT-токен
Параметры пути
string required
id` (string) — Идентификатор отзыва
Тело запроса (application/json):
id (string · uuid)chatflowid (string · uuid)chatId (string)messageId (string · uuid)rating (enum: THUMBS_UP, THUMBS_DOWN)content (string)createdDate (string · date-time)

Коды ответов:

  • 200 — фидбэк успешно обновлён
  • 400 — некорректные входные данные
  • 404 — фидбэк с указанным ID не найден
  • 500 — внутренняя ошибка сервера
Пример запроса
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chatflowid": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "text",
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "rating": "THUMBS_UP",
  "content": "text",
  "createdDate": "2025-09-12T00:03:12.350Z"
}
Пример ответа
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chatflowid": "123e4567-e89b-12d3-a456-426614174000",
  "chatId": "text",
  "messageId": "123e4567-e89b-12d3-a456-426614174000",
  "rating": "THUMBS_UP",
  "content": "text",
  "createdDate": "2025-09-12T00:03:12.350Z"
}

База документов

Лиды