Перейти к основному содержимому
Версия: 4.8

Schema Internal API

4

schema.Action​

NameTypeDescriptionRequired
actionstringNo
chatMessageIdintegerNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
idintegerNo
payloadstringNo
titlestringNo
updatedAtstringNo
urlstringNo

schema.ActionType​

NameTypeDescriptionRequired
schema.ActionTypestring

schema.Actor​

NameTypeDescriptionRequired
clientIdintegerNo
typeschema.ActorTypelen=255No
userIdintegerNo

schema.ActorType​

NameTypeDescriptionRequired
schema.ActorTypestring

schema.AnalyticsDetailsFilter​

NameTypeDescriptionRequired
schema.AnalyticsDetailsFilterstring

schema.AnalyticsDetailsQuery​

NameTypeDescriptionRequired
channelIdintegerNo
endstringNo
filterschema.AnalyticsDetailsFilterNo
groupIdintegerNo
hasRatingbooleanNo
periodschema.PeriodNo
projectIdintegerNo
startstringInternalNo

schema.AnalyticsDetailsRow​

NameTypeDescriptionRequired
acceptTimeintegerNo
accepterstringNo
accepterIdintegerNo
assigneestringNo
assigneeIdintegerNo
assignmentsintegerNo
channelstringNo
channelIdintegerNo
clientstringNo
clientIdintegerNo
datestringNo
durationintegerNo
membersstringNo
projectstringNo
projectIdintegerNo
ratingnumberNo
ratingCommentstringNo
respTimeintegerNo
ticketIdintegerNo

schema.AnalyticsQuery​

NameTypeDescriptionRequired
endstringNo
periodschema.PeriodNo
startstringInternalNo

schema.AnalyticsRow​

NameTypeDescriptionRequired
avgAcceptTimenumberNo
avgDurationnumberNo
avgRatingnumberNo
avgRespTimenumberNo
channelstringNo
channelIdintegerNo
groupstringNo
groupIdintegerNo
maxAcceptTimeintegerNo
maxDurationintegerNo
maxRespTimeintegerNo
projectstringNo
projectIdintegerNo
totalAcceptedintegerNo
totalCountintegerNo
totalMissedintegerNo
typeschema.AnalyticsRowTypeNo

schema.AnalyticsRowType​

NameTypeDescriptionRequired
schema.AnalyticsRowTypestring

schema.AnalyticsSubreportQuery​

NameTypeDescriptionRequired
endstringNo
groupIdintegerNo
periodschema.PeriodNo
projectIdintegerNo
startstringInternalNo

schema.AssignTo​

NameTypeDescriptionRequired
schema.AssignTostring

schema.AudioMessageEnabledFor​

NameTypeDescriptionRequired
schema.AudioMessageEnabledForstring

schema.AudioMessagesInput​

NameTypeDescriptionRequired
channelIdssets.Int64No
enabledbooleanNo
enabledForschema.AudioMessageEnabledForNo

schema.Autoreply​

NameTypeDescriptionRequired
closebooleanClose ticketNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
enabledbooleanNo
groupIdintegerNo
idintegerNo
limitintegerOnly for "need_more_time"No
offlineDaysschema.Weekdayslen=255No
offlineEndHourintegerNo
offlineStartHourintegerNo
offlineTimeoutMinintegerNo
offlineUserIdintegerDeprecatedNo
oneTimebooleanNo
projectIdintegerNo
textstringNo
textNoFCRstringNo
timeoutintegerOnly for "need_more_time"No
typeschema.AutoreplyTypelen=32No
updatedAtstringNo
userIdintegerNo

schema.AutoreplyCreateInput​

NameTypeDescriptionRequired
autoreplyschema.AutoreplyInputNo
projectIdintegerNo

schema.AutoreplyGetInput​

NameTypeDescriptionRequired
autoreplyIdintegerNo

schema.AutoreplyGroup​

NameTypeDescriptionRequired
channelIdssets.Int64No
channels[ schema.Channel ]RelationsNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
projectIdintegerNo
replies[ schema.Autoreply ]No
titlestringNo
updatedAtstringNo

schema.AutoreplyGroupCreateInput​

NameTypeDescriptionRequired
groupschema.AutoreplyGroupInputNo
projectIdintegerNo

schema.AutoreplyGroupGetInput​

NameTypeDescriptionRequired
groupIdintegerNo

schema.AutoreplyGroupInput​

NameTypeDescriptionRequired
channelIds[ integer ]No
titlestringNo

schema.AutoreplyGroupOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groupschema.AutoreplyGroupNo

schema.AutoreplyGroupUpdateInput​

NameTypeDescriptionRequired
groupIdintegerNo

schema.AutoreplyGroupsGetInput​

NameTypeDescriptionRequired
projectIdintegerNo

schema.AutoreplyGroupsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groups[ schema.AutoreplyGroup ]No

schema.AutoreplyInput​

NameTypeDescriptionRequired
closebooleanOnly for nooperators and nonworkhours.No
limitintegerOnly for "need_more_time"No
offlineschema.AutoreplyOfflineInputDeprecatedNo
oneTimebooleanNo
textstringNo
textNoFCRstringNo
timeoutintegerOnly for "need_more_time"No
typeschema.AutoreplyTypeNo
userIdintegerNo

schema.AutoreplyOfflineInput​

NameTypeDescriptionRequired
daysschema.WeekdaysNo
endHourintegerNo
startHourintegerNo
timeoutMininteger0 means immediatellyNo
userIdintegerNo

schema.AutoreplyOutput​

NameTypeDescriptionRequired
autoreplyschema.AutoreplyNo
graphschema.GraphNo

schema.AutoreplyToggleInput​

NameTypeDescriptionRequired
autoreplyIdintegerNo
enabledbooleanNo

schema.AutoreplyType​

NameTypeDescriptionRequired
schema.AutoreplyTypestring

schema.AutoreplyUpdateInput​

NameTypeDescriptionRequired
autoreplyschema.AutoreplyInputNo
autoreplyIdintegerNo

schema.BadWord​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
wordstringNo

schema.BadWordDeleteInput​

NameTypeDescriptionRequired
badWordIDintegerNo

schema.BadWordInput​

NameTypeDescriptionRequired
badWordstringNo

schema.BadWordInputRequest​

NameTypeDescriptionRequired
badWordschema.BadWordInputNo

schema.BadWordOutput​

NameTypeDescriptionRequired
badWordschema.BadWordNo

schema.BadWordUpdateInput​

NameTypeDescriptionRequired
badWordsOptionsschema.BadWordsOptionsNo
orgIdintegerNo

schema.BadWordsOptions​

NameTypeDescriptionRequired
badWordsCheckbooleanNo
badWordsViolationbooleanNo

schema.BadWordsOutput​

NameTypeDescriptionRequired
badWords[ schema.BadWord ]No

schema.BanClientInput​

NameTypeDescriptionRequired
blockForeverbooleanNo
blockReasonstringNo
blockUntilDatestringNo
blockUntilTimestringNo
clientIdintegerNo

schema.BlockTicketInput​

NameTypeDescriptionRequired
blockForeverbooleanNo
blockReasonstringNo
blockUntilDatestringNo
blockUntilTimestringNo
ticketIdintegerNo
ticketIds[ integer ]No

schema.BlockedTicketSettings​

NameTypeDescriptionRequired
closeNextReplystringNo
closeNextWithReplybooleanNo
createdAtstringNo
firstAssignToGroupbooleanNo
firstAssignToGroupIdintegerNo
nextAssignToGroupbooleanNo
nextAssignToGroupIdintegerNo
projectIdintegerNo
updatedAtstringNo

schema.BotFlowState​

NameTypeDescriptionRequired
schema.BotFlowStatestring

schema.CRM​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
enabledbooleanNo
idintegerNo
namestringNo
projectIdintegerNo
restoredAtstringNo
typeschema.CRMTypelen=64No
updatedAtstringNo
urlstringNo

schema.CRMClient​

NameTypeDescriptionRequired
birthDaystringNo
branchBikstringБИК подразделения банкаNo
branchExtRefstringИдентификатор в АБС подразделения банкаNo
branchIdstringИдентификатор подразделения банка в iSimpleBank 2.0No
branchNamestringНаименование подразделения банкаNo
cardRefstringИдентификатор клиента в карточном бэкNo
cellphonestringNo
companies[ schema.CRMCompany ]No
crmidintegerАйди CRM, через которую получен клиент, заполняется вручную.No
crmurlstringNo
emailstringNo
enabledbooleanNo
extIdstringАйди клиента в CRM.No
extRefstringИдентификатор клиента в АБСNo
fieldList[ schema.CRMClientField ]Дополнительные поляNo
firstNamestringNo
innstringNo
lastNamestringNo
middleNamestringNo
namestringNo
sexstringNo
shortNamestringNo
tokenstringNo

schema.CRMClientField​

NameTypeDescriptionRequired
namestringNo
valuestringNo

schema.CRMCompany​

NameTypeDescriptionRequired
crmidintegerАйди CRM, через которую получена компания, заполняется вручну.No
enabledbooleanОбслуживание организации разрешеноNo
extIdstringАйди компании в CRM.No
extRefstringКод клиента в АБСNo
innstringDetailsNo
internationalAddressstringИтоговый полный международный адресNo
internationalNamestringМеждународное наименованиеNo
kppstringКППNo
namestringNo
ogrnstringОГРНNo
ogrndatestringДата ОГРНNo
phonestringТелефоныNo
residentbooleanпризнак "Нерезидент"No
shortNamestringСокращенное наименованиеNo

schema.CRMCreateRequest​

NameTypeDescriptionRequired
crmschema.CRMInputNo
projectIdintegerNo

schema.CRMIdRequest​

NameTypeDescriptionRequired
crmidintegerNo

schema.CRMInput​

NameTypeDescriptionRequired
namestringNo
typeschema.CRMTypeNo
urlstringNo

schema.CRMOutput​

NameTypeDescriptionRequired
crmschema.CRMNo

schema.CRMQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo

schema.CRMToggleRequest​

NameTypeDescriptionRequired
crmidintegerNo
enabledbooleanNo

schema.CRMType​

NameTypeDescriptionRequired
schema.CRMTypestring

schema.CRMUpdateRequest​

NameTypeDescriptionRequired
crmschema.CRMInputNo
crmidintegerNo

schema.CRMsOutput​

NameTypeDescriptionRequired
crms[ schema.CRM ]No

schema.CategoriesOutput​

NameTypeDescriptionRequired
categoriesschema.CategoryListNo
graphschema.GraphNo

schema.Category​

NameTypeDescriptionRequired
children[ schema.Category ]TransientNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
isFolderbooleanNo
parentIdintegerNo
projectIdintegerNo
titlestringNo
updatedAtstringNo

schema.CategoryCreateInput​

NameTypeDescriptionRequired
categoryschema.CategoryInputNo
projectIdintegerNo

schema.CategoryDeleteInput​

NameTypeDescriptionRequired
categoryIdintegerNo

schema.CategoryFolderCreateInput​

NameTypeDescriptionRequired
folderschema.CategoryFolderInputNo
projectIdintegerNo

schema.CategoryFolderDeleteInput​

NameTypeDescriptionRequired
folderIdintegerNo
newParentIdintegerNo
recursivebooleanNo

schema.CategoryFolderDeleteOutput​

NameTypeDescriptionRequired
children[ schema.Category ]No
folderschema.CategoryNo
graphschema.GraphNo

schema.CategoryFolderInput​

NameTypeDescriptionRequired
titlestringNo

schema.CategoryFolderOutput​

NameTypeDescriptionRequired
folderschema.CategoryNo
graphschema.GraphNo

schema.CategoryFolderUpdateInput​

NameTypeDescriptionRequired
folderschema.CategoryFolderInputNo
folderIdintegerNo

schema.CategoryGetInput​

NameTypeDescriptionRequired
categoryIdintegerNo

schema.CategoryInput​

NameTypeDescriptionRequired
parentIdintegerNo
titlestringNo

schema.CategoryList​

NameTypeDescriptionRequired
items[ schema.Category ]No
totalCountintegerNo

schema.CategoryOutput​

NameTypeDescriptionRequired
categoryschema.CategoryNo
graphschema.GraphNo

schema.CategoryQuery​

NameTypeDescriptionRequired
isFolderbooleanNo
limitintegerNo
offsetintegerNo
parentIdintegerNo
projectIdintegerInternalNo
recursivebooleanRecursive and ParentId are mutually exclusive.No

schema.CategoryQueryInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.CategoryQueryNo

schema.CategoryUpdateInput​

NameTypeDescriptionRequired
categoryschema.CategoryInputNo
categoryIdintegerNo

schema.Channel​

NameTypeDescriptionRequired
audioMessagesEnabledbooleanNo
audioMessagesEnabledForschema.AudioMessageEnabledForNo
createdAtstringNo
deletedbooleanNo
descriptionstringNo
ednaschema.EdnaChannelNo
facebookschema.FacebookChannelTransientNo
idintegerNo
infobipschema.InfobipChannelNo
iqchatschema.IQChatChannelNo
namestringNo
projectIdintegerNo
telegramschema.TelegramChannelNo
titlestringNo
totalClientsintegerNo
totalOpenTicketsintegerNo
totalTicketsintegerNo
totalsschema.TicketTotalRowDashboardNo
typeschema.ChannelTypelen=64No
updatedAtstringNo
viberschema.ViberChannelNo
vkschema.VKChannelNo

schema.ChannelConfigureInput​

NameTypeDescriptionRequired
audioschema.AudioMessagesInputNo
channelIdintegerNo

schema.ChannelConfigureOutput​

NameTypeDescriptionRequired
channelschema.ChannelNo

schema.ChannelCreateInput​

NameTypeDescriptionRequired
channelschema.ChannelInputNo
projectIdintegerNo

schema.ChannelDeleteInput​

NameTypeDescriptionRequired
channelIdintegerNo

schema.ChannelIdRequest​

NameTypeDescriptionRequired
channelIdintegerNo

schema.ChannelInput​

NameTypeDescriptionRequired
descriptionstringNo
namestringNo
titlestringNo
typeschema.ChannelTypeNo

schema.ChannelList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Channel ]No
totalCountintegerNo

schema.ChannelMyQueryInput​

NameTypeDescriptionRequired
queryschema.ChannelQueryNo

schema.ChannelOutput​

NameTypeDescriptionRequired
channelschema.ChannelNo
graphschema.GraphNo

schema.ChannelQuery​

NameTypeDescriptionRequired
companyIdintegerNo
deletedbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerNo
types[ string ]No
userIdintegerInternalNo

schema.ChannelQueryCompanyInput​

NameTypeDescriptionRequired
companyIdintegerNo
queryschema.ChannelQueryNo

schema.ChannelQueryInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ChannelQueryNo

schema.ChannelType​

NameTypeDescriptionRequired
schema.ChannelTypestring

schema.ChannelUpdateInput​

NameTypeDescriptionRequired
channelschema.ChannelInputNo
channelIdintegerNo

schema.ChannelsOutput​

NameTypeDescriptionRequired
channels[ schema.Channel ]No
graphschema.GraphNo

schema.Chat​

NameTypeDescriptionRequired
changedAtstringNo
channelIdintegerNo
childrenChats[ schema.Chat ]TransientNo
clientIdintegerNo
clientParentIdintegerNo
clientUnreadintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
eventIdintegerLast event id.No
idintegerNo
projectIdintegerNo
systemChatbooleanNo
ticketIdintegerLast ticket id.No
typeschema.ChatTypelen=32No
userIdintegerNo

schema.ChatBot​

NameTypeDescriptionRequired
botIdstringNo
chatBotPlatformIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
projectIdintegerNo
updatedAtstringNo
userIdintegerNo

schema.ChatBotDeleteInput​

NameTypeDescriptionRequired
chatBotIdintegerNo

schema.ChatBotIdInput​

NameTypeDescriptionRequired
botIdintegerNo

schema.ChatBotInput​

NameTypeDescriptionRequired
botIdstringNo
chatBotPlatformIdintegerNo
projectIdintegerNo
userIdintegerNo

schema.ChatBotList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.ChatBot ]No
totalCountintegerNo

schema.ChatBotOutput​

NameTypeDescriptionRequired
chatBotschema.ChatBotNo
graphschema.GraphNo

schema.ChatBotPlatform​

NameTypeDescriptionRequired
bsstokenstringNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
enabledbooleanNo
idintegerNo
loginstringNo
passwordstringNo
projectIdintegerNo
titlestringNo
typeschema.ChatBotPlatformTypeNo
updatedAtstringNo
urlstringNo

schema.ChatBotPlatformCreateInput​

NameTypeDescriptionRequired
chatBotPlatformschema.ChatBotPlatformInputNo
projectIdintegerNo

schema.ChatBotPlatformDeleteInput​

NameTypeDescriptionRequired
chatBotPlatformIdintegerNo

schema.ChatBotPlatformInput​

NameTypeDescriptionRequired
bsstokenstringNo
descriptionstringNo
loginstringNo
passwordstringNo
titlestringNo
typeschema.ChatBotPlatformTypeNo
urlstringNo

schema.ChatBotPlatformList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.ChatBotPlatform ]No
totalCountintegerNo

schema.ChatBotPlatformOutput​

NameTypeDescriptionRequired
chatBotPlatformschema.ChatBotPlatformNo

schema.ChatBotPlatformQuery​

NameTypeDescriptionRequired
enabledbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerInternalNo
qstringNo

schema.ChatBotPlatformQueryInput​

NameTypeDescriptionRequired
queryschema.ChatBotPlatformQueryNo

schema.ChatBotPlatformQueryProjectInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ChatBotPlatformQueryNo

schema.ChatBotPlatformToggleInput​

NameTypeDescriptionRequired
chatBotPlatformIdintegerNo
enabledbooleanNo

schema.ChatBotPlatformType​

NameTypeDescriptionRequired
schema.ChatBotPlatformTypestring

schema.ChatBotPlatformUpdateInput​

NameTypeDescriptionRequired
chatBotPlatformschema.ChatBotPlatformInputNo
chatBotPlatformIdintegerNo

schema.ChatBotPlatformsOutput​

NameTypeDescriptionRequired
chatBotPlatforms[ schema.ChatBotPlatform ]No

schema.ChatBotQuery​

NameTypeDescriptionRequired
deletedbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerInternalNo

schema.ChatBotQueryInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ChatBotQueryNo

schema.ChatBotUpdateInput​

NameTypeDescriptionRequired
chatBotschema.ChatBotInputNo
chatBotIdintegerNo

schema.ChatCreateInput​

NameTypeDescriptionRequired
channelIdintegerNo
chatTypeschema.ChatTypeNo
clientIdintegerNo

schema.ChatIdInput​

