Дата актуальности: 2026-06-17. Read-only документация.
Справочник REST-эндпоинтов, экспонируемых роутами smarty-backend-stable/smarty-admin/routes/.
Все маршруты подключены под префиксом /api/v2/admin ( ${config.rest.api}/admin ). Полный путь эндпоинта:
/api/v2/admin + basePath роутера + path createRoute
Админ-панель использует собственную модель авторизации через Section*-хендлеры. Каждый хендлер проверяет наличие соответствующего раздела в systemAdministratorRights пользователя. Доступные секции:
| Секция |
Отвечает за |
SectionUsers |
Управление пользователями |
SectionWorkspaces |
Управление рабочими пространствами |
SectionRates |
Тарифы и платежи |
SectionPromoCodes |
Промокоды |
SectionNews |
Новости |
SectionWebinars |
Вебинары |
SectionFlowTemplates |
Шаблоны ботов и flows |
SectionChatsDate |
Управление датами чатов |
SectionLocalize |
Кастомная локализация |
SectionAny |
Любой раздел (главная страница) |
Большинство маршрутов возвращают HTML-страницы (.answer('render', '<template>')) с серверным рендерингом. Некоторые маршруты возвращают JSON (.answer('regular', {})) или делают redirect (.answer('redirect')).
Базовый путь: /api/v2/admin/users
Секция: SectionUsers
| Метод |
Путь |
Назначение |
GET |
/ |
Список пользователей (HTML) |
POST |
/refresh |
Отправка RefreshPage всем клиентам (redirect) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id |
Профиль пользователя (HTML) |
-- |
POST |
/:_id |
Обновление профиля |
body: поля User |
GET |
/:_id/login |
Fake-вход от имени пользователя (redirect) |
-- |
GET |
/:_id/delete |
Пометка как удалённый (redirect) |
-- |
POST |
/:_id/delete |
Удаление пользователя (событие deleteUser) |
body: причина |
GET |
/:_id/devices |
Список устройств пользователя (HTML) |
-- |
GET |
/:_id/ws |
Список workspace пользователя (HTML) |
-- |
GET |
/:_id/reset_loginPerDay |
Сброс счётчика входов (redirect) |
-- |
POST |
/:_id/confirmPhone |
Подтверждение телефона |
body: phoneConfirmedStatus |
POST |
/:_id/blockUnblock |
Блокировка/разблокировка |
body: blockStatus (true/false), blockReason |
POST |
/:_id/system_administrator |
Назначение прав системного администратора |
body: ключи прав |
POST |
/:_id/password |
Смена пароля |
body: password |
POST |
/:_id/oneoffpassword |
Установка одноразового пароля |
body: oneoffpassword |
Базовый путь: /api/v2/admin/ws
Секция: SectionWorkspaces
| Метод |
Путь |
Назначение |
GET |
/ |
Список рабочих пространств (HTML) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id |
Карточка workspace (вкладка "Инфо", HTML) |
-- |
POST |
/:_id |
Обновление комментария/валюты |
body: comment, currency |
GET |
/:_id/balance |
Вкладка "Баланс" (HTML) |
-- |
GET |
/:_id/rate |
Вкладка "Тариф" (HTML) |
-- |
| Метод |
Путь |
Назначение |
Параметры |
POST |
/:_id/individual |
Установка индивидуального тарифа |
body: customCost, isFreeBots |
POST |
/:_id/balanceAdd |
Пополнение баланса |
body: money, provided, comment |
GET |
/:_id/balanceHistory/:type |
История баланса (HTML) |
path: type (payed/rebill) |
POST |
/:_id/rate |
Смена тарифа или установка квот |
body: newRate или поля квот |
POST |
/:_id/rate-features |
Установка кастомных фич |
body: ключи фич (true/false/undefined) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id/employees |
Список сотрудников workspace (HTML) |
-- |
POST |
/:_id/employees/:employeeId/admin |
Назначение/снятие админских прав |
query: isAdmin (true/false), remove_messages (true/false) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id/dialogs |
Список диалогов workspace (HTML) |
-- |
GET |
/:_id/dialogs/:confId/tokens |
Токены диалога (HTML) |
-- |
POST |
/:_id/dialogs/:confId/tokens |
Создание токена |
query: newToken |
POST |
/:_id/dialogs/:confId/tokens/:tokenValue |
Обновление описания токена |
body: description |
GET |
/:_id/dialogs/:confId/tokens/:tokenValue/delete |
Удаление токена (redirect) |
-- |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id/consultant-traces |
Трассировки системного AI-консультанта (HTML) |
query: traceId, q |
Примечание: консультант -- системный бот, его трассировки не отображаются в workspace UI.
| Метод |
Путь |
Назначение |
Параметры |
POST |
/:_id/features |
Включение/выключение фич |
body: toggleSmartyBot, testWs, isSipEnabled |
POST |
/:_id/comment |
Обновление комментария |
body: comment |
| Метод |
Путь |
Назначение |
Параметры |
POST |
/:_id/orders/:orderId/provided |
Отметка заказа как "предоставленный" |
body: provided (true/false) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id/access_rights |
Список прав доступа (HTML) |
query: profileId, profileType |
POST |
/:_id/access_rights/:_rightId/features |
Включение/выключение фич права |
query: key (requisitions/bot_chat/bot_manage), action (on/off) |
Базовый путь: /api/v2/admin/ws/:_wsId/bot
Секция: SubWsHandler (подмодуль workspace)
| Метод |
Путь |
Назначение |
GET |
/ |
Список ботов workspace (HTML) |
POST |
/errors |
Показ/скрытие ошибок в чате |
body: action (show/hide) |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Форма редактирования бота (HTML) |
POST |
/:_id |
Обновление бота |
GET |
/:_id/qr |
QR-код ссылки бота (image/png) |
GET |
/:_id/delete |
Удаление бота (redirect) |
GET |
/:_id/sync |
Синхронизация бота (redirect) |
POST |
/:_id/:operation |
Блокировка/разблокировка бота |
path: operation (block/unblock) |
GET |
/:_id/users |
Пользователи бота (HTML) |
POST |
/:_id/user/:userId |
Управление пользователем бота |
body: action (start/stop/block/unblock) |
GET |
/:_id/series |
Серии рассылок бота (HTML) |
GET |
/:_id/series/:seriesId/stop |
Остановка серии (redirect) |
GET |
/:_id/series/:seriesId/users |
Пользователи серии (HTML) |
query: list (usersTarget/usersReceived/usersReceivedAll/usersUnsubscribed/usersError) |
Базовый путь: /api/v2/admin/ws/:_wsId/bot-flow
Секция: SubWsHandler
| Метод |
Путь |
Назначение |
POST |
/new |
Создание нового flow |
POST |
/create-from-template |
Создание flow из шаблона (body: _flowTplId) |
POST |
/create-from-template/json |
Создание flow из JSON-файла (multipart) |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Форма редактирования flow (HTML) |
POST |
/:_id |
Обновление flow |
GET |
/:_id/delete |
Удаление flow (redirect) |
GET |
/:_id/convert-to-template |
Конвертация flow в шаблон (HTML) |
GET |
/:_id/convert-to-template/json |
Экспорт flow в JSON |
GET |
/:_id/texts |
Тексты flow (HTML) |
POST |
/:_id/texts |
Обновление текстов flow |
Базовый путь: /api/v2/admin/ws/:_wsId/applications
Секция: SubWsHandler
| Метод |
Путь |
Назначение |
GET |
/ |
Список API-приложений workspace (HTML) |
| Метод |
Путь |
Назначение |
Параметры |
GET |
/:_id |
Форма редактирования (HTML) |
-- |
POST |
/:_id |
Обновление приложения |
body: rightsAccess[], isBlocked, allowCreateOverRate, allowCreateFromCustomProfile |
GET |
/:_id/delete |
Удаление приложения (redirect) |
-- |
POST |
/:_id/avatar |
Загрузка аватара (multipart) |
multipart: файл изображения |
GET |
/:_id/refresh |
Обновление соли (перегенерация API-ключа, redirect) |
-- |
Базовый путь: /api/v2/admin/ws/:_wsId/sip-accounts
Секция: SubWsHandler
| Метод |
Путь |
Назначение |
GET |
/ |
Список SIP-аккаунтов workspace (HTML) |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Форма редактирования (HTML) |
POST |
/:_id |
Обновление аккаунта |
GET |
/:_id/delete |
Удаление аккаунта (redirect) |
GET |
/:_id/employees |
Привязка сотрудников к номерам (HTML) |
POST |
/:_id/employees/actualize |
Синхронизация номеров с провайдером |
POST |
/:_id/employees/bind |
Привязка сотрудника к номеру |
body: _employeeId, _bindId |
Базовый путь: /api/v2/admin/ws/:_wsId/
| Метод |
Путь |
Назначение |
GET |
/tags |
Список тегов (кастомных списков) workspace (HTML) |
GET |
/tagGroups |
Список групп тегов workspace (HTML) |
Базовый путь: /api/v2/admin/ws/:_wsId/floweditor
Примечание: подключает роутер smarty-ext-messenger/routes/flow + вспомогательные роутеры (files, employees, requisitions/groups). Предоставляет визуальный редактор flow-алгоритмов ботов.
Базовый путь: /api/v2/admin/pay-history
Секция: SectionRates
| Метод |
Путь |
Назначение |
Параметры |
GET |
/ |
История платежей (HTML) |
query: page, filter[date_start], filter[date_end], filter[email], filter[search], filter[all], filter[platforms][] |
Фильтры:
date_start / date_end -- период (по умолчанию: текущая неделя).email -- поиск по email автора заказа.search -- поиск по названию workspace или wsIndex.all -- показать все платежи (игнорировать период).platforms[] -- фильтр по платформам.
Пагинация: 50 записей на страницу.
Базовый путь: /api/v2/admin/promoCode
Секция: SectionPromoCodes
| Метод |
Путь |
Назначение |
GET |
/ |
Список промокодов (HTML) |
GET |
/new |
Форма создания промокода (HTML) |
POST |
/new |
Создание промокода |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Форма редактирования (HTML) |
POST |
/:_id |
Обновление промокода |
GET |
/:_id/delete |
Удаление промокода (redirect) |
GET |
/:_id/statistic |
Статистика использования (HTML) |
Базовый путь: /api/v2/admin/news
Секция: SectionNews
| Метод |
Путь |
Назначение |
Параметры |
GET |
/ |
Redirect на /sended |
-- |
GET |
/:listType |
Список новостей по типу (HTML) |
path: listType (draft/planned/sended) |
| Метод |
Путь |
Назначение |
GET |
/new |
Форма создания (HTML) |
POST |
/new |
Создание новости |
GET |
/:_id |
Форма редактирования (HTML) |
POST |
/:_id |
Обновление новости |
| Метод |
Путь |
Назначение |
GET |
/:_id/delete |
Удаление (redirect) |
GET |
/:_id/copy |
Копирование (redirect) |
GET |
/:_id/publish |
Публикация (redirect) |
GET |
/:_id/unpublish |
Снятие с публикации (redirect) |
POST |
/files |
Загрузка файла (multipart) |
Базовый путь: /api/v2/admin/webinar
Секция: SectionWebinars
| Метод |
Путь |
Назначение |
GET |
/ |
Список вебинаров (HTML) |
GET |
/participants |
Все участники вебинаров (HTML) |
GET |
/new |
Форма создания (HTML) |
POST |
/new |
Создание вебинара |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Форма редактирования (HTML) |
POST |
/:_id |
Обновление вебинара |
GET |
/:_id/delete |
Удаление (redirect) |
GET |
/:_id/participants |
Участники вебинара (HTML) |
Фильтры участников: query: filter[email], filter[phone].
Базовый путь: /api/v2/admin/changeRateWindow
Секция: SectionWorkspaces
| Метод |
Путь |
Назначение |
GET |
/ |
Статистика окна смены тарифа (HTML) |
Возвращает: { list: { window_shown, window_closed, rate_changed } } -- количество workspace по действиям в окне.
Базовый путь: /api/v2/admin/chatsDate
Секция: SectionChatsDate
| Метод |
Путь |
Назначение |
Параметры |
GET |
/ |
Форма сдвига дат (HTML) |
-- |
POST |
/ |
Сдвиг дат создания диалога/чата |
body: dateChat (дата), url (URL диалога или extchata) |
Примечание: сдвигает _createdOn, _updatedOn, lastMessageDate у конфигурации, сообщений и участников. URL должен содержать dialogs/<id> или extchats/<id>.
Базовый путь: /api/v2/admin/customLocalize
Секция: SectionLocalize
| Метод |
Путь |
Назначение |
GET |
/default |
Список дефолтных ключей локализации (HTML) |
POST |
/default |
Обновление/создание дефолтных ключей |
POST |
/default/copy |
Импорт кастомных локалей (redirect) |
| Метод |
Путь |
Назначение |
GET |
/:_wsId |
Ключи локализации workspace (HTML) |
POST |
/:_wsId |
Обновление/создание ключей workspace |
POST |
/:_wsId/copy |
Копирование дефолтных ключей в workspace (redirect) |
GET |
/:_wsId/copyFrom |
Форма копирования из другого workspace (redirect) |
POST |
/:_wsId/copyFrom |
Копирование из другого workspace |
body: srcWsId |
GET |
/:_wsId/:_id/delete |
Удаление ключа (redirect) |
Базовый путь: /api/v2/admin/flow-tpl
Секция: SectionFlowTemplates
| Метод |
Путь |
Назначение |
GET |
/list |
Список шаблонов (HTML) |
POST |
/new |
Создание шаблона (redirect) |
| Метод |
Путь |
Назначение |
GET |
/:_id |
Данные шаблона (JSON) |
PATCH |
/:_id |
Обновление шаблона |
GET |
/:_id/edit |
Форма редактирования (HTML) |
GET |
/:_id/delete |
Удаление (redirect) |
POST |
/:_id/publish |
Публикация/снятие (redirect) |
| Метод |
Путь |
Назначение |
GET |
/:_id/blocks |
Список блоков (JSON) |
POST |
/:_id/blocks |
Добавление блока |
GET |
/:_id/blocks/:blockId |
Блок (JSON) |
PATCH |
/:_id/blocks/:blockId |
Обновление блока |
DELETE |
/:_id/blocks/:blockId |
Удаление блока |
| Метод |
Путь |
Назначение |
GET |
/:_id/texts |
Тексты шаблона (HTML) |
POST |
/:_id/texts |
Обновление текстов |
Каждый вложенный ресурс имеет стандартные GET (список/элемент), POST (создание), PATCH (обновление), DELETE (удаление).
| Путь |
Модель |
Назначение |
/:_id/flowtexts/ |
ExtFlowTextTemplate |
Тексты |
/:_id/flowfields/ |
ExtFlowFieldTemplate |
Поля |
/:_id/flowcommands/ |
ExtFlowCommandTemplate |
Команды |
/:_id/extlists/ |
ExtFlowListTemplate |
Списки |
/:_id/extlistgroups/ |
ExtFlowListGroupTemplate |
Группы списков |
Базовый путь: /api/v2/admin/all-bots
Секция: SectionFlowTemplates
| Метод |
Путь |
Назначение |
GET |
/ |
Список всех ботов (ExtChatBot) (HTML) |
Базовый путь: /api/v2/admin/bots
Секция: SectionFlowTemplates
| Метод |
Путь |
Назначение |
GET |
/stats |
Статистика блокировок ботов (HTML) |
GET |
/stats-ws |
Статистика блокировок по workspace (HTML) |
Статистика включает: историю блокировок, количество ботов/заблокированных по workspace, причины блокировок.
| Область |
Причина |
| Подробные схемы body для POST-запросов |
Зависят от конкретных моделей; в админке преобладает серверный рендеринг форм |
Редактор flows (/floweditor) |
Подключает внешний роутер smarty-ext-messenger/routes/flow; документируется отдельно |
Внутренние обработчики (handlers/, lib/restifyHandlers.js) |
Серверная логика, не API |