/analytics/export_details
POST
Summary:
exportAnalyticsDetails
Description:
Экспорт деталей аналитики
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для экспорта деталей аналитики | Yes | schema.ExportAnalyticDetailsInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | string |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/analytics/export_report
POST
Summary:
exportAnalyticsReport
Description:
Экспорт аналитики
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для экспорта аналитики | Yes | schema.ExportAnalyticsInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | string |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/analytics/export_subreport
POST
Summary:
exportAnalyticsSubreport
Description:
Экспорт дополнительной аналитики
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для экспорта дополнительной аналитики | Yes | schema.ExportAnalyticsSubreportInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | string |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/analytics/query_details
POST
Summary:
queryAnalyticsDetails
Description:
Получение деталей аналитики по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для деталей аналитики | Yes | schema.AnalyticsDetailsQuery |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.AnalyticsDetailsRow ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/analytics/query_report
POST
Summary:
queryAnalyticsReport
Description:
Получение аналитики по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для аналитики | Yes | schema.AnalyticsQuery |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.AnalyticsRow ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/analytics/query_subreport
POST
Summary:
queryAnalyticsSubreport
Description:
Получение дополнительной аналитики по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Запрос для аналитики | Yes | schema.AnalyticsSubreportQuery |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.AnalyticsRow ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/create_autoreply
POST
Summary:
createAutoreply
Description:
Создание автоответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/create_group
POST
Summary:
createAutoreplyGroup
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyGroupCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/delete_autoreply
POST
Summary:
deleteAutoreply
Description:
Удаление автоответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Id автоответа | Yes | schema.AutoreplyGetInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/delete_group
POST
Summary:
deleteAutoreplyGroup
Description:
Удаление группы автоответов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyGroupGetInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/get_autoreply
POST
Summary:
getAutoreply
Description:
Получение автоответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Id автоответа | Yes | schema.AutoreplyGetInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/get_group
POST
Summary:
getAutoreplyGroup
Description:
Получение группы автоответов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Id группы | Yes | schema.AutoreplyGroupGetInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/query_groups
POST
Summary:
queryAutoreplyGroups
Description:
Получение групп автоответов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Id cегмента | Yes | schema.AutoreplyGroupsGetInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyGroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/toggle_autoreply
POST
Summary:
toggleAutoreply
Description:
Включение\выключение действия автоответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyToggleInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/update_autoreply
POST
Summary:
updateAutoreply
Description:
Обновление автоответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/api/autoreplies/update_group
POST
Summary:
updateAutoreplyGroup
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.AutoreplyGroupUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.AutoreplyGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/bad_words/create_bad_word
POST
Summary:
createBadWord
Description:
Добавление плохого слова
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.BadWordInputRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.BadWordOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/bad_words/delete_bad_word
POST
Summary:
deleteBadWord
Description:
Удаление плохого слова
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.BadWordDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.BadWordOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/bad_words/get_bad_words
POST
Summary:
getBadWords
Description:
Получение плохих слов
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.BadWordsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/bad_words/update_settings
POST
Summary:
updateBadWordsSettings
Description:
Обновление настроек антимата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.BadWordUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | true | string |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/categories/create_category
POST
Summary:
createCategory
Description:
Создание категории
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryCreateInput |
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/create_folder
POST
Summary:
createCategoryFolder
Description:
Создание папки для категорий
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryFolderCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CategoryFolderOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/categories/delete_category
POST
Summary:
deleteCategory
Description:
Удаление категории
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryDeleteInput |
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/delete_folder
POST
Summary:
deleteCategoryFolder
Description:
Удаление папки категорий
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryFolderDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CategoryFolderDeleteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/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 |
/categories/update_category
POST
Summary:
updateCategory
Description:
Обновление категории
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryUpdateInput |
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/update_folder
POST
Summary:
updateCategoryFolder
Description:
Обновление папки категорий
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CategoryFolderUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CategoryFolderOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/configure_audio
POST
Summary:
configureChannelAudioMessages
Description:
Конфигурация аудио сообщений канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelConfigureInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelConfigureOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/create_channel
POST
Summary:
channels_createChannel
Description:
Создание канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/delete_channel
POST
Summary:
channels_deleteChannel
Description:
Удаление канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/get_channel
POST
Summary:
channels_getChannel
Description:
Получение канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/query_channels_by_company
POST
Summary:
channels_queryChannelsByCompany
Description:
Получение каналов по компании
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelQueryCompanyInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/query_channels_by_project
POST
Summary:
channels_queryChannelsByProject
Description:
Получение каналов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/query_my_channels
POST
Summary:
channels_queryMyChannels
Description:
Получение каналов пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelMyQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/restore_channel
POST
Summary:
channels_restoreChannel
Description:
Восстановление канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/channels/update_channel
POST
Summary:
channels_updateChannel
Description:
Обновление канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/create
POST
Summary:
createChatBotPlatform
Description:
Создание платформы чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/delete
POST
Summary:
deleteChatBotPlatform
Description:
Удаление платформы чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/get_by_id
POST
Summary:
getChatBotPlatformById
Description:
Получение платформы чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/list
POST
Summary:
listChatBotPlatforms
Description:
Получение списка платформ чат-ботов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/query_by_project_id
POST
Summary:
queryChatBotPlatformsByProjectId
Description:
Получение платформ чат-ботов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformQueryProjectInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/toggle
POST
Summary:
toggleChatBotPlatform
Description:
Включение\выключение платформы чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformToggleInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bot_platforms/update
POST
Summary:
updateChatBotPlatform
Description:
Обновление платформы чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotPlatformUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotPlatformOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bots/create
POST
Summary:
createChatBot
Description:
Создание чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bots/delete
POST
Summary:
deleteChatBot
Description:
Удаление чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bots/get_by_id
POST
Summary:
getBotById
Description:
Получение чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bots/list_by_project_id
POST
Summary:
listChatBotsByProjectId
Description:
Получение списка чат-ботов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/chat_bots/update
POST
Summary:
updateChatBot
Description:
Обновление чат-бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatBotUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatBotOutput |
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 |
/client_groups/create_group
POST
Summary:
createClientGroup
Description:
Создание группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/create_member
POST
Summary:
createClientGroupMember
Description:
Создание участника группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMemberCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/create_members
POST
Summary:
createClientGroupMembers
Description:
Создание участников группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMembersCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupClientsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/delete_group
POST
Summary:
deleteClientGroup
Description:
Удаление группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/delete_member
POST
Summary:
deleteClientGroupMember
Description:
Удаление участника группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMemberIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/get_group
POST
Summary:
getClientGroup
Description:
Получение группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/move_group
POST
Summary:
moveClientGroup
Description:
Перемещение группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupIdParentIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_clients_by_project
POST
Summary:
queryClientGroupUsersByProject
Description:
Получение клиентов группы по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMemberQueryByProjectInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupClientsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_groups
POST
Summary:
queryClientGroups
Description:
Получение групп клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_groups_by_project
POST
Summary:
queryClientGroupsByProject
Description:
Получение групп клиентов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupQueryByProjectInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_member_by_ids
POST
Summary:
queryClientGroupMember
Description:
Получение участника группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMemberQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_members_by_group
POST
Summary:
queryMembersByClientGroup
Description:
Получение участников по группе клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMembersQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/query_members_by_project
POST
Summary:
queryClientGroupMembersByProject
Description:
Получение участников группы клиентов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupMemberQueryByProjectInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/client_groups/update_group
POST
Summary:
updateClientGroup
Description:
Обновление группы клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientGroupUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
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/list_clients_by_channel
POST
Summary:
listClientsByChannel
Description:
Получение списка клиентов по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientChannelQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/clients/list_clients_by_company
POST
Summary:
listClientsByCompany
Description:
Получение списка клиентов по компании
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientCompanyQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/clients/list_clients_by_parent
POST
Summary:
listClientsByParent
Description:
Получение списка клиентов по родителю (связанному клиенту)
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientParentQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/clients/list_clients_by_project
POST
Summary:
listClientsByProject
Description:
Получение списка клиентов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientProjectQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/clients/list_clients_for_mailing
POST
Summary:
listClientsForMailingList
Description:
Получение списка клиентов по списку рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientMailingListQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/clients/list_my_clients
POST
Summary:
listMyClients
Description:
Получение списка клиентов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ClientQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientList |
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 |
/companies/create_company
POST
Summary:
createCompany
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CompanyCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CompanyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/companies/get_company
POST
Summary:
getCompany
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CompanyIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CompanyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/companies/list_companies_by_project
POST
Summary:
listCompaniesByProject
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CompanyProjectQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CompanyListOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/companies/query_companies_by_project
POST
Summary:
queryCompaniesByProject
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CompanyProjectQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CompaniesOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/companies/update_company
POST
Summary:
updateCompany
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CompanyUpdateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CompanyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/get_inbox_by_user
POST
Summary:
corporateChatInboxes_getCorporateChatInboxByUser
Description:
Получение входящих корпоративного чата по пользователю
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxUserIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInputOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/get_my_inbox
POST
Summary:
corporateChatInboxes_getMyCorporateChatInbox
Description:
Получение входящих корпоративного чата авторизованного пользователя
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInputOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/get_thread
POST
Summary:
corporateChatInboxes_getThread
Description:
Получение корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxThreadIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/mark_thread_as_read
POST
Summary:
corporateChatInboxes_markThreadAsRead
Description:
Пометить корпоративный чат как прочитанный
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxThreadIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/mark_thread_by_chat_as_read
POST
Summary:
CorporateChatInboxes_markThreadByChatAsRead
Description:
Пометить корпоративный чат как прочитанный по Id
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/query_my_threads
POST
Summary:
corporateChatInboxes_queryMyThreads
Description:
Получение входящих корпоративных чатов авторизованного пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxThreadQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/query_threads_by_user
POST
Summary:
corporateChatInboxes_queryThreadsByUser
Description:
Получение корпоративных чатов по пользователю
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxThreadProjectQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chat_inboxes/search_threads_by_text
POST
Summary:
corporateChatInboxes_searchThreadsByText
Description:
Получение корпоративных чатов по тексту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInboxThreadProjectQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/add_to_chat
POST
Summary:
inviteToCorporateChat
Description:
Пригласить пользователей в корпоративный чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInviteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/create_message
POST
Summary:
createCorporateChatMessage
Description:
Создать сообщение в корпоративном чате
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessageCreateInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/delete
POST
Summary:
deleteCorporateChat
Description:
Удалить корпоративный чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/delete_messages
POST
Summary:
deleteCorporateChatMessages
Description:
Удалить сообщения корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessagesDeleteInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.CorporateChatMessage ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/disable
POST
Summary:
disableCorporateChatForUsers
Description:
Отключить корпоративный чат для пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatUserIdsInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ integer ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/enable
POST
Summary:
enableCorporateChatForUser
Description:
Включить корпоративный чат для пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatUserIdInput |
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 |
/corporate_chats/get
POST
Summary:
getCorporateChat
Description:
Получает корпоративный чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/get_message
POST
Summary:
getCorporateChatMessage
Description:
Получает сообщение корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessageIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/join_chat
POST
Summary:
joinCorporateChat
Description:
Присоединиться к корпоративному чату
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChatIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/kick_from_chat
POST
Summary:
kickFromCorporateChat
Description:
Исключить пользователей из корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatKickInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/leave_chat
POST
Summary:
leaveCorporateChat
Description:
Покинуть корпоративный чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatIdInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/listen_message
POST
Summary:
listenCorporateChatMessage
Description:
Вызывает события прослушивания сообщения корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessageListInput |
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 |
/corporate_chats/open
POST
Summary:
openCorporateChat
Description:
Открыть корпоративный чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatOpenInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/open_group_chat
POST
Summary:
openGroupCorporateChat
Description:
Открыть группу корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatInputRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/query_members_by_chat
POST
Summary:
queryMembersByCorporateChat
Description:
Получает участников корпоративного чат
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMemberQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/query_messages_by_chat
POST
Summary:
queryCorporateMessagesByChat
Description:
Получает сообщения по Id корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessageQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMessageList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/read_message
POST
Summary:
readCorporateChatMessage
Description:
Вызывает событие прочтения сообщений корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessagesReceivedInput |
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 |
/corporate_chats/received_message
POST
Summary:
receivedCorporateChatMessage
Description:
Вызывает событие получения сообщений корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessagesReceivedInput |
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 |
/corporate_chats/search_chats_by_users
POST
Summary:
searchCorporateChatsByClients
Description:
Получение клиентов по корпоративному чату
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatSearchQueryInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/slice_messages_by_chat
POST
Summary:
sliceMessagesByCorporateChat
Description:
Получение слайса сообщений корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatMessagesSliceInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMessageSlice |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/transfer_rights
POST
Summary:
transferAdminRights
Description:
Передать пользователю права администратора корпоративного чата
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatTransferInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/corporate_chats/typing_message
POST
Summary:
typingCorporateChatMessage
Description:
Вызывает событие печатания сообщения в корпоративном чате
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CorporateChatIdInput |
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 |
/crms/create_crm
POST
Summary:
createCRM
Description:
Создание CRM
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CRMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/crms/delete_crm
POST
Summary:
deleteCRM
Description:
Удаление CRM
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CRMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/crms/get_crm
POST
Summary:
getCRM
Description:
Получение CRM
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CRMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/crms/query_crms_by_project
POST
Summary:
queryCRMSbyProject
Description:
Получение всех CRM по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.CRMsOutput ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/crms/toggle_crm
POST
Summary:
toggleCRM
Description:
Включение\выключение CRM
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CRMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/crms/update_crm
POST
Summary:
updateCRM
Description:
Обновление CRM
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.CRMUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CRMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/channels_by_project
POST
Summary:
dashboardChannelsByProject
Description:
Получение каналов для дашборда по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/daily_report_by_project
POST
Summary:
dashboardDailyReport
Description:
Получение дашборда cегмента на сегодняшнюю дату
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardDailyRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.DashboardDailyOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/groups_by_project
POST
Summary:
dashboardGroupsByProject
Description:
Получение групп для дашборда по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/settings_by_project
POST
Summary:
pendingTimeSettingsByProject
Description:
Получение настроек для плашки дашборда "Время до 1 ответа"
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ResponseTimeSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/tickets_by_category
POST
Summary:
dashboardTicketByCategory
Description:
Получение обращений по категориям для дашборда
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardTicketByCategoryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.TicketsByCategory ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/tickets_by_project
POST
Summary:
dashboardTicketsByProject
Description:
Получение обращений для дашборда по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.DashboardQueryOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/dashboard/update_settings
POST
Summary:
updatePendingTimeSettings
Description:
Обновление настроек для плашки дашборда "Время до 1 ответа"
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.DashboardSettingsRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ResponseTimeSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/db_status
GET
Summary:
dbStatus
Description:
Возвращает статус базы данных
Responses
Code | Description | Schema |
---|---|---|
200 | OK | |
500 | Internal Server Error | schema.Response |
/edna/configure
POST
Summary:
configureEdna
Description:
Настроить конфиг Edna
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.EdnaConfigureRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.EdnaOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/edna/get_cascades
POST
Summary:
getCascades
Description:
Получить конфиг Edna
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GetEdnaCascadesRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.EdnaCascade ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/edna/get_config
POST
Summary:
getEdnaConfig
Description:
Получить конфиг Edna
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.EdnaOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/email_channel/configure_channel
POST
Summary:
configureEmailChannel
Description:
Настроить конфигурацию для почтового канала
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.EmailChannelsRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.EmailChannelConfig |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/email_channel/configure_servers
POST
Summary:
configureEmailServers
Description:
Настроить конфигурацию для почтовых серверов
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.EmailChannelsServerRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.EmailChannelConfig |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/email_channel/get_config
POST
Summary:
getEmailConfig
Description:
Получить почтовую конфигурацию
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.EmailChannelConfig |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/facebook/get_config
POST
Summary:
getFacebookConfig
Description:
Получить конфигурацию Facebook
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.FacebookConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/facebook/set_page_token
POST
Summary:
setFacebookPageToken
Description:
Задать Facebook токен
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.FacebookPageTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.FacebookConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/facebook/set_verify_token
POST
Summary:
setFacebookVerifyToken
Description:
Задать Facebook токен подтверждения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.FacebookVerifyTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.FacebookConfigOutput |
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 |
/gateway/send_to_abs_ref
POST
Summary:
gatewaySendToAbsRef
Description:
Отправка клиенту сообщения по абсолютной ссылке шлюзом
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GatewaySendToAbsRefRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/gateway/send_to_card_ref
POST
Summary:
gatewaySendToCardRef
Description:
Отправка клиенту сообщения по CardRef шлюзом
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GatewaySendToCardRefRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/gateway/send_to_client
POST
Summary:
gatewaySendToClient
Description:
Отправка клиенту сообщения шлюзом
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GatewaySendToClientRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/gateway/send_to_crm_ref
POST
Summary:
gatewaySendToCrmRef
Description:
Отправка клиенту сообщения по ссылке CRM шлюзом
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GatewaySendToCRMRefRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/gateway/send_to_inn
POST
Summary:
gatewaySendToInn
Description:
Отправка клиенту сообщения по ИНН шлюзом
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GatewaySendToINNRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChatMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/create_group
POST
Summary:
createGroup
Description:
Создание группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/create_group_permissions
POST
Summary:
createGroupPermissions
Description:
Создание группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupPermissionsCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/create_member
POST
Summary:
createGroupMember
Description:
Создания участника группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/create_member_permissions
POST
Summary:
createGroupPermissionsMember
Description:
Создание участника группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/delete_group
POST
Summary:
deleteGroup
Description:
Удаление группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/delete_group_permissions
POST
Summary:
deleteGroupPermissions
Description:
Удаление группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/delete_member
POST
Summary:
deleteGroupMember
Description:
Удаление участника группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/delete_member_permissions
POST
Summary:
deleteGroupPermissionsMember
Description:
Удаление участника группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/get_group
POST
Summary:
getGroup
Description:
Получение группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/get_group_permissions
POST
Summary:
getGroupPermissions
Description:
Получение группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/move_group
POST
Summary:
moveGroup
Description:
Перемещение группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMoveRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/move_group_permissions
POST
Summary:
moveGroupPermissions
Description:
Перемещение группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupPermissionsMoveRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_groups
POST
Summary:
queryGroups
Description:
Получение групп распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_groups_by_project
POST
Summary:
queryGroupsByProject
Description:
Получение групп распределения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_groups_permissions
POST
Summary:
queryGroupsPermissions
Description:
Получение групп ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupPermissionsQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupsPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_groups_permissions_by_project
POST
Summary:
queryGroupsPermissionsByProject
Description:
Получение групп ролей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupPermissionsQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupsPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_members_by_group
POST
Summary:
queryMembersByGroup
Description:
Получение участников группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_members_by_group_permissions
POST
Summary:
queryMembersByGroupPermissions
Description:
Получение участников группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_members_by_project
POST
Summary:
queryMembersByProject
Description:
Получение участников группы распределения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_members_by_project_permissions
POST
Summary:
queryMembersPermissionsByProject
Description:
Получение участников группы ролей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupMembersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_users_by_project
POST
Summary:
queryGroupUsersByProject
Description:
Получение пользователей группы распределения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupUsersQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UsersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/query_users_by_project_permissions
POST
Summary:
queryGroupPermissionsUsersByProject
Description:
Получение пользователей группы ролей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupMemberQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UsersOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/update_group
POST
Summary:
updateGroup
Description:
Обновление группы распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/groups/update_group_permissions
POST
Summary:
updateGroupPermissions
Description:
Обновление группы ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.GroupPermissionsUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
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 |
/infobip/configure
POST
Summary:
configureInfobip
Description:
Настройка конфигурации Infobip
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.InfoBipConfigRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.InfoBipConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/infobip/get_config
POST
Summary:
getInfobipConfig
Description:
Получение конфигурации Infobip
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.InfoBipConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/configure_apns
POST
Summary:
iqchats_configureAPNS
Description:
Настройка APNS
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ConfigureAPNSRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.IQChatAPNSOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/configure_fcm
POST
Summary:
iqchats_configureFCM
Description:
Настройка FCM по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ConfigureFCMRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ConfigureFCMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/configure_widget
POST
Summary:
configureIQChatWidget
Description:
Настройка IQChatWidget по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ConfigureIQChatWidgetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.IQChatWidgetRequest |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/get_apns
POST
Summary:
iqchats_getAPNS
Description:
Получение APNS по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.IQChatAPNSOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/get_channel
POST
Summary:
iqchats_getChannel
Description:
Получение IQChat по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.IQChatChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/get_fcm
POST
Summary:
iqchats_getFCM
Description:
Получение FCM по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ConfigureFCMOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/iqchats/get_widget
POST
Summary:
getIQChatWidget
Description:
Получение IQChatWidget по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.IQChatWidgetRequest |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/licenses/clear_license
POST
Summary:
clearLicense
Description:
Очистить лицензию IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.LicenseOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/licenses/get_license
POST
Summary:
getLicense
Description:
Получение лицензии IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.LicenseOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/licenses/set_license
POST
Summary:
setLicense
Description:
Задать лицензию IQChannels по ключу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.LicenseKeyRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.LicenseOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/cancel_message
POST
Summary:
cancelMailingMessage
Description:
Отменить сообщение рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingMessageIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/create_mailing
POST
Summary:
createMailing
Description:
Создание рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/create_message
POST
Summary:
createMailingMessage
Description:
Создание сообщения рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingMessageCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingMessageOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/delete_mailing
POST
Summary:
deleteMailing
Description:
Удаление рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/get_mailing
POST
Summary:
getMailing
Description:
Получение рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/list_mailings_by_project
POST
Summary:
listMailings
Description:
Получение рассылок
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/list_messages_by_mailing
POST
Summary:
listMailingMessages
Description:
Получение сообщений рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingMessagesRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingMessagesOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/add_to_list
POST
Summary:
addClientsToMailingList
Description:
Добавление клиентов в список рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Файл таблицы для листа | Yes | schema.File |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingListResponseOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/create
POST
Summary:
createMailingList
Description:
Создание списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Файл таблицы для листа | Yes | schema.File |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingListResponseOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/delete
POST
Summary:
deleteMailingList
Description:
Удаление списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingListIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/delete_from_list
POST
Summary:
deleteClientsFromMailingList
Description:
Удаление клиентов из списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingListDeleteClientsRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/get_by_id
POST
Summary:
getMailingList
Description:
Получение списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingListIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/list_by_project
POST
Summary:
getMailingListsByProject
Description:
Получение списков рассылки по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.MailingList ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/lists/update
POST
Summary:
updateMailingList
Description:
Обновление списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingListUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/mailings_read_clients
POST
Summary:
queryMailingsReadClients
Description:
Получение список клиентов и информации по ним и соответствующим рассылкам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingReadClientQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingReadClientOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/query_mailings_list
POST
Summary:
queryMailingsList
Description:
Получение список клиентов и информации по ним и соответствующим рассылкам (для страницы клиента)
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingReadClientQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingReadClientsList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/mailings/update_mailing
POST
Summary:
updateMailing
Description:
Обновление списка рассылки
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.MailingUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.MailingOutput |
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 |
/orgs/get_options
POST
Summary:
getOrgOptions
Description:
Получение настроек организации IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.OrgOptionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/orgs/get_org
POST
Summary:
getOrg
Description:
Получение организации IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.OrgOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/orgs/update_options
POST
Summary:
updateOrgOptions
Description:
Обновление настроек организации IQChannels
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.OrgOptionsUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.OrgOptionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/orgs/update_org
POST
Summary:
updateOrg
Description:
Обновление организации IQChannels
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.OrgUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.OrgOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/personal_managers/assign
POST
Summary:
assignPersonalManager
Description:
Назначение клиента на персонального менеджера
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PersonalManagerAssignRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PersonalManagerOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/personal_managers/get_sync_settings
POST
Summary:
getPersonalManagerSyncSettings
Description:
Получение настроек персональных менеджеров
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PersonalManagerGetSettingsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/personal_managers/list_by_project_id
POST
Summary:
listPersonalManagersByProjectId
Description:
Получение персональных менеджеров по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PersonalManagerQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PersonalManagerList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/personal_managers/unassign
POST
Summary:
unassignPersonalManager
Description:
Отозвать персонального менеджера от клиента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PersonalManagerUnassignRequest |
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 |
/personal_managers/update_sync_settings
POST
Summary:
updatePersonalManagerSyncSettings
Description:
Обновление настроек персональных менеджеров
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PersonalManagerUpdateSettingsRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PersonalManagerGetSettingsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/create_product
POST
Summary:
products_createProduct
Description:
Создание продукта\услуги
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/delete_product
POST
Summary:
products_deleteProduct
Description:
Удаление продукта\услуги
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/delete_products
POST
Summary:
products_deleteProducts
Description:
Удаление продуктов\услуг
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductsDeleteRequest |
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 |
/products/disable_client_product
POST
Summary:
products_disableClientProduct
Description:
Отключение продукта\услуги клиента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductDisableClientRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/get_client_available_products
POST
Summary:
products_getClientAvailableProducts
Description:
Получение доступных продуктов\услуг клиента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductGetClientRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/get_client_products
POST
Summary:
products_getClientProducts
Description:
Получение продуктов\услуг клиента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductGetClientRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ schema.Product ] |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/get_product
POST
Summary:
products_getProduct
Description:
Получение продукта\услуги
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductGetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/query_products_by_project
POST
Summary:
products_queryProductsByProject
Description:
Получение продуктов\услуг по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/restore_product
POST
Summary:
products_restoreProduct
Description:
Восстановление продукта\услуги
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductRestoreRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/products/update_product
POST
Summary:
products_updateProduct
Description:
Обновление продукта\услуги
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProductUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/projects/archive_project
POST
Summary:
projects_archiveProject
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/configure_audio_for_channels
POST
Summary:
projects_ConfigureAudioMessagesInProject
Description:
Обновление настроек аудио сообщений cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectAudioRequest |
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 |
/projects/create_project
POST
Summary:
projects_createProject
Description:
Создание cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectCreateRequest |
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/delete_project
POST
Summary:
projects_deleteProject
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/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 |
/projects/query_projects_with_stats
POST
Summary:
projects_queryProjectsWithStats
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/restore_project
POST
Summary:
projects_restoreProject
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/update_display_options
POST
Summary:
projects_updateDisplayOptions
Description:
Обновление настроек отображения cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectDisplayOptionsUpdateRequest |
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/update_options
POST
Summary:
projects_updateOptions
Description:
Обновление настроек cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectOptionsUpdateRequest |
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/update_project
POST
Summary:
projects_updateProject
Description:
Обновление cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectUpdateRequest |
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/update_routing_options
POST
Summary:
projects_updateRoutingOptions
Description:
Обновление настроек распределения cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectOptionsUpdateRequest |
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 |
/pushes/send_test_android_push
POST
Summary:
pushes_sendTestAndroidPush
Description:
Отправить тестовый Android пуш
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PushTestRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PushTestOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/pushes/send_test_apple_push
POST
Summary:
pushes_sendTestApplePush
Description:
Отправить тестовый Apple пуш
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.PushTestRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.PushTestOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/quickreplies/create_folder
POST
Summary:
createQuickreplyFolder
Description:
Создание папки с быстрыми ответами
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.QuickReplyFolderCreateRequest |
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/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/delete_folder
POST
Summary:
deleteQuickreplyFolder
Description:
Удаление папки с быстрыми ответами
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.QuickReplyFolderDeleteRequest |
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/delete_reply
POST
Summary:
deleteQuickreply
Description:
Удаление быстрого ответа
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.QuickReplyDeleteRequest |
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/export_project
GET
Summary:
exportQuickrepliesProject
Description:
Экспорт быстрых ответов cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.QuickReplyExportRequest |
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 |
/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/import_project
POST
Summary:
importQuickrepliesProject
Description:
Импорт быстрых ответов cегмента
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Файл с быстрыми ответами | Yes | schema.File |
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_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_folder
POST
Summary:
updateQuickreplyFolder
Description:
Обновление папки с быстрыми ответами
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.QuickReplyFolderUpdateRequest |
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/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 |
/rating_polls/create
POST
Summary:
createPoll
Description:
Создание опроса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RatingPollCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RatingPollOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/rating_polls/delete
POST
Summary:
deletePoll
Description:
Удаление опроса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RatingPollDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RatingPollOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/rating_polls/query_polls_by_project
POST
Summary:
queryPollsByProject
Description:
Получение опросов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RatingPollsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/rating_polls/toggle
POST
Summary:
togglePoll
Description:
Включение\выключение опроса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RatingPollToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RatingPollOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/rating_polls/update
POST
Summary:
updatePoll
Description:
Обновление опроса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RatingPollUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RatingPollOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/client_report_by_project
POST
Summary:
clientReportByProject
Description:
Отчёт по клиентам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportClientRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ReportClientOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/export_client_report_by_project
GET
Summary:
exportClientReportByProject
Description:
Экспортировать отчёт по клиентам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportClientExportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица в заданном формате | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/export_ticket_report_by_project
GET
Summary:
exportTicketReportByProject
Description:
Экспортировать отчёт по обращениям
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportTicketExportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица в заданном формате | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/export_user_report_by_project
GET
Summary:
exportUserReportByProject
Description:
Экспортировать отчёт по пользователям
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportUserExportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица в заданном формате | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/ticket_report_by_project
POST
Summary:
ticketReportByProject
Description:
Отчёт по обращениям
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportTicketRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ReportTicketOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/ticket_report_for_dashboard
POST
Summary:
ticketReportForDashboard
Description:
Отчёт по обращениям для дашборда
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportTicketDashboardRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketReportRow |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/user_report_by_project
POST
Summary:
userReportByProject
Description:
Отчёт по пользователям
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportUserRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ReportUserOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/reports/user_report_dashboard
POST
Summary:
userDashboardReport
Description:
Отчёт по пользователям для дашборда
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ReportUserDashboardRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ReportUserOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/create_route
POST
Summary:
createRoute
Description:
Создание правила распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/delete_route
POST
Summary:
deleteRoute
Description:
Удаление правила распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/match_ticket_to_route
POST
Summary:
matchTicketToRoute
Description:
Назначить обращение на правило распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteMatchTicketRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/match_ticket_to_user
POST
Summary:
matchTicketToUser
Description:
Назначить обращение на пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteMatchTicketRequest |
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 |
/routes/move_route
POST
Summary:
moveRoute
Description:
Перемещение правила распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteMoveRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/query_routes_by_project
POST
Summary:
queryRoutesByProject
Description:
Получение правил распределения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RoutesOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/toggle_route
POST
Summary:
toggleRoute
Description:
Выключение\выключение правила распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/routes/update_route
POST
Summary:
updateRoute
Description:
Обновление правила распределения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.RouteUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/setup/setup
POST
Summary:
setup_handler
Description:
Установка IQChannels
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.SetupInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.SetupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/status
GET
Summary:
status
Description:
Возвращает статус сервера
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.StatusOutput |
500 | Internal Server Error | schema.Response |
/statuses/export_project_report
GET
Summary:
statusesExportProjectReport
Description:
Экспортировать отчёт статусов пользователей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица с отчётом | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/export_report
GET
Summary:
statusesExportReport
Description:
Экспортировать отчёт по статусам пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица с отчётом | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/export_report_for_users
GET
Summary:
statusesExportForUsers
Description:
Экспортировать отчёт статусов пользователей по их id
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица с отчётом | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/export_total_project_report
GET
Summary:
statusesExportTotalProjectReport
Description:
Экспортировать полный отчёт статусов пользователей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryTotalProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица с отчётом | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/export_total_report
GET
Summary:
statusesExportTotalReport
Description:
Экспортировать полный отчёт по статусам пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryTotalReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица с отчётом | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_project_report
POST
Summary:
statusesQueryProjectReport
Description:
Отчёт по статусам пользователей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.StatusQueryReportOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_report
POST
Summary:
statusesQueryReport
Description:
Отчёт по статусам пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.StatusQueryReportOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_report_for_user
POST
Summary:
statusesQueryReportForSingleUser
Description:
Отчёт по статусу пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryReportUserRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UsersReportRow |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_report_for_users
POST
Summary:
statusesQueryForUsers
Description:
Отчёт статусов пользователей по их id
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserStatusesReportRowResponse |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_total_project_report
POST
Summary:
statusesQueryTotalProjectReport
Description:
Полный отчёт статусов пользователей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryTotalProjectReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.StatusQueryTotalReportOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/statuses/query_total_report
POST
Summary:
statusesQueryTotalReport
Description:
Полный отчёт по статусам пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.StatusQueryTotalReportRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.StatusQueryTotalReportOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/channel/{channelId}
GET
Summary:
streamChannel
Description:
Получение канала с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/channels_by_project/{projectId}
GET
Summary:
streamChannelsByProject
Description:
Получение каналов с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ChannelOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/client_group/{groupId}
GET
Summary:
streamClientGroup
Description:
Получение группы клиентов с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/client_groups_by_project/{projectId}
GET
Summary:
streamClientGroupsByProject
Description:
Получение групп клиентов с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ClientGroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/corporate_chat/{chatId}
GET
Summary:
streamCorporateChat
Description:
Получение корпоративного чата с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatStreamOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/corporate_chat_members/{chatId}
GET
Summary:
streamCorporateChatMembers
Description:
Получение участников корпоративного чата с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatMemberOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/corporate_chats/my_inbox
GET
Summary:
streamMyCorporateChatInbox
Description:
Получение входящих сообщений корпоративных чатов текущего авторизованного пользователя с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInputOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/corporate_chats/my_inbox_notifications
GET
Summary:
streamMyCorporateChatInboxNotifications
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/corporate_chats/my_inbox_threads
GET
Summary:
streamMyCorporateChatInboxThreads
Description:
Получение корпоративных чатов текущего авторизованного пользователя с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateChatInboxThreadOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/corporate_chats/my_notification_inbox
GET
Summary:
streamMyCorporateChatNotificationInbox
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/group/{groupId}
GET
Summary:
streamGroup
Description:
Получение группы распределения пользователей с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/group_permissions/{groupId}
GET
Summary:
streamGroupPermissions
Description:
Получение группы ролей пользователей с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/groups_by_project/{projectId}
GET
Summary:
streamGroupsByProject
Description:
Получение групп распределения с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/groups_permissions_by_project/{projectId}
GET
Summary:
streamGroupsPermissionsByProject
Description:
Получение групп ролей с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.GroupPermissionsOutput |
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_corporate_notifications
GET
Summary:
streamMyCorporateNotifications
Description:
Получение входящих уведомлений корпоративного чата текущего авторизованного пользователя с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.CorporateNotificationsOutput |
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/products_by_client/{clientId}
GET
Summary:
streamProductsByClient
Description:
Получение продуктов\услуг по клиентам с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/products_by_id/{productId}
GET
Summary:
streamProductById
Description:
Получение продукта\услуги с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/products_by_project/{projectId}
GET
Summary:
streamProductsByProject
Description:
Получение продуктов\услуг по cегменту с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ProductOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/project/{projectId}
GET
Summary:
streamProject
Description:
Получение cегмента с помощью WebSocket
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 |
/stream/routes_by_project/{projectId}
GET
Summary:
streamRoutesByProject
Description:
Получение правил распределения cегмента с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.RouteOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/stream/tg_posts_by_public/{publicId}
GET
Summary:
streamTelegramPosts
Description:
Получение телеграмм постов с помощью WebSocket
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPostOutput |
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 |
/stream/user/{userId}
GET
Summary:
streamUser
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 |
/system/get_info
POST
Summary:
getSystemInfo
Description:
Получение информации о системе
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.SystemInfoOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/system_chats/create
POST
Summary:
createSettings
Description:
Создание настроек по системным чатам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.SystemChatSettingsInput |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.SystemChatSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/system_chats/get_by_project_id
POST
Summary:
getSettingsByProjectId
Description:
Получение настроек по системным чатам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.SystemChatSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/system_chats/update
POST
Summary:
updateSettings
Description:
Обновление настроек по системным чатам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.SystemChatSettings |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.SystemChatSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/export_violations
GET
Summary:
exportTargetViolations
Description:
Экспортировать отклонения
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица по отчёту | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/export_violations_by_project
GET
Summary:
exportTargetViolationsByProject
Description:
Экспортировать отклонения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsProjectQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | Таблица по отчёта | schema.File |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/get_pending_target
POST
Summary:
getPendingTargetByProject
Description:
Получение показателя "Время до 1 ответа" по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/get_reaction_target
POST
Summary:
getReactionTargetByProject
Description:
Получение показателя "Время первого ответа Оператора" по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/query_targets_by_project
POST
Summary:
queryTargetsByProject
Description:
Получение показателей по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/query_violation_totals
POST
Summary:
queryTargetViolationTotals
Description:
Получение статистики по отклонениям
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetTotalsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/query_violation_totals_by_project
POST
Summary:
queryTargetViolationTotalsByProject
Description:
Получение статистики отклонений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsProjectQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetTotalsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/query_violations
POST
Summary:
queryTargetViolations
Description:
Получение отклонений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetViolationOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/query_violations_by_project
POST
Summary:
queryTargetViolationsByProject
Description:
Получение отклонений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationsProjectQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetViolationOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/resolve_all_violations
POST
Summary:
resolveAllViolations
Description:
Очистить все уведомления об отклонении
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationResolveAllRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetViolationResolveAllOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/resolve_target_by_id
POST
Summary:
resolveViolationById
Description:
Очистить уведомление об отклонении
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetViolationResolveRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetViolationResolveOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/set_target
POST
Summary:
setTarget
Description:
Задать показатель
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetSetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/targets/toggle_target
POST
Summary:
toggleTarget
Description:
Включить\выключить показатель
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TargetToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TargetOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/count_all_publics
POST
Summary:
countAllPublics
Description:
Количество всех телеграмм пабликов
Responses
Code | Description | Schema |
---|---|---|
200 | OK | int64 |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/create_poll
POST
Summary:
createTelegramPoll
Description:
Создать телеграмм опрос
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPollCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPostOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/create_post
POST
Summary:
createTelegramPost
Description:
Создание телеграмм поста
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPostCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPostOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/create_public
POST
Summary:
createTelegramPublic
Description:
Создать телеграмм паблик
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublicOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/delete_post
POST
Summary:
deleteTelegramPost
Description:
Удаление телеграмм поста
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPostDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPost |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/delete_public
POST
Summary:
deleteTelegramPublic
Description:
Удаление телеграмм паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/get_config
POST
Summary:
getTelegramConfig
Description:
Получить конфигурацию телеграмма
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/get_public_by_id
POST
Summary:
getTelegramPublicById
Description:
Получение телеграмм паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicGetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/list_posts_by_public
POST
Summary:
listTgPostsByPublicId
Description:
Получение телеграмм постов по паблику
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPostQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPostsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/list_publics_by_channel_id
POST
Summary:
listTelegramPublicsByChannelId
Description:
Получение телеграмм пабликов по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublicsList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/list_publics_by_project
POST
Summary:
listTelegramPublicsByProjectId
Description:
Получение телеграмм пабликов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicProjectQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublicsList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/set_bot_token
POST
Summary:
setTelegramBotToken
Description:
Задать токен боту телеграмм
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramSetTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/telegram/update_public
POST
Summary:
updateTelegramPublic
Description:
Обновление телеграмм паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TelegramPublicUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TelegramPublic |
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 |
/ticketing_systems/create
POST
Summary:
createTicketingSystem
Description:
Создание системы обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/create_ticket
POST
Summary:
createHelpDeskTicket
Description:
Создать обращение (HelpDesk)
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.HelpDeskTicketInput |
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 |
/ticketing_systems/delete
POST
Summary:
deleteTicketingSystem
Description:
Удаление системы обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/get_by_id
POST
Summary:
getTicketingSystemById
Description:
Получение системы обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/list
POST
Summary:
listTicketingSystems
Description:
Получение систем обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/query_by_project_id
POST
Summary:
queryTicketingSystemsByProjectId
Description:
Получение систем обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemProjectQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/toggle
POST
Summary:
toggleTicketingSystem
Description:
Включение\выключение системы обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketing_systems/update
POST
Summary:
updateTicketingSystem
Description:
Обновление системы обращений
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketingSystemUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketingSystemOutput |
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/export_messages_by_channel
GET
Summary:
exportTicketMessagesByChannel
Description:
Экспортировать сообщения обращения по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketMessagesExportChannelRequest |
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 |
/tickets/export_messages_by_client
GET
Summary:
exportTicketMessagesByClient
Description:
Экспортировать сообщения обращения по клиенту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketMessagesExportClientRequest |
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 |
/tickets/export_messages_by_company
GET
Summary:
exportTicketMessagesByCompany
Description:
Экспортировать сообщения обращения по компании
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketMessagesExportCompanyRequest |
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 |
/tickets/export_messages_by_project
GET
Summary:
exportTicketMessagesByProject
Description:
Экспортировать сообщения обращения по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketMessagesExportProjectRequest |
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 |
/tickets/export_messages_by_ticket
GET
Summary:
exportTicketMessagesByTicket
Description:
Экспортировать сообщения обращения по обращению
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketMessagesExportRequest |
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 |
/tickets/export_tickets_by_channel
GET
Summary:
exportTicketsByChannel
Description:
Экспорт обращений по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketExportChannelRequest |
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 |
/tickets/export_tickets_by_client
GET
Summary:
exportTicketsByClient
Description:
Экспорт обращений по клиенту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketExportClientRequest |
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 |
/tickets/export_tickets_by_company
GET
Summary:
exportTicketsByCompany
Description:
Экспорт обращений по компании
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketExportCompanyRequest |
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 |
/tickets/export_tickets_by_project
GET
Summary:
exportTicketsByProject
Description:
Экспорт обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketExportProjectRequest |
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 |
/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_ban_options
POST
Summary:
getBanOptions
Description:
Получение настроек заблокированных обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
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/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 |
/ticketsclosing/create_settings
POST
Summary:
createTicketsClosing
Description:
Создание настроек закрытия обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketsClosingSettingsCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketsClosingSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketsclosing/delete_settings
POST
Summary:
deleteTicketsClosing
Description:
Удаление настроек закрытия обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketsClosingSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketsclosing/get_by_project_id
POST
Summary:
getTicketsClosingByProjectId
Description:
Получение настроек закрытия обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketsClosingSettings |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/ticketsclosing/update_settings
POST
Summary:
updateTicketsClosing
Description:
Обновление настроек закрытия обращений по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.TicketsClosingSettingsUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.TicketsClosingSettings |
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/count_by_project
POST
Summary:
countUsersByProject
Description:
Количество пользователей в сегменте
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserQueryByProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | int32 |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/count_corporate_chat_users
POST
Summary:
countUsersWithCorporateChats
Description:
Количество пользователей с активированным корпоративным чатом
Responses
Code | Description | Schema |
---|---|---|
200 | OK | int32 |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/create_auth_backend
POST
Summary:
users_createAuthBackend
Description:
Создание серверной аутентификации пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserAuthBackendCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/create_bot
POST
Summary:
users_createBot
Description:
Создать пользователя бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserBotCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserBotCreateOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/create_role
POST
Summary:
users_createRole
Description:
Создание пользовательской роли
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRoleCreateRequest |
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/create_service
POST
Summary:
users_createService
Description:
Создать сервис
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserServiceCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserServiceCreateOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/create_skill
POST
Summary:
users_createSkill
Description:
Создание навыка пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserSkillCreateRequest |
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/create_user
POST
Summary:
users_createUser
Description:
Создание пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserCreateOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/create_workschedule
POST
Summary:
users_createWorkSchedule
Description:
Создание графика работы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserWorkScheduleCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserWorkScheduleOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/deactivate_user
POST
Summary:
users_deactivateUser
Description:
Перевод пользователя в статус "Неактивен"
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserDeactivateRequest |
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/delete_auth_backend
POST
Summary:
users_deleteAuthBackend
Description:
Удаление серверной аутентификации пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserAuthBackendDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/delete_role
POST
Summary:
users_deleteRole
Description:
Удаление пользовательской роли
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRoleDeleteRequest |
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/delete_skill
POST
Summary:
users_deleteSkill
Description:
Удаление навыка пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserSkillDeleteRequest |
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/delete_user
POST
Summary:
users_deleteUser
Description:
Удаление пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserDeleteRequest |
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/delete_workschedule
POST
Summary:
users_deleteWorkSchedule
Description:
Удаление графика работы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserWorkScheduleDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserWorkScheduleOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/get_auth_backend
POST
Summary:
users_getAuthBackend
Description:
Получение серверной аутентификации пользователя
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendOutput |
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_service_token
POST
Summary:
users_getServiceToken
Description:
Получить токен сервиса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserServiceTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserServiceTokenOutput |
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/list_auth_backends
POST
Summary:
users_listAuthBackends
Description:
Получение серверных аутентификаций пользователей
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/list_workschedules
POST
Summary:
users_ListWorkSchedules
Description:
Получение графиков работы
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserWorkSchedulesOutput |
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 |
/users/logout_user
POST
Summary:
users_logoutUser
Description:
Деавторизировать пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserLogoutRequest |
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/query_roles
POST
Summary:
users_queryRoles
Description:
Получение пользовательских ролей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRoleQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserRoleList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/query_skills
POST
Summary:
users_querySkills
Description:
Получение навыков пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserSkillQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserSkillList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/query_users
POST
Summary:
users_queryUsers
Description:
Получение пользователей
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/reset_password
POST
Summary:
users_resetPassword
Description:
Сбросить пароль пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserResetPasswordRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserResetPasswordOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/reset_service_token
POST
Summary:
users_resetServiceToken
Description:
Сбросить токен сервиса
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserServiceTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserServiceTokenOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/restore_role
POST
Summary:
users_restoreRole
Description:
Восстановить пользовательскую роль
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRoleDeleteRequest |
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/restore_user
POST
Summary:
users_restoreUser
Description:
Восстановить пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRestoreRequest |
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/set_same_schedules
POST
Summary:
users_setSameSchedules
Description:
Установить у пользователей один график работы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserWorkScheduleSetSameRequest |
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 |
/users/stop_chats
POST
Summary:
users_stopReceivingChats
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/toggle_auth_backend
POST
Summary:
users_toggleAuthBackend
Description:
Включение\выключение серверной аутентификации пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserAuthBackendToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/update_auth_backend
POST
Summary:
users_updateAuthBackend
Description:
Обновление серверной аутентификации пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserAuthBackendUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserAuthBackendOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/update_bot
POST
Summary:
users_updateBot
Description:
Обновить пользователя бота
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserBotUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserBotUpdateOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/update_role
POST
Summary:
users_updateRole
Description:
Обновление пользовательской роли
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserRoleUpdateRequest |
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/update_skill
POST
Summary:
users_updateSkill
Description:
Обновление навыка пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserSkillUpdateRequest |
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/update_user
POST
Summary:
users_updateUser
Description:
Обновление пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserUpdateRequest |
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/update_workschedule
POST
Summary:
users_updateWorkSchedule
Description:
Обновление графика работы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserWorkScheduleUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.UserWorkScheduleOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/users/upload_avatar
POST
Summary:
users_uploadAvatar
Description:
Загрузить аватар пользователя
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.UserAvatarInput |
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 |
/version
GET
Summary:
version
Description:
Возвращает версию IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VersionOutput |
500 | Internal Server Error | schema.Response |
/viber/get_config
POST
Summary:
getViberConfig
Description:
Получение конфигурации Viber
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ViberConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/viber/set_bot_token
POST
Summary:
setViberBotToken
Description:
Задать токен Viber боту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ViberConfigRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.ViberConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/configure
POST
Summary:
configureVK
Description:
Настройка ВК конфига
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKConfigRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/count_all_publics
POST
Summary:
countAllVKPublics
Description:
Количество всех ВК пабликов
Responses
Code | Description | Schema |
---|---|---|
200 | OK | int64 |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/create_poll
POST
Summary:
createVKPoll
Description:
Создание опроса в ВК паблике
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPollCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPostOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/create_post
POST
Summary:
createVKPost
Description:
Создание поста в ВК паблике
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPostCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPostOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/create_public
POST
Summary:
createVKPublic
Description:
Создание ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublicOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/delete_post
POST
Summary:
deleteVKPost
Description:
Удаление поста в ВК паблике
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPollDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPost |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/delete_public
POST
Summary:
deleteVKPublic
Description:
Удаление ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/get_config
POST
Summary:
getVKConfig
Description:
Получение ВК конфига
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ChannelIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKConfigOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/get_public_by_id
POST
Summary:
getVKPublicById
Description:
Получение ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicGetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/list_posts_by_public
POST
Summary:
listVKPostsByPublicId
Description:
Получение постов ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPostsQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPostsOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/list_publics_by_channel_id
POST
Summary:
listVKPublicsByChannelId
Description:
Получение ВК пабликов по каналу
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublicsList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/list_publics_by_project
POST
Summary:
listVKPublicsByProjectId
Description:
Получение ВК пабликов по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicQueryProjectRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublicsList |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/set_token
POST
Summary:
setAccessToken
Description:
Задать токен ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKAccessTokenRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/vk/update_public
POST
Summary:
updateVKPublic
Description:
Обновление ВК паблика
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.VKPublicUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.VKPublic |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/create_conditional_webhook
POST
Summary:
createConditionalWebhook
Description:
Создание условного вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookConditionalCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/create_webhook
POST
Summary:
createWebhook
Description:
Создание вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookCreateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/delete_webhook
POST
Summary:
deleteWebhook
Description:
Удаление вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookDeleteRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/get_webhook
POST
Summary:
getWebhook
Description:
Получение вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookGetRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/query_webhooks_by_project
POST
Summary:
queryWebhooksByProject
Description:
Получение вебхуков по cегменту
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookQueryRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhooksOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/toggle_webhook
POST
Summary:
toggleWebhook
Description:
Включение\выключение вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookToggleRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/update_conditional_webhook
POST
Summary:
updateConditionalWebhook
Description:
Обновление условного вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookConditionalUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/webhooks/update_webhook
POST
Summary:
updateWebhook
Description:
Обновление вебхука
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.WebhookUpdateRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WebhookOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/wiki_links/get
POST
Summary:
getWikiLinks
Description:
Получение ссылок на вики IQChannels
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WikiLinks |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/workschedules/query_stats
POST
Summary:
queryStats
Description:
Получение статистики по графикам работы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
input | body | Тело запроса | Yes | schema.ProjectIdRequest |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | schema.WorkScheduleStatisticOutput |
400 | Bad Request | schema.Response |
404 | Not Found | schema.Response |
500 | Internal Server Error | schema.Response |
default | schema.Response |
/worktimes/create_worktime
POST
Summary:
createWorktime
Responses
Code | Description |
---|
/worktimes/delete_worktime
POST
Summary:
deleteWorktime
Responses
Code | Description |
---|
/worktimes/list_by_project
POST
Summary:
listWorktimes
Responses
Code | Description |
---|
/worktimes/toggle_worktime
POST
Summary:
toggleWorktime
Responses
Code | Description |
---|
/worktimes/update_worktime
POST
Summary:
updateWorktime
Responses
Code | Description |
---|