NameTypeDescriptionRequired
chatIdintegerNo

schema.ChatList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Chat ]No
totalCountintegerNo

schema.ChatMessage​

NameTypeDescriptionRequired
actions[ schema.Action ]No
authorschema.ActorTypeAuthorNo
botpressPayloadstringNo
chatIdintegerNo
clientIdintegerNo
clientInfostringNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
eventIdintegerNo
fileIdstringNo
fileURLstringNo
idintegerNo
infoRequestIdintegerNo
isDropDownbooleanNo
listenedbooleanNo
listenedAtstringNo
localIdintegerNo
mailingMessageIdintegerNo
mybooleanTransitiveNo
openSystemChatbooleanNo
payloadschema.ChatMessagePayloadTypePayloadNo
productschema.ProductNo
productIdintegerNo
productOfferStateschema.ProductOfferStateNo
pushedbooleanNo
ratingIdintegerNo
readbooleanNo
readAtstringNo
receivedbooleanFlagsNo
receivedAtstringNo
replyToMessageIdintegerNo
singleChoices[ schema.SingleChoice ]No
textstringNo
ticketIdintegerNo
ticketMessageIdintegerNo
userIdintegerNo

schema.ChatMessageInput​

NameTypeDescriptionRequired
actions[ schema.Action ]No
botpressPayloadstringNo
chatTypeschema.ChatTypeNo
closeDialogbooleanNo
emailMessageIdstringid needed to reply to client emailNo
fileIdstringNo
fileURLstringNo
groupIdstringchatbot response optionsNo
isDropDownbooleanNo
linkstringbss chatbot responseNo
localIdintegerNo
locationstringlat,lng pair;No
openSystemDialogbooleanNo
operatorIdstringNo
payloadschema.ChatMessagePayloadTypeNo
replyToMessageIdintegerNo
singleChoices[ schema.SingleChoice ]No
textstringNo
transferToQueuebooleanNo
userIdintegerNo

schema.ChatMessageOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
messageschema.ChatMessageNo

schema.ChatMessagePayloadType​

NameTypeDescriptionRequired
schema.ChatMessagePayloadTypestring

schema.ChatOutput​

NameTypeDescriptionRequired
chatschema.ChatNo
graphschema.GraphNo

schema.ChatQuery​

NameTypeDescriptionRequired
channelIdintegerNo
channelIds[ integer ]No
chatTypeschema.ChatTypeNo
clientIdintegerNo
clientIds[ integer ]No
companyIdintegerNo
connectedbooleanNo
deletedbooleanNo
limitintegerNo
mailingListIdintegerNo
offsetintegerNo
projectIdintegerNo

schema.ChatQueryClientInput​

NameTypeDescriptionRequired
clientIdintegerNo
queryschema.ChatQueryNo

schema.ChatQueryInput​

NameTypeDescriptionRequired
queryschema.ChatSearchQueryNo

schema.ChatSearchQuery​

NameTypeDescriptionRequired
limitintegerNo
offsetintegerNo
projectIds[ integer ]No
qstringNo

schema.ChatSendCompanyInput​

NameTypeDescriptionRequired
channelIdintegerNo
companyIdintegerNo
messageschema.ChatMessageInputNo

schema.ChatSendCompanyOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
messages[ schema.TicketMessage ]No

schema.ChatType​

NameTypeDescriptionRequired
schema.ChatTypestring

schema.Client​

NameTypeDescriptionRequired
avgRatingnumberNo
blockReasonstringNo
blockedbooleanNo
blockedAtstringNo
blockedUntilstringNo
channelIdintegerPolymorphic relation, channel_id + a specific user id.No
channelTypes[ schema.ChannelType ]No
comments[ schema.ClientComment ]No
companies[ schema.Company ]No
createdAtstringNo
crmclientIdstringNo
crmidintegerNo
detailsschema.ClientDetailsNo
ednaIdintegerNo
emailAddrstringfor email channel clientsNo
facebookschema.FacebookUserNo
facebookIdintegerNo
groupNamestringNo
idintegerNo
infoRequestschema.InfoRequestNo
infobipschema.InfobipUserNo
infobipIdintegerNo
lastCommentschema.ClientCommentNo
lastTicketAtstringNo
lastTicketIdintegerNo
markerNamestringNo
markerTypestringloyal or disloyal clientNo
messagedAtstringNo
namestringNo
onlinebooleanNo
parentschema.ClientTransientNo
parentIdintegerNo
personalManagerIdintegerNo
priorityintegerNo
projectschema.ProjectNo
projectIdintegerNo
seenAtstringNo
shortNamestringNo
telegramschema.TelegramUserNo
telegramIdintegerNo
totalOpenTicketsintegerNo
totalTicketsintegerNo
typeschema.ClientTypelen=64No
updatedAtstringNo
userWhoBlockedIdintegerNo
viberschema.ViberUserNo
viberIdstringNo
vkschema.VKUserNo
vkidintegerNo

schema.ClientBanInput​

NameTypeDescriptionRequired
inputschema.BanClientInputNo

schema.ClientChannelQueryInput​

NameTypeDescriptionRequired
channelIdintegerNo
queryschema.ClientQueryNo

schema.ClientComment​

NameTypeDescriptionRequired
authorschema.UsertransientNo
authorIdintegerNo
channelTypeschema.ChannelTypeNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
deletedByUserIdintegerNo
editedAtstringNo
editedByUserIdintegerNo
editedByUsernamestringNo
idintegerNo
projectIdintegerNo
ratingintegerNo
ratingStateschema.RatingStateNo
textstringNo

schema.ClientCommentClientIdInput​

NameTypeDescriptionRequired
clientIdintegerNo

schema.ClientCommentCommentIdInput​

NameTypeDescriptionRequired
commentIdintegerNo

schema.ClientCommentInput​

NameTypeDescriptionRequired
channelTypeschema.ChannelTypeNo
clientIdintegerNo
projectIdintegerNo
ratingintegerNo
ratingStateschema.RatingStateNo
textstringNo
ticketIdintegerNo

schema.ClientCommentInputRequest​

NameTypeDescriptionRequired
inputschema.ClientCommentInputNo

schema.ClientCommentUpdateInput​

NameTypeDescriptionRequired
commentIdintegerNo
inputschema.ClientCommentInputNo

schema.ClientCompanyQueryInput​

NameTypeDescriptionRequired
companyIdintegerNo
queryschema.ClientQueryNo

schema.ClientConnectInput​

NameTypeDescriptionRequired
clientIdintegerNo
parentIdintegerNo

schema.ClientDetailField​

NameTypeDescriptionRequired
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
idintegerNo
namestringNo
positionintegerNo
updatedAtstringNo
valuestringNo

schema.ClientDetails​

NameTypeDescriptionRequired
birthdaystringNo
branchBikstringБИК подразделения банкаNo
branchExtRefstringИдентификатор в АБС подразделения банкаNo
branchIdstringИдентификатор подразделения банка в iSimpleBank 2.0No
branchNamestringНаименование подразделения банкаNo
cardRefstringИдентификатор клиента в карточном бэкNo
cellphonestringNo
clientIdintegerNo
createdAtstringNo
crmurlstringNo
emailstringNo
extRefstringИдентификатор клиента в АБСNo
fields[ schema.ClientDetailField ]TransientNo
firstNamestringNo
innstringNo
lastNamestringNo
middleNamestringNo
sexstringNo
tokenstringNo
updatedAtstringNo

schema.ClientGroup​

NameTypeDescriptionRequired
clientGroupMembers[ schema.ClientGroupMember ]No
clientGroups[ schema.ClientGroup ]TransientNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
idintegerNo
memberTotalsschema.GroupMemberTotalsNo
parentIdintegerNo
priorityintegerNo
projectIdintegerNo
ticketTotalsschema.GroupTicketTotalsDashboardNo
titlestringNo
totalClientGroupsintegerNo
totalMembersintegerNo
totalOnlineMembersintegerNo
totalOpenTicketsintegerNo
totalsschema.TicketTotalRowDeprecatedNo
updatedAtstringNo

schema.ClientGroupClientsOutput​

NameTypeDescriptionRequired
clients[ schema.Client ]No
graphschema.GraphNo

schema.ClientGroupCreateInput​

NameTypeDescriptionRequired
groupschema.ClientGroupInputNo
projectIdintegerNo

schema.ClientGroupIdInput​

NameTypeDescriptionRequired
groupIdintegerNo

schema.ClientGroupIdParentIdInput​

NameTypeDescriptionRequired
groupIdintegerNo
parentIdintegerNo

schema.ClientGroupInput​

NameTypeDescriptionRequired
descriptionstringNo
parentIdintegerNo
priorityintegerNo
titlestringNo

schema.ClientGroupMember​

NameTypeDescriptionRequired
clientschema.ClientNo
clientGroupIdintegerNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
restoredAtstringNo
totalsschema.TicketTotalRowTransientNo
updatedAtstringNo

schema.ClientGroupMemberCreateInput​

NameTypeDescriptionRequired
clientIdintegerNo
groupIdintegerNo

schema.ClientGroupMemberIdInput​

NameTypeDescriptionRequired
memberIdintegerNo

schema.ClientGroupMemberOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
memberschema.ClientGroupMemberNo

schema.ClientGroupMemberQuery​

NameTypeDescriptionRequired
clientGroupIdintegerNo
clientIdintegerNo
clientIds[ integer ]No
onlinebooleanNo
orderstringNo
projectIdintegerInternalNo
qstringNo

schema.ClientGroupMemberQueryByProjectInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ClientGroupMemberQueryNo

schema.ClientGroupMemberQueryInput​

NameTypeDescriptionRequired
clientIdintegerNo

schema.ClientGroupMembersCreateInput​

NameTypeDescriptionRequired
clientIds[ integer ]No
groupIdintegerNo

schema.ClientGroupMembersOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
members[ schema.ClientGroupMember ]No

schema.ClientGroupMembersQueryInput​

NameTypeDescriptionRequired
groupIdintegerNo
queryschema.ClientGroupMemberQueryNo

schema.ClientGroupOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groupschema.ClientGroupNo

schema.ClientGroupQuery​

NameTypeDescriptionRequired
clientGroupIdintegerNo
idintegerNo
membersschema.ClientGroupMemberQueryIncludes members.No
priorityintegerNo
projectIdintegerInternalNo
recursivebooleanIncludes child groups.No

schema.ClientGroupQueryByProjectInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ClientGroupQueryNo

schema.ClientGroupQueryInput​

NameTypeDescriptionRequired
queryschema.ClientGroupQueryNo

schema.ClientGroupUpdateInput​

NameTypeDescriptionRequired
groupschema.ClientGroupInputNo
groupIdintegerNo

schema.ClientGroupsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groups[ schema.ClientGroup ]No

schema.ClientIdInput​

NameTypeDescriptionRequired
clientIdintegerNo

schema.ClientList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Client ]No
totalCountintegerNo

schema.ClientMailingListQueryInput​

NameTypeDescriptionRequired
listIdintegerNo
queryschema.ClientQueryNo

schema.ClientMarkInput​

NameTypeDescriptionRequired
clientMarkerschema.ClientMarkerInputNo

schema.ClientMarkerInput​

NameTypeDescriptionRequired
clientIdintegerNo
markerTypestringNo
projectIdintegerNo
ticketIdintegerNo

schema.ClientOutput​

NameTypeDescriptionRequired
clientschema.ClientNo
graphschema.GraphNo

schema.ClientParentQueryInput​

NameTypeDescriptionRequired
parentIdintegerNo
queryschema.ClientQueryNo

schema.ClientProduct​

NameTypeDescriptionRequired
boughtAtstringNo
clientIdintegerNo
expiresAtstringNo
productIdintegerNo
ticketIdintegerNo

schema.ClientProjectQueryInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ClientQueryNo

schema.ClientQuery​

NameTypeDescriptionRequired
blockedbooleanNo
channelIds[ integer ]No
companyIdintegerNo
groupNamestringNo
limitintegerNo
mailingListIdintegerNo
markerschema.MarkerTypeNo
offsetintegerNo
onlinebooleanNo
parentIdintegerNo
periodschema.PeriodNo
personalManagerIdintegerNo
projectIdintegerNo
qstringNo
rawQstringInternalNo
seenBeforestringNo
sortBystringNo
types[ schema.ClientType ]No
withPersonalManagerbooleanNo
withoutPersonalManagerbooleanNo

schema.ClientQueryInput​

NameTypeDescriptionRequired
queryschema.ClientQueryNo

schema.ClientReport​

NameTypeDescriptionRequired
queryschema.ClientReportQueryNo
rows[ schema.ClientReportRow ]No
totalsschema.ClientReportRowNo

schema.ClientReportDimension​

NameTypeDescriptionRequired
schema.ClientReportDimensionstring

schema.ClientReportQuery​

NameTypeDescriptionRequired
channelIds[ integer ]No
clientTypeschema.ClientTypeNo
dateGroupschema.DateUnitNo
dimensionschema.ClientReportDimensionNo
endstringNo
periodschema.PeriodFiltersNo
projectIdintegerInternalNo
startstringInternalNo

schema.ClientReportRow​

NameTypeDescriptionRequired
channelIdintegerNo
clientTypeschema.ClientTypeNo
datestringDimensionNo
totalActiveintegerMetricsNo
totalNewintegerNo

schema.ClientType​

NameTypeDescriptionRequired
schema.ClientTypestring

schema.ClientsCountInChannel​

NameTypeDescriptionRequired
channelIdintegerNo
channelTitlestringNo
clientsCountintegerNo

schema.CompaniesOutput​

NameTypeDescriptionRequired
companies[ schema.Company ]No

schema.Company​

NameTypeDescriptionRequired
createdAtstringNo
crmidintegerNo
detailsschema.CompanyDetailsTransientNo
extRefstringNo
idintegerNo
namestringNo
projectIdintegerNo
totalMembersintegerNo
updatedAtstringNo

schema.CompanyCreateInput​

NameTypeDescriptionRequired
companyschema.CompanyInputNo
projectIdintegerNo

schema.CompanyDetails​

NameTypeDescriptionRequired
companyIdintegerNo
createdAtstringNo
innstringИННNo
internationalAddressstringИтоговый полный международный адресNo
internationalNamestringМеждународное наименованиеNo
kppstringКППNo
ogrnstringОГРНNo
ogrndatestringДата ОГРНNo
phonestringТелефоныNo
residentbooleanпризнак "Нерезидент"No
shortNamestringСокращенное наименованиеNo
updatedAtstringNo

schema.CompanyIdInput​

NameTypeDescriptionRequired
companyIdintegerNo

schema.CompanyInput​

NameTypeDescriptionRequired
crmidintegerInternalNo
detailsschema.CompanyDetailsNo
extRefstringNo
namestringNo

schema.CompanyList​

NameTypeDescriptionRequired
items[ schema.Company ]No
totalCountintegerNo

schema.CompanyListOutput​

NameTypeDescriptionRequired
listschema.CompanyListNo

schema.CompanyOutput​

NameTypeDescriptionRequired
companyschema.CompanyNo

schema.CompanyProjectQueryInput​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.CompanyQueryNo

schema.CompanyQuery​

NameTypeDescriptionRequired
clientIdintegerInternalNo
limitintegerNo
offsetintegerNo
projectIdintegerNo
qstringNo

schema.CompanyUpdateInput​

NameTypeDescriptionRequired
companyschema.CompanyInputNo
companyIdintegerNo

schema.ConfigureAPNSRequest​

NameTypeDescriptionRequired
apnsschema.IQChatAPNSInputNo
channelIdintegerNo

schema.ConfigureFCMOutput​

NameTypeDescriptionRequired
fcmschema.IQChatFCMNo

schema.ConfigureFCMRequest​

NameTypeDescriptionRequired
channelIdintegerNo
fcmschema.IQChatFCMInputNo

schema.ConfigureIQChatWidgetRequest​

NameTypeDescriptionRequired
channelIdintegerNo
widgetschema.IQChatWidgetInputNo

schema.CorporateChat​

NameTypeDescriptionRequired
adminschema.UserNo
adminIdintegerNo
changedAtstringNo
corporateChatEventIdintegerNo
corporateChatMessageIdintegerLast message id.No
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
initiatedbooleanhas messages from users(not system messsages)No
members[ schema.CorporateChatMember ]No
membersCountintegerNo
myIdintegerNo
otherUserschema.Userfor private chatsNo
secondMemberIdintegertransientNo
titlestringNo
totalMessagesintegerNo
typeschema.CorporateChatTypelen=32No

schema.CorporateChatAction​

NameTypeDescriptionRequired
actorIdintegerUser who made an action.No
commentstringNo
corporateChatIdintegerNo
createdAtstringNo
idintegerNo
textstringTransitiveNo
typeschema.CorporateChatActionTypelen=32No
userIdintegerNo

schema.CorporateChatActionType​

NameTypeDescriptionRequired
schema.CorporateChatActionTypestring

schema.CorporateChatIdInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo

schema.CorporateChatInbox​

NameTypeDescriptionRequired
createdAtstringNo
totalOpenCorporateThreadsintegerNo
totalUnreadCorporateMessagesintegerNo
updatedAtstringNo
userIdintegerIdNo

schema.CorporateChatInboxNotificationType​

NameTypeDescriptionRequired
schema.CorporateChatInboxNotificationTypestring

schema.CorporateChatInboxThread​

NameTypeDescriptionRequired
archivedbooleanNo
corporateChatschema.CorporateChatNo
corporateChatIdintegerNo
createdAtstringNo
idintegerNo
leftbooleanNo
mentioningCheckedbooleanNo
messageSearchResultschema.CorporateChatMessageNo
sortedAtstringNo
totalUnreadCorporateMessagesintegerNo
updatedAtstringNo
userIdintegerNo

schema.CorporateChatInboxThreadIdInput​

NameTypeDescriptionRequired
corporateChatInboxThreadIdintegerNo

schema.CorporateChatInboxThreadList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.CorporateChatInboxThread ]No
totalCountintegerNo

schema.CorporateChatInboxThreadOutput​

NameTypeDescriptionRequired
corporateChatThreadschema.CorporateChatInboxThreadNo
corporateChatTypingschema.TypingCorporateChatMessageNo
graphschema.GraphNo

schema.CorporateChatInboxThreadProjectQueryInput​

NameTypeDescriptionRequired
queryschema.CorporateChatInboxThreadQueryNo
userIdintegerNo

schema.CorporateChatInboxThreadQuery​

NameTypeDescriptionRequired
archivedbooleanArchived inbox thread.No
corporateChatIds[ integer ]No
corporateChatTypeschema.CorporateChatTypeNo
leftbooleanNo
limitintegerNo
offsetintegerNo
orderschema.InboxThreadOrderNo
projectIdintegerNo
qstringNo
userIdintegerInternalNo

