Перейти к основному содержимому

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

Все эндпоинты API имеют префикс /api/ и требуют аутентификации через сессионный cookie. Все запросы и ответы используют Content-Type: application/json.


Беседы

ЭндпоинтМетодОписание
/api/conversationsGETСписок бесед (фильтры: status, channel_type, tag, search, page)
/api/conversations/{id}GETПолучить беседу (сбрасывает unread_count)
/api/conversationsPOSTСоздать беседу
/api/conversations/{id}/statusPOSTОбновить статус
/api/conversations/{id}/tagsPOSTДобавить тег
/api/conversations/{id}/tags/{tag}DELETEУдалить тег
/api/conversations/{id}/assignPOSTНазначить агента

Сообщения

ЭндпоинтМетодОписание
/api/conversations/{id}/messagesGETСписок сообщений
/api/conversations/{id}/messagesPOSTОтправить сообщение

Предложение ИИ

ЭндпоинтМетодОписание
/api/ai-suggest?conversation_id={id}GETПолучить предложение ответа ИИ

Контакты

ЭндпоинтМетодОписание
/api/contactsGETСписок контактов
/api/contacts/{id}GETПолучить контакт
/api/contactsPOSTСоздать контакт
/api/contacts/{id}PATCHОбновить контакт
/api/contacts/{id}DELETEУдалить контакт (админ)

Каналы (только админ)

ЭндпоинтМетодОписание
/api/channelsGETСписок каналов
/api/channelsPOSTСоздать канал
/api/channels/{id}PATCHОбновить канал
/api/channels/{id}DELETEУдалить канал

Автоматизации (только админ)

ЭндпоинтМетодОписание
/api/automationsGETСписок автоматизаций
/api/automationsPOSTСоздать автоматизацию
/api/automations/{id}/togglePOSTПереключить активность
/api/automations/{id}DELETEУдалить автоматизацию

Аналитика

ЭндпоинтМетодОписание
/api/analytics?days=30GETПолучить данные аналитики

Агенты (только админ)

ЭндпоинтМетодОписание
/api/agentsGETСписок агентов
/api/agentsPOSTСоздать агента
/api/agents/{id}/rolePOSTОбновить роль
/api/agents/{id}DELETEУдалить агента

Настройки

ЭндпоинтМетодОписание
/api/settings/workspaceGETПолучить настройки рабочего пространства
/api/settings/workspacePOSTОбновить рабочее пространство (админ)
/api/settings/passwordPOSTИзменить пароль

Формат ошибок

{"error": "Human-readable error message"}
КодЗначение
200Успех
201Создано
400Неверный запрос
401Не аутентифицирован
403Запрещено
404Не найдено
409Конфликт
500Внутренняя ошибка