Описание Operator API
/categories/get_category
POST
Summary:
getCategory
Description:
Получение категории
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.CategoryGetInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.CategoryOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/categories/query_categories_by_project
POST
Summary:
queryCategoriesByProject
Description:
Получение категорий по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.CategoryQueryInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.CategoriesOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/categories/query_tree_by_project
POST
Summary:
queryCategoryTreeByProject
Description:
Получение дерева категорий по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.CategoryQueryInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.CategoriesOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/create_chat
POST
Summary:
createChat
Description:
Создание чата
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatCreateInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/get_chat
POST
Summary:
getChat
Description:
Получение чата
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/open
POST
Summary:
openSystemChatWithBot
Description:
Открыть системный чат с ботом
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatCreateInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/open_ticket
POST
Summary:
openChatTicket
Description:
Открытие чата обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/query_chats_by_client
POST
Summary:
queryChatsByClient
Description:
Получение чатов по клиенту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatQueryClientInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/search_chats_by_clients
POST
Summary:
searchChatsByClients
Description:
Получение чатов по клиентам
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatQueryInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/chats/send_message_to_company
POST
Summary:
sendMessageToCompany
Description:
Отправить сообщение компании
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ChatSendCompanyInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ChatSendCompanyOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/client_comments/create
POST
Summary:
createClientComment
Description:
Создание комментария клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientCommentInputRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/client_comments/delete
POST
Summary:
deleteClientComment
Description:
Удаление комментария клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientCommentCommentIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/client_comments/get_by_client_id
POST
Summary:
getCommentsForClient
Description:
Получение комментариев клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientCommentClientIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.ClientComment ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/client_comments/update
POST
Summary:
updateClientComment
Description:
Обновление комментария клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientCommentUpdateInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/ban
POST
Summary:
banClient
Description:
Заблокировать клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientBanInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Client |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/connect
POST
Summary:
connectClient
Description:
Соединение клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientConnectInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/disconnect
POST
Summary:
disconnectClient
Description:
Отсоединение клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/get_client
POST
Summary:
getClient
Description:
Получение клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientIdInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/mark
POST
Summary:
markClient
Description:
Маркировать клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientMarkInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ClientOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/unban
POST
Summary:
unbanClient
Description:
Разблокировать клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientBanInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Client |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/clients/update_banned_client
POST
Summary:
updateBannedClient
Description:
Обновить заблокированного клиента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ClientBanInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Client |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/files/get/{fileId}
GET
Summary:
files_get
Description:
Получение файла по Id
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.File |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/files/image/{fileId}
GET
Summary:
files_image
Description:
Получение файла изображения по Id
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.File |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/files/meta
POST
Summary:
files_meta
Description:
Получение мета файлов
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.FileIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.FileOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/files/upload
POST
Summary:
files_upload
Description:
Загрузка файлов
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.FileUploadInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.FileOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/files/upload_to_client
POST
Summary:
files_uploadToClient
Description:
Загрузка файлов клиенту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.FileUploadInput |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.FileOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/get_inbox_by_user
POST
Summary:
inboxes_getInboxByUser
Description:
Получение входящих по пользователю
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InputOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/get_my_inbox
POST
Summary:
inboxes_getMyInbox
Description:
Получение входящих по авторизованному пользователю
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InputOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/get_thread
POST
Summary:
inboxes_getThread
Description:
Получение входящих по Id thread
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.InboxGetThreadRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/mark_thread_as_read
POST
Summary:
inboxes_markThreadAsRead
Description:
Пометить входящие как прочитанные
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.InboxGetThreadRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/mark_thread_by_ticket_as_read
POST
Summary:
inboxes_markThreadByTicketAsRead
Description:
Пометить входящее обращение как прочитанное
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/query_my_threads
POST
Summary:
inboxes_queryMyThreads
Description:
Получение входящих обращений по авторизованному пользователю
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.InboxQueryMyRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/inboxes/query_threads_by_user
POST
Summary:
inboxes_queryThreadsByUser
Description:
Получение входящих обращений по пользователю
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.InboxQueryThreadsByUserRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/create
POST
Summary:
createMarker
Description:
Создание маркера
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.MarkerCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Marker |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/create_tag
POST
Summary:
createTag
Description:
Создание тега
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.MarkerTagRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Tag |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/delete_tag
POST
Summary:
deleteTag
Description:
Удаление тега
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.MarkerTagIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Tag |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/get_by_project
POST
Summary:
getByProject
Description:
Получение маркеров по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Marker |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/get_tags
POST
Summary:
getTags
Description:
Получение всех тегов в сегменте
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.Tag ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/query_tags
POST
Summary:
queryTags
Description:
Получение тегов
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.MarkerTagQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.Tag ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/markers/update
POST
Summary:
updateMarker
Description:
Обновление маркера
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.MarkerUpdateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.Marker |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/notifications/get_my_notification_inbox
POST
Summary:
getMyNotificationInbox
Description:
Получение входящих уведомлений текущего авторизованного пользователя
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.NotificationsInboxOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/notifications/query_my_notifications
POST
Summary:
queryMyNotifications
Description:
Получение уведомлений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.NotificationsRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.NotificationsOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/projects/get_display_options
POST
Summary:
projects_getDisplayOptions
Description:
Получение настроек отображения cегмента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ProjectDisplayOptionsGetOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/projects/get_options
POST
Summary:
projects_getOptions
Description:
Получение настроек cегмента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ProjectOptionsGetOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/projects/get_project
POST
Summary:
projects_getProject
Description:
Получение cегмента
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ProjectOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/projects/query_my_projects
POST
Summary:
projects_queryMyProjects
Description:
Получение сегментов текущего авторизованного пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ProjectList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/projects/query_projects
POST
Summary:
projects_queryProjects
Description:
Получение сегментов
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.ProjectQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.ProjectList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/create_personal_reply
POST
Summary:
createQuickreplyPersonal
Description:
Создание персонального быстрого ответа
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyPersonalCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickReplyOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/create_reply
POST
Summary:
createQuickreply
Description:
Создание быстрого ответа
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickReplyOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/get_folder
POST
Summary:
getQuickreplyFolder
Description:
Получение папки с быстрыми ответами
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyFolderGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickReplyFolderOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/query_folders_by_project
POST
Summary:
queryQuickreplyFoldersByProject
Description:
Получение папок с быстрыми ответами по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyFoldersQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickReplyFoldersOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/query_project_tree
POST
Summary:
queryQuickrepliesProjectTree
Description:
Получение дерева папок с быстрыми ответами
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyFolderTreeRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.QuickReplyFolder ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/query_replies_by_folder
POST
Summary:
queryQuickrepliesByFolder
Description:
Получение быстрых ответов по папке
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickRepliesQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickRepliesOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/query_replies_by_project
POST
Summary:
queryQuickRepliesByProject
Description:
Получение быстрых ответов по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyQueryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickRepliesOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/quickreplies/update_reply
POST
Summary:
updateQuickreply
Description:
Обновление быстрого ответа
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.QuickReplyUpdateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.QuickReplyOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/me
GET
Summary:
streamMe
Description:
Получение текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/my_inbox
GET
Summary:
streamMyInbox
Description:
Получение входящих текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InputOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/my_inbox_notifications
GET
Summary:
streamMyInboxNotifications
Description:
Получение входящих пушей текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxNotificationsOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/my_inbox_threads
GET
Summary:
streamMyInboxThreads
Description:
Получение входящих обращений текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.InboxThreadOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/my_notification_inbox
GET
Summary:
streamMyNotificationInbox
Description:
Получение входящих уведомлений текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.NotificationsInboxOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/my_notifications
GET
Summary:
streamMyNotifications
Description:
Получение уведомлений об отклонениях текущего авторизованного пользователя с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.NotificationsOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/ticket/{ticketId}
GET
Summary:
streamTicket
Description:
Получение обращения с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketStreamOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/tickets\_by\_channel/{channelId}
GET
Summary:
streamTicketsByChannel
Description:
Получение обращений по каналу с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/tickets\_by\_client/{clientId}
GET
Summary:
streamTicketsByClient
Description:
Получение обращений по клиентам с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/stream/tickets\_by\_project/{projectId}
GET
Summary:
streamTicketsByProject
Description:
Получение обращений с помощью WebSocket
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/ticket_comments/create
POST
Summary:
createTicketComment
Description:
Создание комментария обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCommentCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/ticket_comments/delete
POST
Summary:
deleteTicketComment
Description:
Удаление комментария обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCommentDeleteRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/ticket_comments/get_by_client_id
POST
Summary:
getTicketCommentsByClient
Description:
Получение комментариев обращения по клиенту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCommentClientRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.TicketComment ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/ticket_comments/get_by_ticket_id
POST
Summary:
getCommentsForTicket
Description:
Получение комментариев по обращению
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCommentGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.TicketComment ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/ticket_comments/update
POST
Summary:
updateTicketComment
Description:
Обновление комментария обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCommentUpdateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketComment |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/assign_ticket
POST
Summary:
assignTicket
Description:
Назначить обращение на пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketAssignSeveralRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/assign_ticket_to_group
POST
Summary:
assignTicketToGroup
Description:
Назначить обращение на группу распределения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketAssignToGroupRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/ban_several_client_tickets
POST
Summary:
banSeveralClientTickets
Description:
Заблокировать несколько клиентов по обращениям
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketBanRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/ban_ticket
POST
Summary:
banTicket
Description:
Заблокировать обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketBanRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/change_priority
POST
Summary:
changeTicketPriority
Description:
Изменить приоритет обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketPriorityChangeRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/close_several_tickets
POST
Summary:
closeSeveralTickets
Description:
Закрыть несколько обращений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCloseSeveralRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/close_ticket
POST
Summary:
closeTicket
Description:
Закрыть обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCloseRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/create_message
POST
Summary:
createTicketMessage
Description:
Создать сообщение обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessageCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMessageOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/create_product_message
POST
Summary:
createTicketProductMessage
Description:
Создать сообщение услуги в обращении
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketProductMessageCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMessageOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/create_ticket
POST
Summary:
createTicket
Description:
Создать обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketCreateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/delete_messages
POST
Summary:
deleteMessages
Description:
Удаление сообщений обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessagesDeleteRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.TicketMessage ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/delete_ticket_tag
POST
Summary:
deleteTicketTag
Description:
Убрать тег у обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketSetTagRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/from_client
POST
Summary:
requestClientInfo
Description:
Запросить информацию о клиенте
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/get_message
POST
Summary:
getTicketMessage
Description:
Получение сообщения обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessageIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMessageOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/get_messages_by_text
POST
Summary:
getTicketMessagesByText
Description:
Получение сообщений обращения по тексту сообщения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessagesGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMessageList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/get_previous_ticket
POST
Summary:
getPreviousTicket
Description:
Получение предыдущего обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketPreviousRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/get_ticket
POST
Summary:
getTicket
Description:
Получение обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/invite_to_ticket
POST
Summary:
inviteToTicket
Description:
Пригласить оператора в обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketInviteRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMemberOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/join_ticket
POST
Summary:
joinTicket
Description:
Присоединиться к обращению
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMemberOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/kick_from_ticket
POST
Summary:
kickFromTicket
Description:
Выгнать оператора из обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketKickRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMemberOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/leave_ticket
POST
Summary:
leaveTicket
Description:
Выйти из обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMemberOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/list_tickets_by_channel
POST
Summary:
listTicketsByChannel
Description:
Получение обращений по каналу
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketQueryChannelRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/list_tickets_by_client
POST
Summary:
listTicketsByClient
Description:
Получение обращений по клиенту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketQueryClientRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/list_tickets_by_company
POST
Summary:
listTicketsByCompany
Description:
Получение обращений по компании
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketQueryCompanyRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/list_tickets_by_project
POST
Summary:
listTicketsByProject
Description:
Получение обращений по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketQueryProjectRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/listen_message
POST
Summary:
listenTicketMessage
Description:
Вызывает событие прослушивания сообщения обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessageIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/open_ticket
POST
Summary:
openTicket
Description:
Открыть обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/postpone_several_tickets
POST
Summary:
postponeSeveralTickets
Description:
Отложить несколько обращений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketPostponeSeveralRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/query_members_by_ticket
POST
Summary:
queryTicketMembersByTicket
Description:
Получение участников обращения по обращению
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMemberList |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/queue_several_tickets
POST
Summary:
queueSeveralTickets
Description:
Перевезти в очередь несколько обращений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketQueueSeveralRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/read_message
POST
Summary:
readTicketMessage
Description:
Вызывает событие прочтения сообщения обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessageReceivedRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/received_message
POST
Summary:
receivedTicketMessage
Description:
Вызывает событие получения сообщения обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessageReceivedRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/register_ticket
POST
Summary:
registerTicket
Description:
Зарегистрировать обращение
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/set_ticket_category
POST
Summary:
setTicketCategory
Description:
Задать категорию обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketSetCategoryRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/set_ticket_fcr
POST
Summary:
setTicketFCR
Description:
Задать FCR обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketSetFCRRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/set_ticket_tag
POST
Summary:
setTicketTag
Description:
Задать тег обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketSetTagRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/slice_messages_by_ticket
POST
Summary:
sliceTicketMessagesByTicket
Description:
Получение слайса сообщений обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketMessagesSliceRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketMessageSlice |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/transfer_several_tickets
POST
Summary:
transferSeveralTickets
Description:
Переназначить несколько обращений на пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketTransferSeveralRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/transfer_ticket
POST
Summary:
transferTicket
Description:
Переназначить обращение на пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketTransferRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/typing_message
POST
Summary:
typingTicketMessage
Description:
Вызывает событие написания сообщения обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/unassign_ticket
POST
Summary:
unassignTicket
Description:
Убрать назначение обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/unban_several_tickets
POST
Summary:
unbanSeveralTickets
Description:
Разблокировать несколько обращений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketBanRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | bool |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/unregister_ticket
POST
Summary:
unregisterTicket
Description:
Отменить регистрацию обращения
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketIdRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.TicketOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/update_ban_options
POST
Summary:
updateBanOptions
Description:
Обновление настроек заблокированных обращений по cегменту
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketBanOptionsUpdateRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.BlockedTicketSettings |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/tickets/update_several_banned_tickets
POST
Summary:
updateSeveralBannedTickets
Description:
Обновить несколько заблокированных обращений
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.TicketBanRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ schema.Ticket ] |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/auth
POST
Summary:
users_auth
Description:
Авторизация пользователя (проверка токена)
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UsersAuthRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserAuthOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/avatar/{userId}
GET
Summary:
users_getAvatar
Description:
Получить аватар пользователя
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.File |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/change_password
POST
Summary:
users_changePassword
Description:
Изменение пароля пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserChangePasswordRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/change_temp_password
POST
Summary:
users_changeTempPassword
Description:
Изменение временного пароля пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserChangeTempPasswordRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/clear_avatar
POST
Summary:
users_clearAvatar
Description:
Очистить аватар пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserClearAvatarRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/get_me
POST
Summary:
users_getMe
Description:
Получить текущего авторизованного пользователя
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/get_role
POST
Summary:
users_getRole
Description:
Получение пользовательской роли
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserRoleGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserRoleOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/get_skill
POST
Summary:
users_getSkill
Description:
Получение навыка пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserSkillGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserSkillOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/get_user
POST
Summary:
users_getUser
Description:
Получение пользователя по Id
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserGetRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/goactive
POST
Summary:
users_goactive
Description:
Перевезти пользователя в статус "Активен"
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserGoActiveRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/login
POST
Summary:
users_login
Description:
Авторизация пользователя
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| input | body | Тело запроса | Yes | schema.UserAuthRequest |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | schema.UserAuthOutput |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |
/users/logout
POST
Summary:
users_logout
Description:
Деавторизация текущего авторизованного пользователя
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | |
| 400 | Bad Request | schema.Response |
| 404 | Not Found | schema.Response |
| 500 | Internal Server Error | schema.Response |
| default | schema.Response |