schema.CorporateChatInboxThreadQueryInput​

NameTypeDescriptionRequired
queryschema.CorporateChatInboxThreadQueryNo

schema.CorporateChatInboxUserIdInput​

NameTypeDescriptionRequired
userIdintegerNo

schema.CorporateChatInput​

NameTypeDescriptionRequired
memberIds[ integer ]No
titlestringNo

schema.CorporateChatInputOutput​

NameTypeDescriptionRequired
corporateChatInboxschema.CorporateChatInboxNo

schema.CorporateChatInputRequest​

NameTypeDescriptionRequired
inputschema.CorporateChatInputNo

schema.CorporateChatInviteInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo
userIds[ integer ]No

schema.CorporateChatKickInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo
corporateChatMemberIds[ integer ]No

schema.CorporateChatList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.CorporateChat ]No
totalCountintegerNo

schema.CorporateChatMember​

NameTypeDescriptionRequired
corporateChatIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
mebooleanTransientNo
updatedAtstringNo
userIdintegerNo

schema.CorporateChatMemberList​

NameTypeDescriptionRequired
graphschema.GraphNo
members[ schema.CorporateChatMember ]No
totalCountintegerNo

schema.CorporateChatMemberOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
memberschema.CorporateChatMemberNo

schema.CorporateChatMemberQuery​

NameTypeDescriptionRequired
activebooleanNo
corporateChatIdintegerNo
countTotalsbooleanNo
deletedbooleanNo
excludeIds[ integer ]No
excludeMebooleanNo
idintegerNo
limitintegerNo
offsetintegerNo
onlinebooleanNo
orderschema.UserOrderByNo
qstringOptional search query.sNo
seenBeforestringNo
userIdintegerNo

schema.CorporateChatMemberQueryInput​

NameTypeDescriptionRequired
queryschema.CorporateChatMemberQueryNo

schema.CorporateChatMessage​

NameTypeDescriptionRequired
actionschema.CorporateChatActionNo
actionIdintegerNo
corporateChatEventIdintegerNo
corporateChatIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
fileIdstringNo
fileURLstringNo
idintegerNo
listenedbooleanNo
listenedAtstringNo
localIdintegerNo
mentionedUserIdssets.Int64No
mybooleanTransitiveNo
pushedbooleanNo
readbooleanNo
readAtstringNo
receivedbooleanFlagsNo
receivedAtstringNo
replyToMessageIdintegerNo
textstringNo
typeschema.CorporateChatMessagePayloadTypePayloadNo
uidstringNo
updatedAtstringNo
userschema.UserNo
userIdintegerNo

schema.CorporateChatMessageCreateInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo
corporateChatMessageschema.CorporateChatMessageInputNo

schema.CorporateChatMessageIdInput​

NameTypeDescriptionRequired
corporateChatMessageIdintegerNo

schema.CorporateChatMessageInput​

NameTypeDescriptionRequired
actionschema.CorporateChatActionNo
actionIdintegerNo
fileIdstringNo
localIdintegerNo
mentionedUserIds[ integer ]No
replyToMessageIdintegerNo
textstringNo
typeschema.CorporateChatMessagePayloadTypeNo

schema.CorporateChatMessageList​

NameTypeDescriptionRequired
corporateChatMessages[ schema.CorporateChatMessage ]No
graphschema.GraphNo
totalCountintegerNo

schema.CorporateChatMessageListInput​

NameTypeDescriptionRequired
corporateChatMessageIdintegerNo

schema.CorporateChatMessageOutput​

NameTypeDescriptionRequired
corporateChatMessageschema.CorporateChatMessageNo
graphschema.GraphNo

schema.CorporateChatMessagePayloadType​

NameTypeDescriptionRequired
schema.CorporateChatMessagePayloadTypestring

schema.CorporateChatMessageQuery​

NameTypeDescriptionRequired
corporateChatIdintegerChatId and TicketId are mutually exclusive.No
deletedbooleanNo
descbooleanNo
fromIdintegerNo
limitintegerNo
offsetintegerNo
qstringNo
readbooleanNo
receiverIdintegerNo
untilIdintegerNo
userIdintegerNo

schema.CorporateChatMessageQueryInput​

NameTypeDescriptionRequired
queryschema.CorporateChatMessageQueryNo

schema.CorporateChatMessageSlice​

NameTypeDescriptionRequired
graphschema.GraphNo
head[ schema.CorporateChatMessage ]No
moreCountintegerNo
tail[ schema.CorporateChatMessage ]No
totalCountintegerNo

schema.CorporateChatMessagesDeleteInput​

NameTypeDescriptionRequired
chatIdintegerNo
messageIds[ integer ]No

schema.CorporateChatMessagesReceivedInput​

NameTypeDescriptionRequired
corporateChatMessageIds[ integer ]No

schema.CorporateChatMessagesSliceInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo
queryschema.CorporateChatMessageQueryNo

schema.CorporateChatOpenInput​

NameTypeDescriptionRequired
secondMemberIdintegerNo

schema.CorporateChatOutput​

NameTypeDescriptionRequired
corporateChatschema.CorporateChatNo
graphschema.GraphNo

schema.CorporateChatSearchQueryInput​

NameTypeDescriptionRequired
schema.CorporateChatSearchQueryInputobject

schema.CorporateChatStreamOutput​

NameTypeDescriptionRequired
corporateChatschema.CorporateChatNo
corporateChatMemberschema.CorporateChatMemberNo
corporateChatMessageschema.CorporateChatMessageNo
corporateChatTypingschema.TypingCorporateChatMessageNo
graphschema.GraphNo

schema.CorporateChatTransferInput​

NameTypeDescriptionRequired
corporateChatIdintegerNo
corporateChatMemberIdintegerNo

schema.CorporateChatType​

NameTypeDescriptionRequired
schema.CorporateChatTypestring

schema.CorporateChatUserIdInput​

NameTypeDescriptionRequired
userIdintegerNo

schema.CorporateChatUserIdsInput​

NameTypeDescriptionRequired
userIds[ integer ]No

schema.CorporateNotification​

NameTypeDescriptionRequired
corporateChatIdintegerNo
corporateChatMessageIdintegerNo
createdAtstringNo
fromstringname of agentNo
idintegerNo
resolvedbooleanNo
textstringTransientNo
typeschema.CorporateChatInboxNotificationTypeNo
updatedAtstringNo
userIdintegerNo

schema.CorporateNotificationsOutput​

NameTypeDescriptionRequired
corporateNotificationschema.CorporateNotificationNo
graphschema.GraphNo

schema.DashboardDailyOutput​

NameTypeDescriptionRequired
rows[ schema.DashboardDailyRow ]No

schema.DashboardDailyQuery​

NameTypeDescriptionRequired
periodschema.PeriodNo
projectIdintegerInternalNo

schema.DashboardDailyRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.DashboardDailyQueryNo

schema.DashboardDailyRow​

NameTypeDescriptionRequired
datestringNo
totalTicketsintegerNo

schema.DashboardProjectIdRequest​

NameTypeDescriptionRequired
projectIdintegerNo

schema.DashboardQueryOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
slstatschema.SLStatNo
tickets[ schema.Ticket ]No

schema.DashboardQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.DashboardTicketQueryNo

schema.DashboardSettingsRequest​

NameTypeDescriptionRequired
settingsschema.ResponseTimeSettingsInputNo

schema.DashboardTicketByCategoryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TicketQueryNo

schema.DashboardTicketQuery​

NameTypeDescriptionRequired
descbooleanNo
limitintegerNo
periodschema.PeriodNo

schema.DateUnit​

NameTypeDescriptionRequired
schema.DateUnitstring

schema.EdnaCascade​

NameTypeDescriptionRequired
idintegerNo
namestringNo
stagesCountintegerNo
statusstringNo

schema.EdnaChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerMatches channel id.No
restoredAtstringNo
updatedAtstringNo
uuidstringlen=36No

schema.EdnaConfig​

NameTypeDescriptionRequired
apiKeystringNo
cascadeIdstringNo
channelIdintegerNo
urlstringNo
webhookURLstringTransientNo

schema.EdnaConfigInput​

NameTypeDescriptionRequired
apiKeystringNo
cascadeIdstringNo
urlstringNo

schema.EdnaConfigureRequest​

NameTypeDescriptionRequired
channelIdintegerNo
configschema.EdnaConfigInputNo

schema.EdnaOutput​

NameTypeDescriptionRequired
configschema.EdnaConfigNo

schema.EmailChannelConfig​

NameTypeDescriptionRequired
channelIdintegerlen=255No
deleteAfterbooleanNo
emailstringNo
headerTemplatestringNo
imapaddrstringNo
imapportstringNo
loginstringNo
passwordstringNo
signatureTemplatestringNo
smtpaddrstringNo
smtpportstringNo

schema.EmailChannelConfigInput​

NameTypeDescriptionRequired
deleteAfterbooleanNo
emailstringNo
headerTemplatestringNo
loginstringNo
passwordstringNo
signatureTemplatestringNo

schema.EmailChannelServersConfigInput​

NameTypeDescriptionRequired
imapaddrstringNo
imapportstringNo
smtpaddrstringNo
smtpportstringNo

schema.EmailChannelsRequest​

NameTypeDescriptionRequired
channelIdintegerNo
inputschema.EmailChannelConfigInputNo

schema.EmailChannelsServerRequest​

NameTypeDescriptionRequired
channelIdintegerNo
inputschema.EmailChannelServersConfigInputNo

schema.Error​

NameTypeDescriptionRequired
codeschema.ErrorCodeNo
textstringNo

schema.ErrorCode​

NameTypeDescriptionRequired
schema.ErrorCodestring

schema.ExportAnalyticDetailsInput​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
queryschema.AnalyticsDetailsQueryNo

schema.ExportAnalyticsInput​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
queryschema.AnalyticsQueryNo

schema.ExportAnalyticsSubreportInput​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
queryschema.AnalyticsSubreportQueryNo

schema.ExportFormat​

NameTypeDescriptionRequired
schema.ExportFormatstring

schema.FacebookChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
pageIdstringlen=255No
pageNamestringlen=1024No
restoredAtstringNo
updatedAtstringNo
uuidstringlen=36No

schema.FacebookConfig​

NameTypeDescriptionRequired
channelIdintegerNo
pageTokenstringlen=255No
verifyTokenstringlen=255No
webhookURLstringTransientNo

schema.FacebookConfigOutput​

NameTypeDescriptionRequired
configschema.FacebookConfigNo

schema.FacebookPageTokenRequest​

NameTypeDescriptionRequired
channelIdintegerNo
pageTokenstringNo

schema.FacebookUser​

NameTypeDescriptionRequired
channelIdintegerNo
createdAtstringNo
firstNamestringlen=255No
genderstringlen=6No
idintegerNo
lastNamestringlen=255No
profilePicturestringlen=255No
updatedAtstringNo
userIdstringFacebook dataNo

schema.FacebookVerifyTokenRequest​

NameTypeDescriptionRequired
channelIdintegerNo
verifyTokenstringNo

schema.File​

NameTypeDescriptionRequired
clientIdintegerNo
contentTypestringlen=128No
createdAtstringNo
idstringlen=255No
imageHeightintegerNo
imageWidthintegerNo
namestringOriginal file name.No
ownerschema.FileOwnerTypeNo
ownerClientIdintegerNo
pathstringRelative filesystem pathNo
sizeintegerSize in bytesNo
typeschema.ActorTypelen=255No
userIdintegerNo

schema.FileIdRequest​

NameTypeDescriptionRequired
fileIdstringNo

schema.FileOutput​

NameTypeDescriptionRequired
fileschema.FileNo
graphschema.GraphNo

schema.FileOwnerType​

NameTypeDescriptionRequired
schema.FileOwnerTypestring

schema.FileType​

NameTypeDescriptionRequired
schema.FileTypestring

schema.FileUploadInput​

NameTypeDescriptionRequired
schema.FileUploadInputobject

schema.GatewaySendToAbsRefRequest​

NameTypeDescriptionRequired
absRefstringNo
channelstringNo
messageschema.ChatMessageInputNo

schema.GatewaySendToCRMRefRequest​

NameTypeDescriptionRequired
channelstringNo
crmrefstringNo
messageschema.ChatMessageInputNo

schema.GatewaySendToCardRefRequest​

NameTypeDescriptionRequired
cardRefstringNo
channelstringNo
messageschema.ChatMessageInputNo

schema.GatewaySendToClientRequest​

NameTypeDescriptionRequired
channelstringNo
clientIdintegerNo
messageschema.ChatMessageInputNo

schema.GatewaySendToINNRequest​

NameTypeDescriptionRequired
channelstringNo
innstringNo
messageschema.ChatMessageInputNo

schema.GetEdnaCascadesRequest​

NameTypeDescriptionRequired
channelIdintegerNo
limitintegerNo
offsetintegerNo

schema.GlobalPermissions​

NameTypeDescriptionRequired
schema.GlobalPermissionsobject

schema.Graph​

NameTypeDescriptionRequired
assigneeschema.UserNo
categories[ schema.Category ]No
channels[ schema.Channel ]No
chatBotPlatforms[ schema.ChatBotPlatform ]No
chatMessages[ schema.ChatMessage ]No
chats[ schema.Chat ]No
clientDetails[ schema.ClientDetails ]No
clientGroups[ schema.ClientGroup ]No
clients[ schema.Client ]No
companies[ schema.Company ]No
corporateChatMessages[ schema.CorporateChatMessage ]No
corporateChats[ schema.CorporateChat ]No
crmcustomers[ schema.CRMClient ]No
files[ schema.File ]No
groups[ schema.Group ]No
inbox[ schema.Inbox ]No
infoRequests[ schema.InfoRequest ]No
orgs[ schema.Org ]No
personalManagers[ schema.PersonalManager ]No
projects[ schema.Project ]No
ratings[ schema.Rating ]No
targetViolations[ schema.TargetViolation ]No
targets[ schema.Target ]No
ticketActions[ schema.TicketAction ]No
ticketMembers[ schema.TicketMember ]No
ticketMessages[ schema.TicketMessage ]No
tickets[ schema.Ticket ]No
totalAssignedToBotintegerNo
userRoles[ schema.UserRole ]No
userSkills[ schema.UserSkill ]No
users[ schema.User ]No
wikiLinksschema.WikiLinksNo

schema.Group​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
groups[ schema.Group ]TransientNo
idintegerNo
memberTotalsschema.GroupMemberTotalsNo
members[ schema.GroupMember ]No
parentIdintegerNo
projectschema.ProjectNo
projectIdintegerNo
ticketTotalsschema.GroupTicketTotalsDashboardNo
titlestringNo
totalGroupsintegerNo
totalMembersintegerNo
totalOnlineMembersintegerNo
totalOpenTicketsintegerNo
totalsschema.TicketTotalRowDeprecatedNo
updatedAtstringNo

schema.GroupCreateRequest​

NameTypeDescriptionRequired
groupschema.GroupInputNo
projectIdintegerNo

schema.GroupIdRequest​

NameTypeDescriptionRequired
groupIdintegerNo

schema.GroupInput​

NameTypeDescriptionRequired
descriptionstringNo
parentIdintegerNo
titlestringNo

schema.GroupMember​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
groupIdintegerNo
idintegerNo
restoredAtstringNo
totalsschema.TicketTotalRowTransientNo
updatedAtstringNo
userschema.UserNo
userIdintegerNo

schema.GroupMemberCreateRequest​

NameTypeDescriptionRequired
groupIdintegerNo
userIdintegerNo

schema.GroupMemberDeleteRequest​

NameTypeDescriptionRequired
memberIdintegerNo

schema.GroupMemberOrder​

NameTypeDescriptionRequired
schema.GroupMemberOrderstring

schema.GroupMemberOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
memberschema.GroupMemberNo

schema.GroupMemberQuery​

NameTypeDescriptionRequired
activebooleanNo
busybooleanNo
currentUserIdintegerNo
groupIdintegerNo
groupIds[ integer ]No
onlinebooleanNo
onlyMebooleanNo
orderschema.GroupMemberOrderNo
projectIdintegerInternalNo
qstringNo
scheduleIds[ integer ]No
skipMebooleanSkips the current user id, CurrentUserId must be filled.No
typeschema.UserTypeNo
userIdintegerNo
userIds[ integer ]No

schema.GroupMemberQueryByProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.GroupMemberQueryNo

schema.GroupMemberQueryRequest​

NameTypeDescriptionRequired
groupIdintegerNo
queryschema.GroupMemberQueryNo

schema.GroupMemberTotals​

NameTypeDescriptionRequired
activeMembersintegerNo
groupIdintegerNo
inactiveMembersintegerNo
onlineMembersintegerNo

schema.GroupMembersOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
members[ schema.GroupMember ]No

schema.GroupMoveRequest​

NameTypeDescriptionRequired
groupIdintegerNo
parentIdintegerNo

schema.GroupOptions​

NameTypeDescriptionRequired
receiveProjectNotificationsbooleanNo

schema.GroupOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groupschema.GroupNo

schema.GroupPermissionsCreateRequest​

NameTypeDescriptionRequired
groupschema.GroupPermissionsInputNo
projectIdintegerNo

schema.GroupPermissionsInput​

NameTypeDescriptionRequired
adminbooleanNo
descriptionstringNo
optionsschema.GroupOptionsNo
parentIdintegerNo
permissionsschema.ProjectPermissionsNo
titlestringNo

schema.GroupPermissionsMoveRequest​

NameTypeDescriptionRequired
groupIdintegerNo
parentIdintegerNo

schema.GroupPermissionsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groupschema.GroupNo

schema.GroupPermissionsQuery​

NameTypeDescriptionRequired
groupIdintegerNo
membersschema.GroupMemberQueryIncludes members.No
projectIdintegerInternalNo
recursivebooleanIncludes child groups.No

schema.GroupPermissionsQueryByProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.GroupPermissionsQueryNo

schema.GroupPermissionsQueryRequest​

NameTypeDescriptionRequired
queryschema.GroupPermissionsQueryNo

schema.GroupPermissionsUpdateRequest​

NameTypeDescriptionRequired
groupschema.GroupPermissionsInputNo
groupIdintegerNo

schema.GroupQuery​

NameTypeDescriptionRequired
groupIdintegerNo
membersschema.GroupMemberQueryIncludes members.No
projectIdintegerInternalNo
recursivebooleanIncludes child groups.No

schema.GroupQueryByProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.GroupQueryNo

schema.GroupQueryRequest​

NameTypeDescriptionRequired
queryschema.GroupQueryNo

schema.GroupTicketTotals​

NameTypeDescriptionRequired
groupIdintegerNo
inProgressTicketsintegerNo
openTicketsintegerNo
pendingTicketsintegerNo

