Дата актуальности: 2026-06-18. Read-only документация.
Справочник REST-эндпоинтов, экспонируемых роутами smarty-backend-stable/smarty-helpdesk/routes/index.js.
Все маршруты подключены под префиксом /api/v2/ws/:_wsId/hd. Полный путь:
/api/v2/ws/:_wsId/hd + path createRoute
| Класс запроса |
Описание |
EmployeeRequest |
Авторизованный сотрудник workspace. |
Хелпдеск на собственных сущностях: тикеты, статусы, SLA, каналы, сообщения, макросы, категории, группы/очереди, база знаний. Ничего не трогает в CRM; тикет может только ссылаться на контакт по ID.
Базовый путь: /api/v2/ws/:_wsId/hd
| Метод |
Путь |
Auth |
Назначение |
GET |
/config |
Employee |
Получение полной конфигурации (статусы, категории, группы, SLA-политики, макросы). При первом запросе -- seed дефолтов. |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
GET |
/tickets |
Employee |
Список тикетов |
query: view (enum: mine, unassigned, overdue, open), status, priority, assignee, channel, group, q (поиск), limit, skip |
POST |
/tickets |
Employee |
Создание тикета |
body: subject (required), priority, channel, requester ({ name, email, phone, _contactId }), categoryId, groupId, assigneeId, message |
GET |
/tickets/:ticketId |
Employee |
Тикет + сообщения |
-- |
PATCH |
/tickets/:ticketId |
Employee |
Обновление тикета |
body: subject, priority, channel, _statusId, _categoryId, _groupId, _assigneeId, satisfaction, tags[], requester |
DELETE |
/tickets/:ticketId |
Employee |
Удаление тикета (мягкое) |
-- |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
POST |
/tickets/:ticketId/messages |
Employee |
Добавить сообщение |
body: body (required), internal (Boolean) |
Примечание: первый публичный ответ агента фиксирует SLA first-response.
| Метод |
Путь |
Auth |
Назначение |
GET |
/dashboard |
Employee |
Метрики за 30 дней: open, overdue, avgFirstResponse, avgResolution, CSAT, раскладка по статусам и агентам |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
POST |
/categories |
Admin |
Создать категорию |
body: name (required), color |
PATCH |
/categories/:id |
Admin |
Обновить категорию |
body: name, color |
DELETE |
/categories/:id |
Admin |
Удалить категорию |
-- |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
POST |
/groups |
Admin |
Создать группу |
body: name (required), _memberIds[] |
PATCH |
/groups/:id |
Admin |
Обновить группу |
body: name, _memberIds[] |
DELETE |
/groups/:id |
Admin |
Удалить группу |
-- |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
POST |
/macros |
Admin |
Создать макрос |
body: name (required), body, setStatusId, setPriority |
PATCH |
/macros/:id |
Admin |
Обновить макрос |
body: name, body, setStatusId, setPriority |
DELETE |
/macros/:id |
Admin |
Удалить макрос |
-- |
| Метод |
Путь |
Auth |
Назначение |
Параметры |
GET |
/kb/articles |
Employee |
Список статей |
query: category, status, q (поиск) |
POST |
/kb/articles |
Employee |
Создать статью |
body: title (required), body, status, categoryId |
GET |
/kb/articles/:id |
Employee |
Статья (с инкрементом просмотров) |
-- |
PATCH |
/kb/articles/:id |
Employee |
Обновить статью |
body: title, body, status, categoryId |
DELETE |
/kb/articles/:id |
Employee |
Удалить статью |
-- |
POST |
/kb/articles/:id/helpful |
Employee |
Оценка статьи |
body: value (enum: yes, иначе no) |