schema.GroupUpdateRequest​

NameTypeDescriptionRequired
groupschema.GroupInputNo
groupIdintegerNo

schema.GroupUsersQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.GroupMemberQueryNo

schema.GroupsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groups[ schema.Group ]No

schema.GroupsPermissionsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
groups[ schema.Group ]No

schema.HelpDeskTicketInput​

NameTypeDescriptionRequired
clientIdintegerNo
descriptionstringNo
messageIds[ integer ]No
projectIdintegerNo
ticketIdintegerNo
userIdintegerNo

schema.IQChatAPNS​

NameTypeDescriptionRequired
certificatestringP12No
channelIdintegerPrimary key.No
createdAtstringNo
enabledbooleanNo
keystringtextNo
p8KeystringP8No
p8KeyIDstringlen=255No
p8TeamIDstringlen=255No
passwordstringlen=255No
productionbooleanNo
topicstringlen=255No
typeschema.IQChatAPNSTypeNo
updatedAtstringNo

schema.IQChatAPNSInput​

NameTypeDescriptionRequired
certificatestringP12No
enabledbooleanNo
keystringNo
p8KeystringP8No
p8KeyIDstringNo
p8TeamIDstringNo
passwordstringNo
productionbooleanNo
topicstringNo
typeschema.IQChatAPNSTypeNo

schema.IQChatAPNSOutput​

NameTypeDescriptionRequired
apnsschema.IQChatAPNSNo

schema.IQChatAPNSType​

NameTypeDescriptionRequired
schema.IQChatAPNSTypestring

schema.IQChatChannel​

NameTypeDescriptionRequired
apnsschema.IQChatAPNSTransientNo
channelIdintegerPrimary key.No
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
restoredAtstringNo
updatedAtstringNo

schema.IQChatChannelOutput​

NameTypeDescriptionRequired
channelschema.IQChatChannelNo
graphschema.GraphNo

schema.IQChatFCM​

NameTypeDescriptionRequired
channelIdintegerPrimary keyNo
createdAtstringNo
enabledbooleanNo
settingsstringNo
updatedAtstringNo

schema.IQChatFCMInput​

NameTypeDescriptionRequired
enabledbooleanNo
settingsstringNo

schema.IQChatWidget​

NameTypeDescriptionRequired
channelIdintegerPrimary keyNo
createdAtstringNo
greetingstringNo
greetingBoldstringNo
styleCodestringNo
styleEnabledbooleanNo
styleTypeschema.IQChatWidgetStyleTypeNo
styleURLstringNo
updatedAtstringNo

schema.IQChatWidgetInput​

NameTypeDescriptionRequired
greetingstringNo
greetingBoldstringNo
styleCodestringNo
styleEnabledbooleanNo
styleTypeschema.IQChatWidgetStyleTypeNo
styleURLstringNo

schema.IQChatWidgetRequest​

NameTypeDescriptionRequired
widgetschema.IQChatWidgetNo

schema.IQChatWidgetStyleType​

NameTypeDescriptionRequired
schema.IQChatWidgetStyleTypestring

schema.Inbox​

NameTypeDescriptionRequired
createdAtstringNo
totalOpenThreadsintegerNo
totalUnreadMessagesintegerNo
updatedAtstringNo
userIdintegerIdNo

schema.InboxGetThreadRequest​

NameTypeDescriptionRequired
inboxThreadIdintegerNo

schema.InboxNotification​

NameTypeDescriptionRequired
messageIdintegerNo
textstringNo
ticketIdintegerNo
titlestringTransientNo
typeschema.InboxNotificationTypeNo
userIdintegerNo

schema.InboxNotificationType​

NameTypeDescriptionRequired
schema.InboxNotificationTypestring

schema.InboxNotificationsOutput​

NameTypeDescriptionRequired
notificationschema.InboxNotificationNo

schema.InboxQueryMyRequest​

NameTypeDescriptionRequired
queryschema.InboxThreadQueryNo

schema.InboxQueryThreadsByUserRequest​

NameTypeDescriptionRequired
queryschema.InboxThreadQueryNo
userIdintegerNo

schema.InboxThread​

NameTypeDescriptionRequired
archivedbooleanNo
createdAtstringNo
idintegerNo
leftbooleanNo
sortedAtstringNo
ticketIdintegerNo
totalUnreadintegerNo
updatedAtstringNo
userIdintegerNo

schema.InboxThreadList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.InboxThread ]No
totalCountintegerNo

schema.InboxThreadOrder​

NameTypeDescriptionRequired
schema.InboxThreadOrderstring

schema.InboxThreadOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
threadschema.InboxThreadNo

schema.InboxThreadQuery​

NameTypeDescriptionRequired
archivedbooleanArchived inbox thread.No
assignedToMebooleanSets AssigneeId to the current user.No
assigneeIdintegerNo
channelIdintegerNo
chatTypeschema.ChatTypeNo
leftbooleanNo
limitintegerNo
offsetintegerNo
openbooleanOpen ticket.No
orderschema.InboxThreadOrderNo
projectIdintegerNo
ticketIdintegerNo
userIdintegerInternalNo

schema.InfoBipConfigOutput​

NameTypeDescriptionRequired
configschema.InfobipConfigNo

schema.InfoBipConfigRequest​

NameTypeDescriptionRequired
channelIdintegerNo
configschema.InfobipConfigInputNo

schema.InfoRequest​

NameTypeDescriptionRequired
clientConsentbooleanсогласие на обработку данныхNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
emailstringNo
fields[ schema.InfoRequestField ]No
idintegerNo
namestringNo
phonestringNo
processingDataLinkstringNo
projectIdintegerNo
stateschema.InfoRequestStateNo
ticketIdintegerNo
updatedAtstringNo
userIdintegerNo

schema.InfoRequestField​

NameTypeDescriptionRequired
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
idintegerNo
namestringNo
positionintegerNo
updatedAtstringNo
valuestringNo

schema.InfoRequestState​

NameTypeDescriptionRequired
schema.InfoRequestStatestring

schema.InfobipChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerMatches channel id.No
phonestringNo
restoredAtstringNo
updatedAtstringNo
uuidstringlen=36No

schema.InfobipConfig​

NameTypeDescriptionRequired
channelIdintegerNo
passwordstringNo
phonestringNo
scenarioKeystringNo
urlstringNo
usernamestringNo
webhookURLstringTransientNo

schema.InfobipConfigInput​

NameTypeDescriptionRequired
passwordstringNo
phonestringNo
urlstringNo
usernamestringNo

schema.InfobipUser​

NameTypeDescriptionRequired
createdAtstringNo
idintegerNo
namestringNo
phonestringNo
updatedAtstringNo

schema.InputOutput​

NameTypeDescriptionRequired
inboxschema.InboxNo

schema.LDAPDirectory​

NameTypeDescriptionRequired
attrDisplayNamestringNo
attrEmailstringNo
attrFirstNamestringNo
attrLastNamestringNo
attrLoginstringNo
baseDNstringNo
createdAtstringNo
deletedbooleanNo
filterstringNo
hostnamestringNo
idintegerNo
namestringNo
passwordstringNo
portintegerNo
updatedAtstringNo
useSSLbooleanNo
usernamestringNo

schema.LDAPDirectoryInput​

NameTypeDescriptionRequired
attrDisplayNamestringNo
attrEmailstringNo
attrFirstNamestringNo
attrLastNamestringNo
attrLoginstringNo
baseDNstringNo
filterstringNo
hostnamestringNo
namestringNo
passwordstringNo
portintegerNo
useSSLbooleanNo
usernamestringNo

schema.License​

NameTypeDescriptionRequired
createdAtstringNo
currentbooleanNo
expiredbooleanNo
idintegerNo
termsschema.LicenseTermsTransientNo
updatedAtstringNo

schema.LicenseKeyRequest​

NameTypeDescriptionRequired
keystringNo

schema.LicenseOutput​

NameTypeDescriptionRequired
licenseschema.LicenseNo

schema.LicenseTerms​

NameTypeDescriptionRequired
activeDirectorybooleanNo
audioMessagesEnabledbooleanNo
autogeneratedbooleanNo
channelTypes[ schema.ChannelType ]No
chatbooleanDeprecated: use ChannelTypes with ChannelTypeIQChat insteadNo
chatBotPlatformTypes[ schema.ChatBotPlatformType ]No
chatBotsEnabledbooleanNo
corporateChatEnabledbooleanNo
corporateChatUsersinteger0 means unlimitedNo
enableChatBotExtensionsbooleanNo
enableChatBotFaqbooleanNo
enableChatBotWorkflowbooleanNo
expiresAtstringNo
helpDeskEnabledbooleanNo
helpDeskIntegrationTypes[ string ]No
iqprobooleanPro version with additional functionalitiesNo
mailingListsbooleanNo
mailingsbooleanNo
personalManagersEnabledbooleanNo
personalManagersOnlineinteger0 means unlimited.No
postManagementEnabledbooleanNo
productShowcasebooleanвитрина продуктовNo
projectsinteger0 means unlimited.No
publicFunctionTypes[ string ]No
publicsCountintegerNo
ratingPollsbooleanNo
reportsbooleanNo
serverIdstringNo
socialbooleanDeprecated: use ChannelTypes with allowed channel types insteadNo
titlestringNo
typeschema.LicenseTypeNo
uniqueChatBotsinteger0 means unlimitedNo
usersinteger0 means unlimited.No

schema.LicenseType​

NameTypeDescriptionRequired
schema.LicenseTypestring

schema.Mailing​

NameTypeDescriptionRequired
channelIdssets.Int64No
createdAtstringNo
deletedAtstringNo
idintegerNo
mailingListschema.MailingListtransientNo
mailingListIdintegerNo
projectIdintegerNo
stateschema.MailingStateNo
titlestringNo
totalRecipientsintegerNo
updatedAtstringNo
userIdintegerNo

schema.MailingCreateRequest​

NameTypeDescriptionRequired
mailingschema.MailingInputNo
projectIdintegerNo

schema.MailingIdRequest​

NameTypeDescriptionRequired
mailingIdintegerNo

schema.MailingInput​

NameTypeDescriptionRequired
channelIdssets.Int64No
mailingListIdintegerNo
titlestringNo
userIdintegerNo

schema.MailingList​

NameTypeDescriptionRequired
addBystringNo
channelIdssets.Int64No
clientsInChannels[ schema.ClientsCountInChannel ]transientNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
projectIdintegerNo
titlestringNo
totalRecipientsintegerNo
updatedAtstringNo

schema.MailingListDeleteClientsRequest​

NameTypeDescriptionRequired
clientIds[ integer ]No
listIdintegerNo

schema.MailingListIdRequest​

NameTypeDescriptionRequired
listIdintegerNo

schema.MailingListOutput​

NameTypeDescriptionRequired
channelIdssets.Int64No
clientsAddedintegerNo
clientsMissingintegerNo
duplicatesintegerNo
totalRecipientsintegerNo

schema.MailingListResponseOutput​

NameTypeDescriptionRequired
listschema.MailingListNo
outputschema.MailingListOutputNo

schema.MailingListUpdateRequest​

NameTypeDescriptionRequired
schema.MailingListUpdateRequestobject

schema.MailingMessage​

NameTypeDescriptionRequired
createdAtstringNo
fileIdstringlen=255No
idintegerNo
mailingIdintegerNo
readCountintegerNo
senderIdintegerUser who sent a message.No
sentAtstringNo
sentCountintegerNo
stateschema.MailingMessageStateNo
textstringNo
totalRecipientsintegerNo
typeschema.MailingMessageTypeNo
unreadCountintegerNo
updatedAtstringNo
userIdintegerUser visible to clients.No

schema.MailingMessageCreateRequest​

NameTypeDescriptionRequired
mailingIdintegerNo
messageschema.MailingMessageInputNo

schema.MailingMessageIdRequest​

NameTypeDescriptionRequired
messageIdintegerNo

schema.MailingMessageInput​

NameTypeDescriptionRequired
fileIdstringNo
textstringNo
totalRecipientsintegerNo
typeschema.MailingMessageTypeNo

schema.MailingMessageOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
messageschema.MailingMessageNo

schema.MailingMessageQuery​

NameTypeDescriptionRequired
descbooleanNo
fromIdintegerid > from_idNo
limitintegerNo
mailingIdintegerInternalNo
offsetintegerNo
stateschema.MailingMessageStateNo
untilIdintegerid < until_idNo

schema.MailingMessageState​

NameTypeDescriptionRequired
schema.MailingMessageStatestring

schema.MailingMessageType​

NameTypeDescriptionRequired
schema.MailingMessageTypestring

schema.MailingMessagesOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
messages[ schema.MailingMessage ]No

schema.MailingMessagesRequest​

NameTypeDescriptionRequired
mailingIdintegerNo
queryschema.MailingMessageQueryNo

schema.MailingOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
mailingschema.MailingNo

schema.MailingReadClientOutput​

NameTypeDescriptionRequired
items[ schema.MailingsReadClients ]No

schema.MailingReadClientQueryRequest​

NameTypeDescriptionRequired
queryschema.MailingsReadClientsQueryNo

schema.MailingReadClientsList​

NameTypeDescriptionRequired
items[ schema.MailingsReadClientsList ]No

schema.MailingState​

NameTypeDescriptionRequired
schema.MailingStatestring

schema.MailingUpdateRequest​

NameTypeDescriptionRequired
mailingschema.MailingInputNo
mailingIdintegerNo

schema.MailingsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
mailings[ schema.Mailing ]No

schema.MailingsReadClients​

NameTypeDescriptionRequired
clientschema.ClientTransientNo
clientIdintegerNo
createdAtstringNo
idintegerNo
mailingIdintegerNo
mailingMessageIdintegerNo
readbooleanNo
readAtstringNo
sentbooleanNo
sentAtstringNo
updatedAtstringNo

schema.MailingsReadClientsList​

NameTypeDescriptionRequired
clientIdintegerNo
createdAtstringNo
idintegerNo
mailingIdintegerNo
mailingMessageIdintegerNo
readbooleanNo
readAtstringNo
sentbooleanNo
sentAtstringNo
textstringNo
updatedAtstringNo
userschema.UserTransientNo
userIdintegerNo

schema.MailingsReadClientsQuery​

NameTypeDescriptionRequired
clientIdintegerNo
limitintegerNo
listbooleanNo
mailingIdintegerNo
mailingMessageIdintegerNo
offsetintegerNo
readbooleanNo
sentbooleanNo
unreadbooleanNo

schema.Marker​

NameTypeDescriptionRequired
createdAtstringNo
greenMarkerNamestringNo
idintegerNo
projectIdintegerNo
redMarkerNamestringNo
updatedAtstringNo

schema.MarkerCreateRequest​

NameTypeDescriptionRequired
markerschema.MarkerInputNo

schema.MarkerInput​

NameTypeDescriptionRequired
greenMarkerNamestringNo
projectIdintegerNo
redMarkerNamestringNo

schema.MarkerTagIdRequest​

NameTypeDescriptionRequired
tagIdintegerNo

schema.MarkerTagQueryRequest​

NameTypeDescriptionRequired
queryschema.TagQueryNo

schema.MarkerTagRequest​

NameTypeDescriptionRequired
tagschema.TagInputNo

schema.MarkerType​

NameTypeDescriptionRequired
schema.MarkerTypestring

schema.MarkerUpdateRequest​

NameTypeDescriptionRequired
markerschema.MarkerInputNo

schema.Notification​

NameTypeDescriptionRequired
createdAtstringNo
idintegerNo
resolvedbooleanNo
targetViolationIdintegerNo
textstringTransientNo
typeschema.NotificationTypeNo
updatedAtstringNo
userIdintegerNo

schema.NotificationInbox​

NameTypeDescriptionRequired
createdAtstringNo
unresolvedintegerNo
updatedAtstringNo
userIdintegerNo

schema.NotificationQuery​

NameTypeDescriptionRequired
limitintegerNo
offsetintegerNo
resolvedbooleanNo
targetViolationIdintegerInternalNo
userIdintegerNo

schema.NotificationType​

NameTypeDescriptionRequired
schema.NotificationTypestring

schema.NotificationsInboxOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
notificationInboxschema.NotificationInboxNo

schema.NotificationsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
notifications[ schema.Notification ]No

schema.NotificationsRequest​

NameTypeDescriptionRequired
queryschema.NotificationQueryNo

schema.Org​

NameTypeDescriptionRequired
createdAtstringMaxInbox int32 db:&quot;max_inbox&quot; // DeprecatedNo
domainstringNo
idintegerNo
namestringNo
titlestringNo
updatedAtstringNo

schema.OrgInput​

NameTypeDescriptionRequired
domainstringNo
namestringNo
titlestringNo

schema.OrgOptions​

NameTypeDescriptionRequired
autoInactivateUsersbooleanNo
autoLogoutbooleanNo
badWordsCheckbooleanNo
badWordsViolationbooleanNo
corporateAudioMessagesEnabledbooleanNo
createdAtstringNo
inactivityTimeToLogoutstringNo
maxInactivityTimestringNo
maxInboxintegerNo
navbarColorstringNo
orgIdintegerNo
updatedAtstringNo

schema.OrgOptionsInput​

NameTypeDescriptionRequired
autoInactivateUsersbooleanNo
autoLogoutbooleanNo
badWordsCheckbooleanNo
badWordsViolationbooleanNo
corporateAudioMessagesEnabledbooleanNo
inactivityTimeToLogoutstringNo
maxInactivityTimestringNo
maxInboxintegerNo
navbarColorstringNo

schema.OrgOptionsOutput​

NameTypeDescriptionRequired
optionsschema.OrgOptionsNo

schema.OrgOptionsUpdateRequest​

NameTypeDescriptionRequired
optionsschema.OrgOptionsInputNo

schema.OrgOutput​

NameTypeDescriptionRequired
orgschema.OrgNo

schema.OrgUpdateRequest​

NameTypeDescriptionRequired
orgschema.OrgInputNo

schema.Period​

NameTypeDescriptionRequired
endstringNo
hoursEndintegerNo
hoursStartintegerNo
minutesEndintegerNo
minutesStartintegerNo
startstringNo
typeschema.PeriodTypeNo

schema.PeriodType​

NameTypeDescriptionRequired
schema.PeriodTypestring

schema.PeriodicPayment​

NameTypeDescriptionRequired
schema.PeriodicPaymentstring

schema.PeriodicPaymentType​

NameTypeDescriptionRequired
schema.PeriodicPaymentTypestring

schema.PersonalManager​

NameTypeDescriptionRequired
clientIdintegerNo
userIdintegerNo

schema.PersonalManagerAssignRequest​

NameTypeDescriptionRequired
clientIdintegerNo
userIdintegerNo

schema.PersonalManagerGetSettingsOutput​

NameTypeDescriptionRequired
settingsschema.PersonalManagerSyncSettingsNo

schema.PersonalManagerList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.PersonalManager ]No
totalCountintegerNo

schema.PersonalManagerOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
personalManagerschema.PersonalManagerNo

schema.PersonalManagerQuery​

NameTypeDescriptionRequired
clientIdintegerNo
limitintegerNo
offsetintegerNo
projectIdintegerNo
userIdintegerInternalNo

schema.PersonalManagerQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.PersonalManagerQueryNo

schema.PersonalManagerSyncSettings​

NameTypeDescriptionRequired
clientLoginstringNo
clientPasswordstringNo
enabledbooleanNo
etagstringNo
projectIdintegerNo
requiresAuthenticationbooleanNo
serviceUrlstringNo
syncTimeoutintegerNo
synchronizedAtstringNo

schema.PersonalManagerSyncSettingsInput​

NameTypeDescriptionRequired
clientLoginstringNo
clientPasswordstringNo
enabledbooleanNo
requiresAuthenticationbooleanNo
serviceUrlstringNo
syncTimeoutintegerNo

schema.PersonalManagerUnassignRequest​

NameTypeDescriptionRequired
clientIdintegerNo

schema.PersonalManagerUpdateSettingsRequest​

NameTypeDescriptionRequired
projectIdintegerNo
settingsschema.PersonalManagerSyncSettingsInputNo

schema.PollInput​

NameTypeDescriptionRequired
backgroundImageIdstringNo
closeDateintegerNo
closePeriodintegerNo
closedbooleanNo
duplicatebooleanNo
duplicateTointegerNo
duplicateToTypeschema.PostToNo
multipleChoicebooleanNo
pollEndDateintegerNo
pollOptions[ string ]No
projectIdintegerNo
publicIdintegerNo
publicVotersbooleanNo
questionstringNo
userIdintegerNo
vkbackgroundIdintegerNo

schema.PollOption​

NameTypeDescriptionRequired
deletedbooleanNo
deletedAtstringNo
postIdintegerNo
postToschema.PostToNo
textstringNo
voteCountintegerNo

schema.PollOptionType​

NameTypeDescriptionRequired
schema.PollOptionTypestring

schema.PollStatus​

NameTypeDescriptionRequired
schema.PollStatusstring

schema.PostInput​

NameTypeDescriptionRequired
duplicateTointegerNo
duplicateToTypeschema.PostToNo
fileIdstringdeprecated, replaced by flag has_files and array of file_idsNo
fileIds[ string ]transientNo
hasFilesbooleanNo
headerstringtransientNo
multipleAnswersbooleanNo
pollEndDateintegerNo
publicIdintegerNo
stateschema.PostStateNo
telegramIdintegerlen=255No
textstringNo
typeschema.PostTypeNo
userIdintegerUser who sent a message.No

schema.PostState​

NameTypeDescriptionRequired
schema.PostStatestring

schema.PostTo​

NameTypeDescriptionRequired
schema.PostTostring

schema.PostType​

NameTypeDescriptionRequired
schema.PostTypestring

schema.PostponeTicketInput​

NameTypeDescriptionRequired
assignToschema.AssignToNo
postponeUntilDatestringNo
postponeUntilTimestringNo
ticketIds[ integer ]No
userIdintegerNo

schema.Price​

NameTypeDescriptionRequired
schema.Pricestring

schema.PriceDurationType​

NameTypeDescriptionRequired
schema.PriceDurationTypestring

schema.Product​

NameTypeDescriptionRequired
clientProductschema.ClientProductNo
connectedCountintegerNo
createdAtstringNo
crmidintegerNo
deletedbooleanNo
deletedAtstringNo
descriptionForAgentsstringNo
descriptionForClientsstringNo
iconstringNo
idintegerNo
namestringNo
periodicPaymentschema.PeriodicPaymentNo
periodicPaymentPriceintegerNo
periodicPaymentTypeschema.PeriodicPaymentTypeNo
priceschema.PriceNo
priceDurationTypeschema.PriceDurationTypeNo
priceRURintegerNo
productsNeededToEnable[ schema.Product ]No
projectIdintegerNo
restrictionbooleanNo
typeschema.ProductTypeNo
updatedAtstringNo
validityPeriodschema.ValidityPeriodNo
validityPeriodDurationintegerNo
validityPeriodTypeschema.ValidityPeriodTypeNo

schema.ProductCreateRequest​

NameTypeDescriptionRequired
productschema.ProductInputNo
projectIdintegerNo

schema.ProductDeleteRequest​

NameTypeDescriptionRequired
productIdintegerNo

schema.ProductDisableClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo
productschema.ProductNo

schema.ProductGetClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo
projectIdintegerNo

schema.ProductGetRequest​

NameTypeDescriptionRequired
productIdintegerNo

schema.ProductInput​

NameTypeDescriptionRequired
crmidintegerNo
descriptionForAgentsstringNo
descriptionForClientsstringNo
iconstringNo
namestringNo
periodicPaymentschema.PeriodicPaymentNo
periodicPaymentPriceintegerNo
periodicPaymentTypeschema.PeriodicPaymentTypeNo
priceschema.PriceNo
priceDurationTypeschema.PriceDurationTypeNo
priceRURintegerNo
productIdsNeededToEnable[ integer ]No
projectIdintegerNo
restrictionbooleanNo
typeschema.ProductTypeNo
validityPeriodschema.ValidityPeriodNo
validityPeriodDurationintegerNo
validityPeriodTypeschema.ValidityPeriodTypeNo

schema.ProductList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Product ]No
totalCountintegerNo

schema.ProductOfferState​

NameTypeDescriptionRequired
schema.ProductOfferStatestring

schema.ProductOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
productschema.ProductNo

schema.ProductQuery​

NameTypeDescriptionRequired
clientIdintegerNo
deletedbooleanNo
excludeClientIdintegerNo
excludeIds[ integer ]No
limitintegerNo
offsetintegerNo
productIdintegerNo
productsSortByschema.ProductsSortByNo
projectIdintegerNo
qstringNo
typeschema.ProductTypeNo
userIdintegerInternalNo

schema.ProductQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ProductQueryNo

schema.ProductRestoreRequest​

NameTypeDescriptionRequired
productIdintegerNo

schema.ProductType​

NameTypeDescriptionRequired
schema.ProductTypestring

schema.ProductUpdateRequest​

NameTypeDescriptionRequired
productschema.ProductInputNo
productIdintegerNo

schema.ProductsDeleteRequest​

NameTypeDescriptionRequired
productIds[ integer ]No

schema.ProductsSortBy​

NameTypeDescriptionRequired
schema.ProductsSortBystring

schema.Project​

NameTypeDescriptionRequired
archivedAtstringNo
createdAtstringNo
deletedAtstringNo
descriptionstringNo
idintegerNo
licenseschema.LicenseNo
namestringNo
optionsschema.ProjectOptionsNo
permissionsschema.ProjectPermissionsNo
responseTimeSettingsschema.ResponseTimeSettingsNo
restoredAtstringNo
slugstringNo
stateschema.ProjectStatelen=32No
totalAgentCountintegerNo
totalAssignedTicketsintegerTotal open assigned ticketsNo
totalChannelCountintegerNo
totalClientCountintegerTransientNo
totalOpenTicketsintegerNo
totalTicketsintegerNo
updatedAtstringNo
wikiLinksschema.WikiLinksNo

schema.ProjectAudioRequest​

NameTypeDescriptionRequired
audioschema.AudioMessagesInputNo

schema.ProjectCreateRequest​

NameTypeDescriptionRequired
projectschema.ProjectInputNo

schema.ProjectDisplayOptionsGetOutput​

NameTypeDescriptionRequired
optionsschema.TicketDisplayOptionsNo

schema.ProjectDisplayOptionsUpdateRequest​

NameTypeDescriptionRequired
optionsschema.TicketDisplayInputNo
projectIdintegerNo

schema.ProjectIdRequest​

NameTypeDescriptionRequired
projectIdintegerNo

schema.ProjectInput​

NameTypeDescriptionRequired
descriptionstringNo
namestringNo
slugstringNo

schema.ProjectList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Project ]No
totalCountintegerNo

schema.ProjectOptions​

NameTypeDescriptionRequired
allowUserFileUploadbooleanNo
confirmOfflineSendingbooleanNo
createdAtstringNo
enableUserRatingsbooleanNo
extendedWaitingTimebooleanNo
maxActiveTicketsintegerNo
maxActiveTicketsPerUserintegerNo
processingDataLinkstringNo
projectIdintegerNo
requireCategorybooleanNo
requireRegistrationbooleanNo
sameUserAssignbooleanNo
sameUserAssignTimeintegerNo
spellingCheckbooleanNo
updatedAtstringNo

schema.ProjectOptionsGetOutput​

NameTypeDescriptionRequired
optionsschema.ProjectOptionsNo

schema.ProjectOptionsInput​

NameTypeDescriptionRequired
allowUserFileUploadbooleanNo
confirmOfflineSendingbooleanNo
enableUserRatingsbooleanNo
extendedWaitingTimebooleanNo
maxActiveTicketsintegerNo
maxActiveTicketsPerUserintegerNo
processingDataLinkstringNo
requireCategorybooleanNo
requireRegistrationbooleanNo
sameUserAssignbooleanNo
sameUserAssignTimeintegerNo
spellingCheckbooleanNo

schema.ProjectOptionsUpdateRequest​

NameTypeDescriptionRequired
optionsschema.ProjectOptionsInputNo
projectIdintegerNo

schema.ProjectOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
projectschema.ProjectNo

schema.ProjectPermissions​

NameTypeDescriptionRequired
schema.ProjectPermissionsobject

schema.ProjectQuery​

NameTypeDescriptionRequired
limitintegerNo
offsetintegerNo
stateschema.ProjectStateNo
userIdintegerInternalNo

schema.ProjectQueryRequest​

NameTypeDescriptionRequired
queryschema.ProjectQueryNo

schema.ProjectState​

NameTypeDescriptionRequired
schema.ProjectStatestring

schema.ProjectUpdateRequest​

NameTypeDescriptionRequired
projectschema.ProjectInputNo
projectIdintegerNo

schema.PushTestOutput​

NameTypeDescriptionRequired
results[ schema.TestPushResult ]No

schema.PushTestRequest​

NameTypeDescriptionRequired
clientIdintegerNo
pushschema.TestPushInputNo

schema.QuickRepliesOutput​

NameTypeDescriptionRequired
items[ schema.QuickReply ]No
totalCountintegerNo

schema.QuickRepliesQueryRequest​

NameTypeDescriptionRequired
folderIdintegerNo
queryschema.QuickReplyQueryNo

schema.QuickReply​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
folderIdintegerNo
idintegerNo
projectIdintegerNo
textstringNo
updatedAtstringNo

schema.QuickReplyCreateRequest​

NameTypeDescriptionRequired
folderIdintegerNo
replyschema.QuickReplyInputNo

schema.QuickReplyDeleteRequest​

NameTypeDescriptionRequired
replyIdintegerNo

schema.QuickReplyExportRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo

schema.QuickReplyFolder​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
folders[ schema.QuickReplyFolder ]RelationsNo
groupIdintegerNo
idintegerNo
parentIdintegerNo
personalbooleanNo
projectIdintegerNo
replies[ schema.QuickReply ]No
titlestringNo
updatedAtstringNo
userIdintegerNo

schema.QuickReplyFolderCreateRequest​

NameTypeDescriptionRequired
folderschema.QuickReplyFolderInputNo
projectIdintegerNo

schema.QuickReplyFolderDeleteRequest​

NameTypeDescriptionRequired
folderIdintegerNo

schema.QuickReplyFolderGetRequest​

NameTypeDescriptionRequired
folderIdintegerNo

schema.QuickReplyFolderInput​

NameTypeDescriptionRequired
groupIdintegerNo
parentIdintegerNo
personalbooleanNo
titlestringNo
userIdintegerNo

schema.QuickReplyFolderOutput​

NameTypeDescriptionRequired
folderschema.QuickReplyFolderNo

schema.QuickReplyFolderQuery​

NameTypeDescriptionRequired
groupIds[ integer ]No
limitintegerNo
offsetintegerNo
parentIdintegerNo
personalbooleanNo
projectIdintegerNo
recursivebooleanRecursive and ParentId are mutually exclusive, recursive applies to a project.No
titlestringNo
userIdintegerNo

schema.QuickReplyFolderTreeRequest​

NameTypeDescriptionRequired
allbooleanNo
projectIdintegerNo

schema.QuickReplyFolderUpdateRequest​

NameTypeDescriptionRequired
folderschema.QuickReplyFolderInputNo
folderIdintegerNo

schema.QuickReplyFoldersOutput​

NameTypeDescriptionRequired
items[ schema.QuickReplyFolder ]No
totalCountintegerNo

schema.QuickReplyFoldersQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.QuickReplyFolderQueryNo

schema.QuickReplyInput​

NameTypeDescriptionRequired
textstringNo

schema.QuickReplyOutput​

NameTypeDescriptionRequired
replyschema.QuickReplyNo

schema.QuickReplyPersonalCreateRequest​

NameTypeDescriptionRequired
replyschema.QuickReplyPersonalInputNo

schema.QuickReplyPersonalInput​

NameTypeDescriptionRequired
personalbooleanNo
projectIdintegerNo
textstringNo

schema.QuickReplyQuery​

NameTypeDescriptionRequired
folderIdintegerNo
limitintegerNo
offsetintegerNo
projectIdintegerNo

schema.QuickReplyQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.QuickReplyQueryNo

schema.QuickReplyUpdateRequest​

NameTypeDescriptionRequired
replyschema.QuickReplyInputNo
replyIdintegerNo

schema.Rating​

NameTypeDescriptionRequired
clientIdintegerNo
commentstringNo
createdAtstringNo
idintegerNo
projectIdintegerNo
ratingPollIdintegerNo
stateschema.RatingStateNo
ticketIdintegerNo
updatedAtstringNo
userIdintegerNo
valueintegerNo

schema.RatingPoll​

NameTypeDescriptionRequired
categories[ schema.Category ]No
categoryFilterbooleanNo
categoryIdssets.Int64len=4000No
channelFilterbooleanNo
channelIdssets.Int64len=4000No
channels[ schema.Channel ]No
clientGroupschema.ClientGroupNo
clientGroupFilterbooleanNo
clientGroupIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
feedbackThanksbooleanNo
feedbackThanksTextstringNo
idintegerNo
markerschema.MarkerNo
markerFilterbooleanNo
markerTypessets.StringNo
projectIdintegerNo
questions[ schema.RatingPollQuestion ]No
statusschema.PollStatusNo
titlestringNo
updatedAtstringNo

schema.RatingPollAnswer​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
orderintegerNo
ratingPollQuestionIdintegerNo
textstringNo
updatedAtstringNo

schema.RatingPollAnswerInput​

NameTypeDescriptionRequired
idintegerNo
orderintegerNo
textstringNo

schema.RatingPollCreateRequest​

NameTypeDescriptionRequired
pollschema.RatingPollInputNo
projectIdintegerNo

schema.RatingPollDeleteRequest​

NameTypeDescriptionRequired
pollIdintegerNo

schema.RatingPollInput​

NameTypeDescriptionRequired
categoryFilterbooleanNo
categoryIdssets.Int64len=4000No
channelFilterbooleanNo
channelIdssets.Int64len=4000No
clientGroupFilterbooleanNo
clientGroupIdintegerNo
deletedbooleanNo
enabledbooleanNo
feedbackThanksbooleanNo
feedbackThanksTextstringNo
markerFilterbooleanNo
markerTypessets.StringNo
projectIdintegerNo
questions[ schema.RatingPollQuestionInput ]No
titlestringNo

schema.RatingPollOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
pollschema.RatingPollNo

schema.RatingPollQuestion​

NameTypeDescriptionRequired
answers[ schema.RatingPollAnswer ]No
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
orderintegerNo
ratingPollIdintegerNo
textstringNo
typeschema.PollOptionTypeNo
updatedAtstringNo

schema.RatingPollQuestionInput​

NameTypeDescriptionRequired
answers[ schema.RatingPollAnswerInput ]No
idintegerNo
orderintegerNo
textstringNo
typeschema.PollOptionTypeNo

schema.RatingPollToggleRequest​

NameTypeDescriptionRequired
enabledbooleanNo
pollIdintegerNo

schema.RatingPollUpdateRequest​

NameTypeDescriptionRequired
pollschema.RatingPollInputNo
pollIdintegerNo

schema.RatingPollsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
polls[ schema.RatingPoll ]No

schema.RatingState​

NameTypeDescriptionRequired
schema.RatingStatestring

schema.ReportClientExportRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo
queryschema.ClientReportQueryNo

schema.ReportClientOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
reportschema.ClientReportNo

schema.ReportClientRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.ClientReportQueryNo

schema.ReportTicketDashboardRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TicketReportQueryNo

schema.ReportTicketExportRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo
queryschema.TicketReportQueryNo

schema.ReportTicketOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
reportschema.TicketReportNo

schema.ReportTicketRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TicketReportQueryNo

schema.ReportUserDashboardRequest​

NameTypeDescriptionRequired
queryschema.UserReportQueryNo

schema.ReportUserExportRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo
queryschema.UserReportQueryNo

schema.ReportUserOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
reportschema.UserReportNo

schema.ReportUserRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.UserReportQueryNo

schema.Response​

NameTypeDescriptionRequired
dataNo
errorschema.ErrorNo
okbooleanNo
pingbooleanNo

schema.ResponseTimeSettings​

NameTypeDescriptionRequired
createdAtstringNo
fieldFiveintegerNo
fieldFourintegerNo
fieldOneintegerbefore how many secondsNo
fieldSixintegerafter how many secondsNo
fieldThreeintegerNo
fieldTwointegerNo
projectIdintegerNo
updatedAtstringNo

schema.ResponseTimeSettingsInput​

NameTypeDescriptionRequired
fieldFiveintegerNo
fieldFourintegerNo
fieldOneintegerNo
fieldSixintegerNo
fieldThreeintegerNo
fieldTwointegerNo
projectIdintegerNo

schema.Route​

NameTypeDescriptionRequired
assignPrioritybooleanNo
assignPriorityValueintegerNo
categoryFilterbooleanNo
categoryIdssets.Int64len=4000No
channelFilterbooleanNo
channelIdssets.Int64len=4000No
clientGroupschema.ClientGroupNo
clientGroupFilterbooleanNo
clientGroupIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
enabledbooleanNo
groupIdintegerNo
idintegerNo
markerschema.MarkertransientNo
markerFilterbooleanNo
markerTypessets.StringNo
onlinebooleanNo
orderintegerNo
priorities[ integer ]No
priorityFilterbooleanNo
priorityValuessets.IntNo
projectIdintegerNo
ratingFilterbooleanNo
ratingFromnumberNo
ratingTonumberNo
timeBasedbooleanNo
timeFromstringNo
timeTostringNo
titlestringNo
updatedAtstringNo

schema.RouteCreateRequest​

NameTypeDescriptionRequired
projectIdintegerNo
routeschema.RouteInputNo

schema.RouteDeleteRequest​

NameTypeDescriptionRequired
routeIdintegerNo

schema.RouteInput​

NameTypeDescriptionRequired
assignPrioritybooleanNo
assignPriorityValueintegerNo
categoryFilterbooleanNo
categoryIdssets.Int64No
channelFilterbooleanNo
channelIdssets.Int64No
clientGroupFilterbooleanNo
clientGroupIdintegerNo
groupIdintegerNo
markerFilterbooleanNo
markerTypessets.StringNo
onlinebooleanNo
priorityFilterbooleanNo
priorityValuessets.IntNo
ratingFilterbooleanNo
ratingFromnumberNo
ratingTonumberNo
timeBasedbooleanNo
timeFromstringNo
timeTostringNo
titlestringNo

schema.RouteMatchTicketRequest​

NameTypeDescriptionRequired
ticketIdintegerNo

schema.RouteMoveRequest​

NameTypeDescriptionRequired
routeIdintegerNo
upbooleanNo

schema.RouteOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
routeschema.RouteNo

schema.RouteToggleRequest​

NameTypeDescriptionRequired
enabledbooleanNo
routeIdintegerNo

schema.RouteUpdateRequest​

NameTypeDescriptionRequired
routeschema.RouteInputNo
routeIdintegerNo

schema.RoutesOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
routes[ schema.Route ]No

schema.SLStat​

NameTypeDescriptionRequired
projectsCountintegerNo
sldurationnumberNo
slpendingTimenumberNo
slreactionTimenumberNo

schema.Schedule​

NameTypeDescriptionRequired
fridayschema.ScheduleDayNo
mondayschema.ScheduleDayNo
saturdayschema.ScheduleDayNo
sundayschema.ScheduleDayNo
thursdayschema.ScheduleDayNo
tuesdayschema.ScheduleDayNo
wednesdayschema.ScheduleDayNo

schema.ScheduleDay​

NameTypeDescriptionRequired
enabledbooleanNo
endHourintegerNo
startHourintegerNo

schema.SetupInput​

NameTypeDescriptionRequired
orgschema.OrgInputNo
userschema.UserSetupInputNo

schema.SetupOutput​

NameTypeDescriptionRequired
orgschema.OrgNo
sessionschema.UserSessionNo
userschema.UserNo

schema.SingleChoice​

NameTypeDescriptionRequired
chatMessageIdintegerNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
tagstringtags for bss bot buttonsNo
titlestringNo
updatedAtstringNo
valuestringNo

schema.StatusOutput​

NameTypeDescriptionRequired
statusstringNo

schema.StatusQueryProjectReportRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.StatusReportQueryNo

schema.StatusQueryReportOutput​

NameTypeDescriptionRequired
rows[ schema.StatusReportRow ]No

schema.StatusQueryReportRequest​

NameTypeDescriptionRequired
queryschema.StatusReportQueryNo

schema.StatusQueryReportUserRequest​

NameTypeDescriptionRequired
queryschema.StatusReportQueryNo
userIdintegerNo

schema.StatusQueryTotalProjectReportRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.StatusTotalReportQueryNo

schema.StatusQueryTotalReportOutput​

NameTypeDescriptionRequired
rows[ schema.StatusTotalReportRow ]No

schema.StatusQueryTotalReportRequest​

NameTypeDescriptionRequired
queryschema.StatusTotalReportQueryNo

schema.StatusReportQuery​

NameTypeDescriptionRequired
endstringNo
groupIds[ integer ]No
periodschema.PeriodNo
projectIds[ integer ]No
startstringInternalNo
typeschema.StatusTypeNo
types[ schema.StatusType ]No
userIdintegerNo
userIds[ integer ]No

schema.StatusReportRow​

NameTypeDescriptionRequired
datestringNo
emailstringNo
endedAtstringNo
namestringNo
startedAtstringNo
timeInStatusintegerNo
typeschema.StatusTypeNo

schema.StatusTotalReportQuery​

NameTypeDescriptionRequired
endstringNo
groupschema.DateUnitNo
periodschema.PeriodNo
projectIdintegerInternalNo
startstringNo

schema.StatusTotalReportRow​

NameTypeDescriptionRequired
activeintegerNo
busyintegerNo
datestringNo
onlineintegerNo

schema.StatusType​

NameTypeDescriptionRequired
schema.StatusTypestring

schema.SystemChatSettings​

NameTypeDescriptionRequired
botIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
enabledbooleanNo
greetFromstringNo
idintegerNo
lifetimeintegerlifetime is measured in secondsNo
messagestringmessage to be sent by the operator to the clientNo
messageForBotstringmessage to be sent to the botNo
operatorNamestringNo
projectIdintegerNo
updatedAtstringNo

schema.SystemChatSettingsInput​

NameTypeDescriptionRequired
enabledbooleanNo
greetFromstringNo
lifetimeintegerlifetime is measured in secondsNo
messagestringNo
projectIdintegerNo

schema.SystemInfo​

NameTypeDescriptionRequired
createdAtstringNo
idintegerNo
serverIDstringNo
updatedAtstringNo

schema.SystemInfoOutput​

NameTypeDescriptionRequired
systemschema.SystemInfoNo

schema.Tag​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
projectIdintegerNo
textstringNo

schema.TagInput​

NameTypeDescriptionRequired
projectIdintegerNo
textstringNo

schema.TagQuery​

NameTypeDescriptionRequired
excludedIds[ integer ]No
projectIdintegerNo

schema.Target​

NameTypeDescriptionRequired
createdAtstringNo
deletedAtstringNo
enabledbooleanNo
idintegerNo
inactivityTimestringNo
optimalDurationstringNo
pendingTimestringNo
projectIdintegerNo
reactionTimestringNo
replyTimestringNo
responseTimestringNo
titlestringTransientNo
typeschema.TargetTypeNo
updatedAtstringNo

schema.TargetInput​

NameTypeDescriptionRequired
inactivityTimestringNo
optimalDurationstringNo
pendingTimestringNo
reactionTimestringNo
replyTimestringNo
responseTimestringNo
typeschema.TargetTypeNo

schema.TargetOutput​

NameTypeDescriptionRequired
targetschema.TargetNo

schema.TargetSetRequest​

NameTypeDescriptionRequired
projectIdintegerNo
targetschema.TargetInputNo

schema.TargetToggleRequest​

NameTypeDescriptionRequired
enabledbooleanNo
targetIdintegerNo

schema.TargetTotalsOutput​

NameTypeDescriptionRequired
totals[ schema.TargetViolationTotals ]No

schema.TargetType​

NameTypeDescriptionRequired
schema.TargetTypestring

schema.TargetViolation​

NameTypeDescriptionRequired
createdAtstringNo
durationintegerNo
idintegerNo
projectIdintegerNo
resolvedbooleanNo
startedAtstringNo
statusIdintegerInactive status id.No
targetIdintegerNo
ticketIdintegerNo
updatedAtstringNo
userIdintegerNo

schema.TargetViolationOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
violations[ schema.TargetViolation ]No

schema.TargetViolationQuery​

NameTypeDescriptionRequired
limitintegerNo
offsetintegerNo
periodschema.PeriodNo
projectIds[ integer ]No
targetIdintegerNo
types[ schema.TargetType ]No
userIds[ integer ]No

schema.TargetViolationResolveAllOutput​

NameTypeDescriptionRequired
successstringNo

schema.TargetViolationResolveAllRequest​

NameTypeDescriptionRequired
violationInput[ schema.ViolationInput ]No

schema.TargetViolationResolveOutput​

NameTypeDescriptionRequired
violationIdintegerNo

schema.TargetViolationResolveRequest​

NameTypeDescriptionRequired
ticketIdintegerNo
violationIdintegerNo

schema.TargetViolationTotals​

NameTypeDescriptionRequired
totalintegerNo
typeschema.TargetTypenil возвращается для всех типовNo

schema.TargetViolationsProjectQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TargetViolationQueryNo

schema.TargetViolationsQueryRequest​

NameTypeDescriptionRequired
queryschema.TargetViolationQueryNo

schema.TargetsOutput​

NameTypeDescriptionRequired
targets[ schema.Target ]No

schema.TelegramBotSettingsInput​

NameTypeDescriptionRequired
botTokenstringNo
oneTimeKeyboardbooleanNo
resizeKeyboardbooleanNo

schema.TelegramChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerMatches channel id.No
restoredAtstringNo
updatedAtstringNo
userIdintegerTelegram dataNo
userNamestringBot name, len=1024No
uuidstringlen=36No

schema.TelegramConfig​

NameTypeDescriptionRequired
botTokenstringNo
channelIdintegerlen=255No
oneTimeKeyboardbooleanNo
resizeKeyboardbooleanNo
webhookURLstringTransientNo

schema.TelegramOutput​

NameTypeDescriptionRequired
configschema.TelegramConfigNo

schema.TelegramPollCreateRequest​

NameTypeDescriptionRequired
pollschema.PollInputNo
projectIdintegerNo

schema.TelegramPost​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
fileIdstringdeprecated, replaced by flag has_files and array of file_idsNo
fileIds[ string ]transientNo
hasFilesbooleanNo
headerstringNo
idintegerNo
multipleAnswersbooleanNo
pollIdstringNo
pollOptions[ schema.PollOption ]No
publicIdintegerNo
sentAtstringNo
stateschema.PostStateNo
telegramIdintegertelegram post idNo
textstringNo
totalVoterCountintegerNo
typeschema.PostTypeNo
updatedAtstringNo
userIdintegerUser who sent a message.No

schema.TelegramPostCreateRequest​

NameTypeDescriptionRequired
postschema.PostInputNo
projectIdintegerNo

schema.TelegramPostDeleteRequest​

NameTypeDescriptionRequired
postIdintegerNo
projectIdintegerNo

schema.TelegramPostOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
postschema.TelegramPostNo

schema.TelegramPostQueryRequest​

NameTypeDescriptionRequired
publicIdintegerNo
queryschema.TelegramPostsQueryNo

schema.TelegramPostsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
posts[ schema.TelegramPost ]No

schema.TelegramPostsQuery​

NameTypeDescriptionRequired
deletedbooleanNo
descbooleanNo
fromIdintegerid > from_idNo
limitintegerNo
offsetintegerNo
projectIdintegerNo
publicIdintegerNo
stateschema.PostStateNo
untilIdintegerid < until_idNo

schema.TelegramPublic​

NameTypeDescriptionRequired
channelIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
telegramLinkstringNo
titlestringNo
updatedAtstringNo

schema.TelegramPublicCreateRequest​

NameTypeDescriptionRequired
telegramPublicschema.TelegramPublicInputNo

schema.TelegramPublicDeleteRequest​

NameTypeDescriptionRequired
projectIdintegerNo
publicIdintegerNo

schema.TelegramPublicGetRequest​

NameTypeDescriptionRequired
publicIdintegerNo

schema.TelegramPublicInput​

NameTypeDescriptionRequired
channelIdintegerNo
projectIdintegerNo
telegramLinkstringNo
titlestringNo

schema.TelegramPublicOutput​

NameTypeDescriptionRequired
publicschema.TelegramPublicNo

schema.TelegramPublicProjectQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TelegramPublicsQueryNo

schema.TelegramPublicQueryRequest​

NameTypeDescriptionRequired
channelIdintegerNo
projectIdintegerNo
queryschema.TelegramPublicsQueryNo

schema.TelegramPublicUpdateRequest​

NameTypeDescriptionRequired
publicschema.TelegramPublicInputNo
publicIdintegerNo

schema.TelegramPublicsList​

NameTypeDescriptionRequired
items[ schema.TelegramPublic ]No
totalCountintegerNo

schema.TelegramPublicsQuery​

NameTypeDescriptionRequired
channelIdintegerNo
deletedbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerNo

schema.TelegramSetTokenRequest​

NameTypeDescriptionRequired
channelIdintegerNo
telegramBotSettingsschema.TelegramBotSettingsInputNo

schema.TelegramUser​

NameTypeDescriptionRequired
createdAtstringNo
firstNamestringNo
idintegerMatches external id.No
lastNamestringNo
updatedAtstringNo
userNamestringNo

schema.TestPushInput​

NameTypeDescriptionRequired
textstringNo
titlestringNo

schema.TestPushResult​

NameTypeDescriptionRequired
errorstringNo
messageIdstringNo
okbooleanNo
tokenstringNo

schema.Ticket​

NameTypeDescriptionRequired
acceptTimeintegerDuration before the ticket has been accepted.No
acceptTimeOKbooleanNo
acceptedAtstringNo
accepterIdintegerNo
assignTimeintegerDeprecated, use AcceptTime; duration before the ticket has been assigned.No
assignedAtstringNo
assigneeIdintegerNo
autoClosedbooleanNo
avgReplyTimeintegerNo
blockReasonstringNo
blockedbooleanNo
blockedAtstringNo
blockedUntilstringNo
botFlowStateschema.BotFlowStatebss botNo
bsssessionIdstringNo
cannotAssignReasonschema.TicketCannotAssignReasonNo
categoryIdintegerNo
channelIdintegerNo
chatIdintegerNo
clientIdintegerNo
closedAtstringNo
createdAtstringNo
deletedbooleanNo
fcrbooleanNo
greetedbooleanGreeting message has been sent.No
groupIdintegerNo
hasCommentsbooleanNo
idintegerNo
infoRequestschema.InfoRequestNo
infoRequestIdintegerNo
initiatorClientbooleanNo
ipstringNo
ipcitystringNo
ipcountrystringNo
lostbooleanLike Missed, but for Target & reportsNo
members[ schema.TicketMember ]TransientNo
messageIdintegerLast message id.No
missedbooleanNo
openbooleanNo
openedAtstringNo
permissionsschema.TicketPermissionsNo
postponedUntilstringNo
priorityintegerNo
projectIdintegerNo
ratingIdintegerNo
reactionCheckedbooleanNo
registeredbooleanMarked as registered.No
registeredAtstringNo
registeredByintegerNo
respondedAtstringNo
responseTimeintegerAgent reaction time from the assign time til the first reply.No
stateschema.TicketStatelen=32No
statusschema.TicketStatusNo
statusChangedAtstringNo
systemTicketbooleanNo
tagIdssets.Int64No
ticketComments[ schema.TicketComment ]No
titlestringlen=255No
totalAssignmentsintegerNo
totalMembersintegerNo
totalMessagesintegerNo
totalResponseTimeintegerTime from the creation til the first reply.No
totalResponseTimeOKbooleanNo
totalTimeintegerTotal time this ticket has been opened.No
totalTimeOKbooleanNo
transferredFromBotbooleanNo
uastringNo
uabrowserstringNo
uabrowserVersionstringNo
uamobilebooleanNo
uaosstringNo
uaosversionstringNo
uaplatformstringNo
updatedAtstringNo
userWhoBlockedIdintegerNo
violationIdintegerNo
waitingTimeReplybooleanNo

schema.TicketAction​

NameTypeDescriptionRequired
actorIdintegerUser who made an action.No
commentstringNo
createdAtstringNo
groupIdintegerAssigned group.No
idintegerNo
textstringTransitiveNo
ticketIdintegerNo
typeschema.TicketActionTypelen=32No
userIdintegerAssignee, member, etc.No

schema.TicketActionType​

NameTypeDescriptionRequired
schema.TicketActionTypestring

schema.TicketAssignSeveralRequest​

NameTypeDescriptionRequired
commentstringNo
ticketIdintegerNo
userIdintegerNo

schema.TicketAssignToGroupRequest​

NameTypeDescriptionRequired
groupIdintegerNo
ticketIdintegerNo

schema.TicketBanOptionsUpdateRequest​

NameTypeDescriptionRequired
inputschema.BlockedTicketSettingsNo
projectIdintegerNo

schema.TicketBanRequest​

NameTypeDescriptionRequired
inputschema.BlockTicketInputNo

schema.TicketCannotAssignReason​

NameTypeDescriptionRequired
schema.TicketCannotAssignReasonstring

schema.TicketCloseRequest​

NameTypeDescriptionRequired
fcrbooleanNo
registerbooleanNo
ticketIdintegerNo

schema.TicketCloseSeveralRequest​

NameTypeDescriptionRequired
closingTextstringNo
ticketIds[ integer ]No

schema.TicketComment​

NameTypeDescriptionRequired
authorschema.UsertransientNo
authorIdintegerNo
channelTypeschema.ChannelTypeNo
chatIdintegerNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
deletedByUserIdintegerNo
editedAtstringNo
editedByUserIdintegerNo
editedByUsernamestringNo
idintegerNo
textstringNo
ticketIdintegerNo

schema.TicketCommentClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo

schema.TicketCommentCreateRequest​

NameTypeDescriptionRequired
inputschema.TicketCommentInputNo

schema.TicketCommentDeleteRequest​

NameTypeDescriptionRequired
commentIdintegerNo
projectIdintegerNo

schema.TicketCommentGetRequest​

NameTypeDescriptionRequired
ticketIdintegerNo

schema.TicketCommentInput​

NameTypeDescriptionRequired
channelTypeschema.ChannelTypeNo
chatIdintegerNo
clientIdintegerNo
projectIdintegerNo
textstringNo
ticketIdintegerNo

schema.TicketCommentUpdateRequest​

NameTypeDescriptionRequired
commentIdintegerNo
inputschema.TicketCommentInputNo

schema.TicketCreateRequest​

NameTypeDescriptionRequired
channelIdintegerNo
clientIdintegerNo
projectIdintegerNo

schema.TicketDisplayInput​

NameTypeDescriptionRequired
showAvailableProductsbooleanNo
showClientInfobooleanNo
showConnectedClientsbooleanNo
showConnectedProductsbooleanNo
showDetailsInfobooleanNo
showDeviceInfobooleanNo
showPeopleInfobooleanNo
showTicketInfobooleanNo

schema.TicketDisplayOptions​

NameTypeDescriptionRequired
createdAtstringNo
projectIdintegerNo
showAvailableProductsbooleanNo
showClientInfobooleanNo
showConnectedClientsbooleanNo
showConnectedProductsbooleanNo
showDetailsInfobooleanNo
showDeviceInfobooleanNo
showPeopleInfobooleanNo
showTicketInfobooleanNo
updatedAtstringNo

schema.TicketExportChannelRequest​

NameTypeDescriptionRequired
channelIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketExportClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketExportCompanyRequest​

NameTypeDescriptionRequired
companyIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketExportProjectRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo
queryschema.TicketQueryNo

schema.TicketIdRequest​

NameTypeDescriptionRequired
ticketIdintegerNo

schema.TicketInviteRequest​

NameTypeDescriptionRequired
ticketIdintegerNo
userIdintegerNo

schema.TicketKickRequest​

NameTypeDescriptionRequired
memberIdintegerNo

schema.TicketList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.Ticket ]No
totalCountintegerNo

schema.TicketMember​

NameTypeDescriptionRequired
assignedAtstringNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
mebooleanTransientNo
ticketIdintegerNo
unassignedAtstringNo
updatedAtstringNo
userIdintegerNo

schema.TicketMemberList​

NameTypeDescriptionRequired
graphschema.GraphNo
members[ schema.TicketMember ]No

schema.TicketMemberOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
memberschema.TicketMemberNo

schema.TicketMessage​

NameTypeDescriptionRequired
actionIdintegerNo
actions[ schema.Action ]No
authorschema.ActorTypeAuthorNo
autoreplyIdintegerNo
botpressPayloadstringNo
clientIdintegerNo
createdAtstringNo
deletedbooleanNo
emailMessageIdstringid needed to reply to client emailNo
fileIdstringlen=255No
greetingbooleanNo
idintegerNo
infoRequestIdintegerNo
isDropDownbooleanNo
listenedbooleanNo
listenedAtstringNo
localIdintegerNo
mybooleanTransitiveNo
productIdintegerNo
ratingIdintegerNo
readbooleanNo
readAtstringNo
receivedbooleanFlagsNo
receivedAtstringNo
replyTimeintegerNo
replyToMessageIdintegerNo
singleChoices[ schema.SingleChoice ]No
textstringlen=4000No
ticketIdintegerNo
typeschema.TicketMessageTypePayloadNo
uidstring40 chars, sha1(chatId, clientuser, localId) or a random hex string.
updatedAtstringNo
userIdintegerNo

schema.TicketMessageCreateRequest​

NameTypeDescriptionRequired
messageschema.TicketMessageInputNo
ticketIdintegerNo

schema.TicketMessageIdRequest​

NameTypeDescriptionRequired
messageIdintegerNo

schema.TicketMessageInput​

NameTypeDescriptionRequired
actionschema.TicketActionInternalNo
actionIdintegerNo
actions[ schema.Action ]bot responsesNo
autoreplyIdintegerNo
botpressPayloadstringNo
emailMessageIdstringid needed to reply to client emailNo
fileIdstringNo
fileURLstringNo
greetingbooleanNo
infoRequestIdintegerNo
isDropDownbooleanNo
localIdintegerNo
productIdintegerNo
ratingIdintegerNo
replyToMessageIdintegerNo
singleChoices[ schema.SingleChoice ]No
skipAutoClosebooleanNo
textstringNo
typeschema.TicketMessageTypeNo

schema.TicketMessageList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.TicketMessage ]No
totalCountintegerNo

schema.TicketMessageOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
messageschema.TicketMessageNo

schema.TicketMessageQuery​

NameTypeDescriptionRequired
autoreplyIdintegerNo
chatIdintegerNo
clientIdintegerNo
descbooleanNo
fromIdintegerNo
limitintegerNo
offsetintegerNo
qstringNo
readbooleanNo
ticketIds[ integer ]InternalNo
untilIdintegerNo

schema.TicketMessageReceivedRequest​

NameTypeDescriptionRequired
messageIds[ integer ]No

schema.TicketMessageSlice​

NameTypeDescriptionRequired
graphschema.GraphNo
head[ schema.TicketMessage ]No
moreCountintegerNo
tail[ schema.TicketMessage ]No
totalCountintegerNo

schema.TicketMessageType​

NameTypeDescriptionRequired
schema.TicketMessageTypestring

schema.TicketMessagesDeleteRequest​

NameTypeDescriptionRequired
chatIdintegerNo
messageIds[ integer ]No
projectIdintegerNo

schema.TicketMessagesExportChannelRequest​

NameTypeDescriptionRequired
channelIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketMessagesExportClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketMessagesExportCompanyRequest​

NameTypeDescriptionRequired
companyIdintegerNo
formatschema.ExportFormatNo
queryschema.TicketQueryNo

schema.TicketMessagesExportProjectRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
projectIdintegerNo
queryschema.TicketQueryNo

schema.TicketMessagesExportRequest​

NameTypeDescriptionRequired
formatschema.ExportFormatNo
ticketIdintegerNo

schema.TicketMessagesGetRequest​

NameTypeDescriptionRequired
queryschema.TicketMessageQueryNo

schema.TicketMessagesSliceRequest​

NameTypeDescriptionRequired
queryschema.TicketMessageQueryNo
ticketIdintegerNo

schema.TicketOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
ticketschema.TicketNo

schema.TicketPermissions​

NameTypeDescriptionRequired
schema.TicketPermissionsobject

schema.TicketPostponeSeveralRequest​

NameTypeDescriptionRequired
inputschema.PostponeTicketInputNo

schema.TicketPreviousRequest​

NameTypeDescriptionRequired
chatTypeschema.ChatTypeNo
ticketIdintegerNo

schema.TicketPriorityChangeRequest​

NameTypeDescriptionRequired
priorityintegerNo
ticketIdintegerNo

schema.TicketProductMessageCreateRequest​

NameTypeDescriptionRequired
clientIdintegerNo
messageschema.TicketMessageInputNo

schema.TicketQuery​

NameTypeDescriptionRequired
accepterIds[ integer ]No
assigneeIds[ integer ]No
blockedbooleanNo
categoryIds[ integer ]No
channelIds[ integer ]No
chatIdintegerNo
chatTypes[ schema.ChatType ]No
clientIdintegerNo
clientNamestringNo
companyIdintegerNo
connectedbooleanIncludes the children tickets.No
descbooleanNo
endHMSstringNo
excludeIds[ integer ]No
groupIds[ integer ]No
groupIsNilbooleanQueries "group_id is null" when true.No
haveCategorybooleanNo
limitintegerNo
markerschema.MarkerTypeclient's marker type (loyal or disloyal)No
noCategorybooleanNo
offsetintegerNo
openbooleanNo
orderByBlockedAtbooleanNo
orderByClientbooleanNo
orderByIPbooleanNo
orderByPrioritybooleanNo
parentIdintegerNo
periodschema.PeriodNo
priorities[ integer ]No
projectIdintegerNo
ratingStates[ schema.RatingState ]No
ratings[ integer ]No
startHMSstringNo
stateschema.TicketStateNo
systemTicketbooleanNo
tagIdstringNo
tagIds[ string ]No
tagIdsStrstringNo
tagRegexstringNo
whoBlockedIds[ integer ]No

schema.TicketQueryChannelRequest​

NameTypeDescriptionRequired
channelIdintegerNo
queryschema.TicketQueryNo

schema.TicketQueryClientRequest​

NameTypeDescriptionRequired
clientIdintegerNo
queryschema.TicketQueryNo

schema.TicketQueryCompanyRequest​

NameTypeDescriptionRequired
companyIdintegerNo
queryschema.TicketQueryNo

schema.TicketQueryProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TicketQueryNo

schema.TicketQueueSeveralRequest​

NameTypeDescriptionRequired
ticketIds[ integer ]No

schema.TicketReport​

NameTypeDescriptionRequired
queryschema.TicketReportQueryNo
rows[ schema.TicketReportRow ]No
totalsschema.TicketReportRowNo

schema.TicketReportDimension​

NameTypeDescriptionRequired
schema.TicketReportDimensionstring

schema.TicketReportQuery​

NameTypeDescriptionRequired
accepterIds[ integer ]No
assigneeIds[ integer ]No
categoryIds[ integer ]No
channelIds[ integer ]No
chatTypes[ schema.ChatType ]No
cutHMSbooleanNo
dateGroupschema.DateUnitNo
dimensionschema.TicketReportDimensionNo
groupIds[ integer ]No
periodschema.PeriodNo
projectIdintegerFiltersNo
ratingStates[ schema.RatingState ]No
ratings[ integer ]No

schema.TicketReportRow​

NameTypeDescriptionRequired
accepterIdintegerNo
assigneeIdintegerNo
avgAcceptTimeintegerNo
avgRatingnumberNo
avgRespTimeintegerNo
avgTotalRespTimeintegerNo
avgTotalTimeintegerNo
categoryIdintegerNo
channelIdintegerNo
chatTypeschema.ChatTypeNo
datestringDimensionsNo
dateDMYstringNo
dateRangestringNo
fcrcountintegerкол-во тикетов, где вопрос клиента был решенNo
fcrpercentagenumberNo
groupIdintegerNo
hourRangestringNo
maxTotalTimeintegerNo
ratingintegerNo
slacceptTimeCountintegerNo
slacceptTimePercentnumberNo
sltotalResponseTimeCountintegerNo
sltotalResponseTimePercentnumberNo
sltotalTimeCountintegerNo
sltotalTimePercentnumberNo
totalLostintegerNo
totalMessagesintegerNo
totalPendingintegerNo
totalPersonalClientTicketsintegerNo
totalTicketsintegerMetricsNo
uniqueClientsintegerNo
weekdaystringNo

schema.TicketSetCategoryRequest​

NameTypeDescriptionRequired
categoryIdintegerNo
ticketIdintegerNo

schema.TicketSetFCRRequest​

NameTypeDescriptionRequired
fcrbooleanNo
ticketIdintegerNo

schema.TicketSetTagRequest​

NameTypeDescriptionRequired
tagIdintegerNo
ticketIdintegerNo

schema.TicketState​

NameTypeDescriptionRequired
schema.TicketStatestring

schema.TicketStatus​

NameTypeDescriptionRequired
schema.TicketStatusstring

schema.TicketStreamOutput​

NameTypeDescriptionRequired
clientschema.ClientNo
graphschema.GraphNo
infoRequestschema.InfoRequestNo
messageschema.TicketMessageNo
ticketschema.TicketNo
typingschema.TypingTicketMessageNo

schema.TicketTotalRow​

NameTypeDescriptionRequired
assigneeIdintegerNo
channelIdintegerInternalNo
groupIdintegerNo
totalInProgressTicketsintegerNo
totalOpenTicketsintegerNo
totalPendingTicketsintegerNo
workloadnumberNo

schema.TicketTransferRequest​

NameTypeDescriptionRequired
commentstringNo
priorityintegerNo
ticketIdintegerNo
userIdintegerNo

schema.TicketTransferSeveralRequest​

NameTypeDescriptionRequired
commentstringNo
priorityintegerNo
ticketIds[ integer ]No
userIdintegerNo

schema.TicketingSystem​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
emailstringNo
enabledbooleanNo
hoststringNo
idintegerNo
loginstringNo
passwordstringNo
portstringNo
projectIdintegerNo
sendTostringNo
titlestringNo
typeschema.TicketingSystemTypeNo
updatedAtstringNo

schema.TicketingSystemCreateRequest​

NameTypeDescriptionRequired
projectIdintegerNo
ticketingSystemschema.TicketingSystemInputNo

schema.TicketingSystemDeleteRequest​

NameTypeDescriptionRequired
ticketingSystemIdintegerNo

schema.TicketingSystemInput​

NameTypeDescriptionRequired
emailstringNo
hoststringNo
loginstringNo
passwordstringNo
portstringNo
sendTostringNo
titlestringNo
typeschema.TicketingSystemTypeNo

schema.TicketingSystemList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.TicketingSystem ]No
totalCountintegerNo

schema.TicketingSystemOutput​

NameTypeDescriptionRequired
ticketingSystemschema.TicketingSystemNo

schema.TicketingSystemProjectQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.TicketingSystemQueryNo

schema.TicketingSystemQuery​

NameTypeDescriptionRequired
enabledbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerInternalNo
qstringNo

schema.TicketingSystemQueryRequest​

NameTypeDescriptionRequired
queryschema.TicketingSystemQueryNo

schema.TicketingSystemToggleRequest​

NameTypeDescriptionRequired
enabledbooleanNo
ticketingSystemIdintegerNo

schema.TicketingSystemType​

NameTypeDescriptionRequired
schema.TicketingSystemTypestring

schema.TicketingSystemUpdateRequest​

NameTypeDescriptionRequired
ticketingSystemschema.TicketingSystemInputNo
ticketingSystemIdintegerNo

schema.TicketingSystemsOutput​

NameTypeDescriptionRequired
ticketingSystems[ schema.TicketingSystem ]No

schema.TicketsByCategory​

NameTypeDescriptionRequired
categoryNamestringNo
ticketsCountintegerNo

schema.TicketsClosingSettings​

NameTypeDescriptionRequired
closeBotDialogsbooleanNo
closeUserDialogsbooleanNo
closingMessagestringNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
enabledbooleanNo
idintegerNo
inactivityTimeintegerNo
projectIdintegerNo
updatedAtstringNo

schema.TicketsClosingSettingsCreateRequest​

NameTypeDescriptionRequired
projectIdintegerNo
settingsschema.TicketsClosingSettingsInputNo

schema.TicketsClosingSettingsInput​

NameTypeDescriptionRequired
closeBotDialogsbooleanNo
closeUserDialogsbooleanNo
closingMessagestringNo
deletedbooleanNo
enabledbooleanNo
inactivityTimeintegerNo
projectIdintegerNo

schema.TicketsClosingSettingsUpdateRequest​

NameTypeDescriptionRequired
settingsschema.TicketsClosingSettingsInputNo

schema.TypingCorporateChatMessage​

NameTypeDescriptionRequired
actorschema.ActorNo
corporateChatIdintegerNo
userschema.UserNo

schema.TypingTicketMessage​

NameTypeDescriptionRequired
actorschema.ActorNo
clientschema.ClientNo
ticketIdintegerNo
userschema.UserNo

schema.User​

NameTypeDescriptionRequired
activebooleanNo
assignedAtstringNo
avatarIdstringAvatar file idNo
busybooleanuser is active but does not receive any chats or ticketsNo
changePasswordbooleanNo
corporateChatDisabledAtstringNo
corporateChatEnabledbooleanNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
departmentstringNo
displayNamestringTransientNo
emailstringNo
idintegerNo
lastActiveAtstringNo
lastMessageAtstringNo
lastSeenAtstringNo
loggedInAtstringNo
loginstringNo
namestringNo
onlinebooleanNo
permissionsschema.GlobalPermissionsNo
positionstringNo
pseudonymstringNo
ratingnumberNo
restoredAtstringNo
roleIdintegerNo
scheduleIdintegerNo
skillIdssets.Int64No
totalAssignedTicketsintegerNo
totalsschema.TicketTotalRowNo
typeschema.UserTypeNo
updatedAtstringNo

schema.UserAuthBackend​

NameTypeDescriptionRequired
activebooleanNo
createOnLoginbooleanNo
createdAtstringNo
defaultRoleschema.UserRoleNo
defaultRoleIDintegerNo
deletedbooleanNo
idintegerNo
ldapdirschema.LDAPDirectoryTransientNo
ldapdirIdintegerNo
namestringNo
typeschema.UserAuthBackendTypeNo
updateOnLoginbooleanNo
updatedAtstringNo

schema.UserAuthBackendCreateRequest​

NameTypeDescriptionRequired
backendschema.UserAuthBackendInputNo

schema.UserAuthBackendDeleteRequest​

NameTypeDescriptionRequired
backendIdintegerNo

schema.UserAuthBackendInput​

NameTypeDescriptionRequired
createOnLoginbooleanNo
defaultRoleIDintegerNo
ldapdirschema.LDAPDirectoryInputNo
namestringNo
typeschema.UserAuthBackendTypeNo
updateOnLoginbooleanNo

schema.UserAuthBackendOutput​

NameTypeDescriptionRequired
userAuthBackendschema.UserAuthBackendNo

schema.UserAuthBackendToggleRequest​

NameTypeDescriptionRequired
activebooleanNo
backendIdintegerNo

schema.UserAuthBackendType​

NameTypeDescriptionRequired
schema.UserAuthBackendTypestring

schema.UserAuthBackendUpdateRequest​

NameTypeDescriptionRequired
backendschema.UserAuthBackendInputNo
backendIdintegerNo

schema.UserAuthBackendsOutput​

NameTypeDescriptionRequired
userAuthBackends[ schema.UserAuthBackend ]No

schema.UserAuthOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
sessionschema.UserSessionNo
userschema.UserNo

schema.UserAuthRequest​

NameTypeDescriptionRequired
emailstringNo
passwordstringNo

schema.UserAvatarInput​

NameTypeDescriptionRequired
schema.UserAvatarInputobject

schema.UserBotCreateOutput​

NameTypeDescriptionRequired
botschema.UserNo
graphschema.GraphNo

schema.UserBotCreateRequest​

NameTypeDescriptionRequired
botschema.UserBotInputNo

schema.UserBotInput​

NameTypeDescriptionRequired
namestringNo
roleIdintegerNo
userIdintegerNo

schema.UserBotUpdateOutput​

NameTypeDescriptionRequired
botschema.UserNo
graphschema.GraphNo

schema.UserBotUpdateRequest​

NameTypeDescriptionRequired
botschema.UserBotInputNo

schema.UserChangePasswordRequest​

NameTypeDescriptionRequired
currentPasswordstringNo
newPasswordstringNo

schema.UserChangeTempPasswordRequest​

NameTypeDescriptionRequired
passwordstringNo

schema.UserClearAvatarRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserCreateOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
tempPasswordstringNo
userschema.UserNo

schema.UserCreateRequest​

NameTypeDescriptionRequired
userschema.UserInputNo

schema.UserDeactivateRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserDeleteRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserGetRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserGoActiveRequest​

NameTypeDescriptionRequired
activebooleanNo

schema.UserIdRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserInput​

NameTypeDescriptionRequired
departmentstringNo
emailstringNo
loginstringNo
namestringNo
positionstringNo
pseudonymstringNo
roleIdintegerNo
scheduleIdintegerNo
skillIds[ integer ]No
typeschema.UserTypeNo

schema.UserList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.User ]No
totalCountintegerNo

schema.UserLogoutRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserOrderBy​

NameTypeDescriptionRequired
schema.UserOrderBystring

schema.UserOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
userschema.UserNo

schema.UserQuery​

NameTypeDescriptionRequired
activebooleanNo
corporateChatDisabledTimebooleanNo
corporateChatEnabledbooleanNo
countTotalsbooleanNo
deletedbooleanNo
deletedGroupMemberbooleanNo
excludeIds[ integer ]No
excludeMebooleanNo
groupIds[ integer ]No
groupProjectIdintegerNo
hasAssignedTicketsbooleanNo
hasNotAssignedTicketsbooleanNo
hasOrNotAssignedTicketsbooleanNo
ids[ integer ]No
lastActiveBeforestringNo
limitintegerNo
offsetintegerNo
onlinebooleanNo
orderschema.UserOrderByNo
personalManagersbooleanNo
qstringOptional search query.sNo
roleIds[ integer ]No
scheduleIds[ integer ]No
seenBeforestringNo
skillIds[ integer ]No
skillRegexstringNo
typeschema.UserTypeNo

schema.UserQueryByProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo

schema.UserQueryRequest​

NameTypeDescriptionRequired
queryschema.UserQueryNo

schema.UserReport​

NameTypeDescriptionRequired
rows[ schema.UserReportRow ]No
slstatschema.SLStatNo

schema.UserReportDimension​

NameTypeDescriptionRequired
schema.UserReportDimensionstring

schema.UserReportQuery​

NameTypeDescriptionRequired
categoryIds[ integer ]No
channelIds[ integer ]No
dateGroupschema.DateUnitNo
dimensionschema.UserReportDimensionNo
endstringNo
periodschema.PeriodNo
projectIdintegerFiltersNo
startstringInternalNo
userIds[ integer ]No

schema.UserReportRow​

NameTypeDescriptionRequired
avgRatingnumberMetricsNo
avgRespTimeintegerNo
avgTotalTimeintegerNo
categoryIdintegerNo
channelIdintegerNo
datestringDimensionsNo
emailstringNo
fcrpercentagenumberNo
maxRespTimeintegerNo
maxTotalTimeintegerNo
namestringNo
productivitynumberchats per hourNo
slacceptTimeCountintegerNo
slacceptTimePercentstringNo
sltotalResponseTimePercentstringNo
sltotalResponseTimeTimeCountintegerNo
sltotalTimeCountintegerNo
sltotalTimePercentstringNo
ticketsWithFCRintegerNo
totalMessagesintegerNo
totalOpenTicketsintegerNo
totalTicketsintegerNo
totalTicketsFromPersonalClientsintegerNo
totalTicketsFromPersonalClientsPercentnumberNo
totalTimeActiveintegerNo
totalTimeWorkingWithTicketsintegerNo
totalViolationsintegerNo
userIdintegerNo
workloadnumberNo

schema.UserResetPasswordOutput​

NameTypeDescriptionRequired
tempPasswordstringNo

schema.UserResetPasswordRequest​

NameTypeDescriptionRequired
userIdintegerNo

schema.UserRestoreRequest​

NameTypeDescriptionRequired
userschema.UserInputNo
userIdintegerNo

schema.UserRole​

NameTypeDescriptionRequired
adminbooleanNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
idintegerNo
permissionsschema.GlobalPermissionslen=4000No
restoredAtstringNo
titlestringNo
updatedAtstringNo

schema.UserRoleCreateRequest​

NameTypeDescriptionRequired
roleschema.UserRoleInputNo

schema.UserRoleDeleteRequest​

NameTypeDescriptionRequired
roleIdintegerNo

schema.UserRoleGetRequest​

NameTypeDescriptionRequired
roleIdintegerNo

schema.UserRoleInput​

NameTypeDescriptionRequired
adminbooleanNo
descriptionstringNo
permissionsschema.GlobalPermissionsNo
titlestringNo

schema.UserRoleList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.UserRole ]No
totalCountintegerNo

schema.UserRoleOutput​

NameTypeDescriptionRequired
roleschema.UserRoleNo

schema.UserRoleQuery​

NameTypeDescriptionRequired
adminbooleanNo
deletedbooleanNo
limitintegerNo
offsetintegerNo
qstringNo

schema.UserRoleQueryRequest​

NameTypeDescriptionRequired
queryschema.UserRoleQueryNo

schema.UserRoleUpdateRequest​

NameTypeDescriptionRequired
roleschema.UserRoleInputNo
roleIdintegerNo

schema.UserServiceCreateOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
serviceschema.UserNo
tokenschema.UserServiceTokenNo

schema.UserServiceCreateRequest​

NameTypeDescriptionRequired
serviceschema.UserServiceInputNo

schema.UserServiceInput​

NameTypeDescriptionRequired
namestringNo
roleIdintegerNo

schema.UserServiceToken​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
tokenstringNo
userIdintegerNo

schema.UserServiceTokenOutput​

NameTypeDescriptionRequired
tokenschema.UserServiceTokenNo

schema.UserServiceTokenRequest​

NameTypeDescriptionRequired
serviceIdintegerNo

schema.UserSession​

NameTypeDescriptionRequired
activebooleanNo
createdAtstringNo
expiresAtstringNo
idintegerNo
tokenstringlen=255No
userIdintegerNo

schema.UserSetupInput​

NameTypeDescriptionRequired
emailstringNo
namestringNo
passwordstringNo
positionstringNo

schema.UserSkill​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
idintegerNo
titlestringNo
updatedAtstringNo

schema.UserSkillCreateRequest​

NameTypeDescriptionRequired
skillschema.UserSkillInputNo

schema.UserSkillDeleteRequest​

NameTypeDescriptionRequired
skillIdintegerNo

schema.UserSkillGetRequest​

NameTypeDescriptionRequired
skillIdintegerNo

schema.UserSkillInput​

NameTypeDescriptionRequired
descriptionstringNo
titlestringNo

schema.UserSkillList​

NameTypeDescriptionRequired
graphschema.GraphNo
items[ schema.UserSkill ]No
totalCountintegerNo

schema.UserSkillOutput​

NameTypeDescriptionRequired
skillschema.UserSkillNo

schema.UserSkillQuery​

NameTypeDescriptionRequired
deletedbooleanNo
limitintegerNo
offsetintegerNo
qstringNo

schema.UserSkillQueryRequest​

NameTypeDescriptionRequired
queryschema.UserSkillQueryNo

schema.UserSkillUpdateRequest​

NameTypeDescriptionRequired
skillschema.UserSkillInputNo
skillIdintegerNo

schema.UserStatusesReportRowResponse​

NameTypeDescriptionRequired
rows[ schema.UsersReportRow ]No
statschema.UserStatusesStatNo

schema.UserStatusesStat​

NameTypeDescriptionRequired
totalTimeActiveForAllintegerNo
totalTimeBusyForAllintegerNo
totalTimeInactiveForAllintegerNo
totalWorkTimeForAllintegerNo

schema.UserType​

NameTypeDescriptionRequired
schema.UserTypestring

schema.UserUpdateRequest​

NameTypeDescriptionRequired
userschema.UserInputNo
userIdintegerNo

schema.UserWorkScheduleCreateRequest​

NameTypeDescriptionRequired
sameSchedulebooleanNo
workScheduleschema.WorkScheduleInputNo

schema.UserWorkScheduleDeleteRequest​

NameTypeDescriptionRequired
workScheduleIDintegerNo

schema.UserWorkScheduleOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
workScheduleschema.WorkScheduleNo

schema.UserWorkScheduleSetSameRequest​

NameTypeDescriptionRequired
workScheduleIDintegerNo

schema.UserWorkScheduleUpdateRequest​

NameTypeDescriptionRequired
workScheduleschema.WorkScheduleInputNo
workScheduleIDintegerNo

schema.UserWorkSchedulesOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
workSchedules[ schema.WorkSchedule ]No

schema.UsersAuthRequest​

NameTypeDescriptionRequired
tokenstringNo

schema.UsersOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
users[ schema.User ]No

schema.UsersReportRow​

NameTypeDescriptionRequired
efficiencystringNo
namestringNo
totalBusyTimesintegerNo
totalIdleTimeintegerNo
totalInactiveTimesintegerNo
totalInactiveTimesPerHournumberNo
totalTimeActiveintegerNo
totalTimeBusyintegerNo
totalTimeInactiveintegerNo
totalTimeWorkingWithTicketsintegerNo
totalWorkTimeintegerNo
workScheduleTimeintegerNo

schema.VKAccessTokenRequest​

NameTypeDescriptionRequired
tokenstringNo
vkgroupIdintegerNo

schema.VKChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
groupIdintegerNo
idintegerNo
namestringNo
restoredAtstringNo
updatedAtstringNo
uuidstringlen=36No

schema.VKConfig​

NameTypeDescriptionRequired
accessTokenstringGroup access code.No
channelIdintegerNo
confirmationCodestringWebhook confirmation code.No
secretKeystringOur secret key, generated on creation.No
webhookURLstringTransientNo

schema.VKConfigInput​

NameTypeDescriptionRequired
accessTokenstringNo
confirmationCodestringNo
groupIdintegerNo

schema.VKConfigOutput​

NameTypeDescriptionRequired
configschema.VKConfigNo

schema.VKConfigRequest​

NameTypeDescriptionRequired
channelIdintegerNo
configschema.VKConfigInputNo

schema.VKPollCreateRequest​

NameTypeDescriptionRequired
pollschema.PollInputNo
projectIdintegerNo

schema.VKPollDeleteRequest​

NameTypeDescriptionRequired
postIdintegerNo
projectIdintegerNo

schema.VKPost​

NameTypeDescriptionRequired
backgroundIdintegerNo
backgroundImageIdstringcustom background image for VK pollsNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
fileIds[ string ]transientNo
hasFilesbooleanNo
headerstringNo
idintegerNo
isMultiplebooleanNo
pollEndDateintegerend date in Unix secondsNo
pollIdintegerNo
pollOptions[ schema.PollOption ]No
publicIdintegervk group/communityNo
sentAtstringNo
stateschema.PostStateNo
textstringNo
totalVoterCountintegerNo
typeschema.PostTypeNo
updatedAtstringNo
userIdintegerUser who sent a message.No
vkidintegerid that VK API assigns to postNo

schema.VKPostCreateRequest​

NameTypeDescriptionRequired
postschema.PostInputNo
projectIdintegerNo

schema.VKPostOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
postschema.VKPostNo

schema.VKPostsOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
posts[ schema.VKPost ]No

schema.VKPostsQuery​

NameTypeDescriptionRequired
deletedbooleanNo
descbooleanNo
fromIdintegerid > from_idNo
limitintegerNo
offsetintegerNo
projectIdintegerNo
publicIdintegerNo
stateschema.PostStateNo
untilIdintegerid < until_idNo

schema.VKPostsQueryRequest​

NameTypeDescriptionRequired
publicIdintegerNo
queryschema.VKPostsQueryNo

schema.VKPublic​

NameTypeDescriptionRequired
channelIdintegerNo
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
idintegerNo
projectIdintegerNo
titlestringNo
updatedAtstringNo
userTokenstringNo
vkgroupIdintegerNo
vklinkstringlink to vk groupNo

schema.VKPublicCreateRequest​

NameTypeDescriptionRequired
vkpublicschema.VKPublicInputNo

schema.VKPublicDeleteRequest​

NameTypeDescriptionRequired
projectIdintegerNo
publicIdintegerNo

schema.VKPublicGetRequest​

NameTypeDescriptionRequired
publicIdintegerNo

schema.VKPublicInput​

NameTypeDescriptionRequired
channelIdintegerNo
projectIdintegerNo
titlestringNo
userTokenstringNo
vkgroupIdintegerNo
vklinkstringNo

schema.VKPublicOutput​

NameTypeDescriptionRequired
publicschema.VKPublicNo

schema.VKPublicQueryProjectRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.VKPublicsQueryNo

schema.VKPublicQueryRequest​

NameTypeDescriptionRequired
channelIdintegerNo
projectIdintegerNo
queryschema.VKPublicsQueryNo

schema.VKPublicUpdateRequest​

NameTypeDescriptionRequired
publicschema.VKPublicInputNo
publicIdintegerNo

schema.VKPublicsList​

NameTypeDescriptionRequired
items[ schema.VKPublic ]No
totalCountintegerNo

schema.VKPublicsQuery​

NameTypeDescriptionRequired
channelIdintegerNo
deletedbooleanNo
limitintegerNo
offsetintegerNo
projectIdintegerNo

schema.VKUser​

NameTypeDescriptionRequired
createdAtstringNewNo
firstNamestringNo
idintegerMatches VK user id.No
lastNamestringNo
photostringNo
screenNamestringNo
sexintegerNo
updatedAtstringNo

schema.ValidityPeriod​

NameTypeDescriptionRequired
schema.ValidityPeriodstring

schema.ValidityPeriodType​

NameTypeDescriptionRequired
schema.ValidityPeriodTypestring

schema.VersionOutput​

NameTypeDescriptionRequired
commitstringNo
datestringNo
versionstringNo

schema.ViberBotSettingsInput​

NameTypeDescriptionRequired
botTokenstringNo

schema.ViberChannel​

NameTypeDescriptionRequired
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
iconstringNo
idintegerMatches channel id.No
restoredAtstringNo
updatedAtstringNo
uristringviber URI to find the bot in browserNo
userIdstringViber dataNo
userNamestringBot name, len=1024No
uuidstringlen=36No

schema.ViberConfig​

NameTypeDescriptionRequired
botTokenstringNo
channelIdintegerlen=255No
webhookURLstringTransientNo

schema.ViberConfigOutput​

NameTypeDescriptionRequired
configschema.ViberConfigNo

schema.ViberConfigRequest​

NameTypeDescriptionRequired
channelIdintegerNo
viberBotSettingsschema.ViberBotSettingsInputNo

schema.ViberUser​

NameTypeDescriptionRequired
avatarstringNo
createdAtstringNo
idintegerMatches external id.No
namestringNo
updatedAtstringNo
viberIdstringNo

schema.ViolationInput​

NameTypeDescriptionRequired
ticketIdintegerNo
violationIdintegerNo

schema.Webhook​

NameTypeDescriptionRequired
actionTypeschema.ActionTypeNo
channelFilterbooleanNo
channelIdssets.Int64No
createdAtstringNo
deletedbooleanNo
deletedAtstringNo
descriptionstringNo
enabledbooleanNo
idintegerNo
projectIdintegerNo
titlestringNo
typeschema.WebhookTypeNo
updatedAtstringNo
urlstringNo
userFilterbooleanNo
userIdssets.Int64No

schema.WebhookConditionalCreateRequest​

NameTypeDescriptionRequired
projectIdintegerNo
webhookschema.WebhookConditionalInputNo

schema.WebhookConditionalInput​

NameTypeDescriptionRequired
actionTypeschema.ActionTypeNo
channelFilterbooleanNo
channelIdssets.Int64No
descriptionstringNo
titlestringNo
urlstringNo
userFilterbooleanNo
userIdssets.Int64No

schema.WebhookConditionalUpdateRequest​

NameTypeDescriptionRequired
webhookschema.WebhookConditionalInputNo
webhookIdintegerNo

schema.WebhookCreateRequest​

NameTypeDescriptionRequired
projectIdintegerNo
webhookschema.WebhookInputNo

schema.WebhookDeleteRequest​

NameTypeDescriptionRequired
webhookIdintegerNo

schema.WebhookGetRequest​

NameTypeDescriptionRequired
webhookIdintegerNo

schema.WebhookInput​

NameTypeDescriptionRequired
descriptionstringNo
titlestringNo
urlstringNo

schema.WebhookOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
webhookschema.WebhookNo

schema.WebhookQuery​

NameTypeDescriptionRequired
enabledbooleanNo
projectIdintegerInternalNo

schema.WebhookQueryRequest​

NameTypeDescriptionRequired
projectIdintegerNo
queryschema.WebhookQueryNo

schema.WebhookToggleRequest​

NameTypeDescriptionRequired
enabledbooleanNo
webhookIdintegerNo

schema.WebhookType​

NameTypeDescriptionRequired
schema.WebhookTypestring

schema.WebhookUpdateRequest​

NameTypeDescriptionRequired
webhookschema.WebhookInputNo
webhookIdintegerNo

schema.WebhooksOutput​

NameTypeDescriptionRequired
graphschema.GraphNo
webhooks[ schema.Webhook ]No

schema.Weekdays​

NameTypeDescriptionRequired
fridaybooleanNo
mondaybooleanNo
saturdaybooleanNo
sundaybooleanNo
thursdaybooleanNo
tuesdaybooleanNo
wednesdaybooleanNo
NameTypeDescriptionRequired
activeDirectorystringNo
automationstringNo
categoriesstringNo
categoriesReportsstringNo
channelsstringNo
clientReportsstringNo
clientsstringNo
companiesstringNo
dashboardstringNo
datesReportsstringNo
generalSettingsstringNo
groupsstringNo
inboxstringNo
integrationsstringNo
licensestringNo
mailingstringNo
myClientsstringNo
onlineReportsstringNo
personalManagersstringNo
postingstringNo
productsServicesstringNo
projectSettingsstringNo
projectsstringNo
quickRepliesstringNo
rolesstringNo
routingstringNo
statusReportsstringNo
targetsstringNo
ticketReportsstringNo
ticketsstringNo
userProfilestringNo
userReportsstringNo
usersstringNo
violationReportsstringNo
workingHoursstringNo
workingHoursReportsstringNo

schema.WorkSchedule​

NameTypeDescriptionRequired
activebooleanNo
breakDurationstringNo
createdAtstringNo
deletedbooleanNo
fridayEnabledbooleanNo
fridayEndHourintegerNo
fridayStartHourintegerNo
idintegerNo
membersCountintegerNo
mondayEnabledbooleanNo
mondayEndHourintegerNo
mondayStartHourintegerNo
refreshedAtstringNo
saturdayEnabledbooleanNo
saturdayEndHourintegerNo
saturdayStartHourintegerNo
scheduleschema.ScheduleNo
sundayEnabledbooleanNo
sundayEndHourintegerNo
sundayStartHourintegerNo
thursdayEnabledbooleanNo
thursdayEndHourintegerNo
thursdayStartHourintegerNo
titlestringNo
tuesdayEnabledbooleanNo
tuesdayEndHourintegerNo
tuesdayStartHourintegerNo
updatedAtstringNo
wednesdayEnabledbooleanNo
wednesdayEndHourintegerNo
wednesdayStartHourintegerNo

schema.WorkScheduleInput​

NameTypeDescriptionRequired
breakDurationstringNo
scheduleschema.ScheduleNo
titlestringNo

schema.WorkScheduleStatistic​

NameTypeDescriptionRequired
avgTicketsPerHournumberNo
membersCountintegerNo
messagesCountintegerNo
scheduleschema.ScheduleNo
scheduleIDintegerNo
ticketPercentagenumberNo
ticketsCountintegerNo
titlestringNo

schema.WorkScheduleStatisticOutput​

NameTypeDescriptionRequired
workScheduleStatistic[ schema.WorkScheduleStatistic ]No

sets.Int​

NameTypeDescriptionRequired
sets.Intobject

sets.Int64​

NameTypeDescriptionRequired
sets.Int64object

sets.String​

NameTypeDescriptionRequired
sets.Stringobject