Schema Public API

schema.AcceptProductRequest

Properties

Name	Type	Required	Restrictions	Description
messageId	integer	false	none	none
productId	integer	false	none	none

schema.Action

Properties

Name	Type	Required	Restrictions	Description
action	string	false	none	none
chatMessageId	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
id	integer	false	none	none
payload	string	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none
url	string	false	none	none

schema.ActorType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	client
anonymous	user
anonymous	system

schema.AfterWaitAction

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	autoclose
anonymous	notify

schema.AudioMessageEnabledFor

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	users
anonymous	clients
anonymous	all
anonymous	none

schema.BotFlowState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	ongoing
anonymous	ended

schema.CRMClient

Properties

Name	Type	Required	Restrictions	Description
birthDay	string	false	none	none
branchBik	string	false	none	БИК подразделения банка
branchExtRef	string	false	none	Идентификатор в АБС подразделения банка
branchId	string	false	none	Идентификатор подразделения банка в iSimpleBank 2.0
branchName	string	false	none	Наименование подразделения банка
cardRef	string	false	none	Идентификатор клиента в карточном бэк
cellphone	string	false	none	none
companies	[schema.CRMCompany]	false	none	none
crmid	integer	false	none	Айди CRM, через которую получен клиент, заполняется вручную.
crmurl	string	false	none	none
email	string	false	none	none
enabled	boolean	false	none	none
extId	string	false	none	Айди клиента в CRM.
extRef	string	false	none	Идентификатор клиента в АБС
fieldList	[schema.CRMClientField]	false	none	Дополнительные поля
firstName	string	false	none	none
inn	string	false	none	none
lastName	string	false	none	none
middleName	string	false	none	none
name	string	false	none	none
sex	string	false	none	none
shortName	string	false	none	none
token	string	false	none	none

schema.CRMClientField

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
value	string	false	none	none

schema.CRMCompany

Properties

Name	Type	Required	Restrictions	Description
crmid	integer	false	none	Айди CRM, через которую получена компания, заполняется вручну.
enabled	boolean	false	none	Обслуживание организации разрешено
extId	string	false	none	Айди компании в CRM.
extRef	string	false	none	Код клиента в АБС
inn	string	false	none	Details
internationalAddress	string	false	none	Итоговый полный международный адрес
internationalName	string	false	none	Международное наименование
kpp	string	false	none	КПП
name	string	false	none	none
ogrn	string	false	none	ОГРН
ogrndate	string	false	none	Дата ОГРН
phone	string	false	none	Телефоны
resident	boolean	false	none	признак "Нерезидент"
shortName	string	false	none	Сокращенное наименование

schema.Category

Properties

Name	Type	Required	Restrictions	Description
children	[schema.Category]	false	none	Transient
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
isFolder	boolean	false	none	none
parentId	integer	false	none	none
projectId	integer	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none

schema.Channel

Properties

Name	Type	Required	Restrictions	Description
audioMessagesEnabled	boolean	false	none	none
audioMessagesEnabledFor	schema.AudioMessageEnabledFor	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
description	string	false	none	none
edna	schema.EdnaChannel	false	none	none
facebook	schema.FacebookChannel	false	none	Transient
id	integer	false	none	none
infobip	schema.InfobipChannel	false	none	none
iqchat	schema.IQChatChannel	false	none	none
name	string	false	none	none
projectId	integer	false	none	none
telegram	schema.TelegramChannel	false	none	none
title	string	false	none	none
totalClients	integer	false	none	none
totalOpenTickets	integer	false	none	none
totalTickets	integer	false	none	none
totals	schema.TicketTotalRow	false	none	Dashboard
type	schema.ChannelType	false	none	len=64
updatedAt	string	false	none	none
viber	schema.ViberChannel	false	none	none
vk	schema.VKChannel	false	none	none

schema.ChannelType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	text
anonymous	iqchat
anonymous	facebook
anonymous	telegram
anonymous	viber
anonymous	vk
anonymous	infobip
anonymous	edna
anonymous	email

schema.Chat

Properties

Name	Type	Required	Restrictions	Description
changedAt	string	false	none	none
channelId	integer	false	none	none
childrenChats	[schema.Chat]	false	none	Transient
clientId	integer	false	none	none
clientParentId	integer	false	none	none
clientUnread	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
eventId	integer	false	none	Last event id.
id	integer	false	none	none
lastTicketAt	string	false	none	none
projectId	integer	false	none	none
systemChat	boolean	false	none	none
ticketId	integer	false	none	Last ticket id.
totalTickets	integer	false	none	none
type	schema.ChatType	false	none	len=32
userId	integer	false	none	none

schema.ChatBotPlatform

Properties

Name	Type	Required	Restrictions	Description
bsstoken	string	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
enabled	boolean	false	none	none
id	integer	false	none	none
login	string	false	none	none
password	string	false	none	none
projectId	integer	false	none	none
title	string	false	none	none
type	schema.ChatBotPlatformType	false	none	none
updatedAt	string	false	none	none
url	string	false	none	none

schema.ChatBotPlatformType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	botpress
anonymous	bss

schema.ChatEvent

Properties

Name	Type	Required	Restrictions	Description
actor	schema.ActorType	false	none	len=32
assignTo	integer	false	none	none
channelId	integer	false	none	none
chatId	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
id	integer	false	none	none
messageId	integer	false	none	none
messages	[schema.ChatMessage]	false	none	none
transitive	boolean	false	none	Transient
type	schema.ChatEventType	false	none	len=32
userId	integer	false	none	none

schema.ChatEventType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	chat_created
anonymous	chat_closed
anonymous	typing
anonymous	message_created
anonymous	message_received
anonymous	message_read
anonymous	message_listened
anonymous	close-system-chat
anonymous	delete-messages
anonymous	rating_rated
anonymous	rating_ignored
anonymous	ticket_assigned
anonymous	chat_changed

schema.ChatInfoInput

Properties

Name	Type	Required	Restrictions	Description
chatType	schema.ChatType	false	none	none

schema.ChatMessage

Properties

Name	Type	Required	Restrictions	Description
actions	[schema.Action]	false	none	none
author	schema.ActorType	false	none	Author
autoReply	boolean	false	none	none
botpressPayload	string	false	none	none
chatId	integer	false	none	none
clientId	integer	false	none	none
clientInfo	string	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
disableFreeText	boolean	false	none	none
emailBulk	boolean	false	none	none
eventId	integer	false	none	none
fileId	string	false	none	none
fileURL	string	false	none	none
id	integer	false	none	none
infoRequestId	integer	false	none	none
isDropDown	boolean	false	none	none
listened	boolean	false	none	none
listenedAt	string	false	none	none
localId	integer	false	none	none
mailingMessageId	integer	false	none	none
my	boolean	false	none	Transitive
openSystemChat	boolean	false	none	none
payload	schema.ChatMessagePayloadType	false	none	Payload
product	schema.Product	false	none	none
productId	integer	false	none	none
productOfferState	schema.ProductOfferState	false	none	none
pushed	boolean	false	none	none
ratingId	integer	false	none	none
read	boolean	false	none	none
readAt	string	false	none	none
received	boolean	false	none	Flags
receivedAt	string	false	none	none
replyToMessageId	integer	false	none	none
singleChoices	[schema.SingleChoice]	false	none	none
telegramMessageId	integer	false	none	none
text	string	false	none	none
ticketId	integer	false	none	none
ticketMessageId	integer	false	none	none
userId	integer	false	none	none
vkmessageId	integer	false	none	none

schema.ChatMessageInput

Properties

Name	Type	Required	Restrictions	Description
actions	[schema.Action]	false	none	none
botpressPayload	string	false	none	none
chatType	schema.ChatType	false	none	none
closeDialog	boolean	false	none	none
disableFreeText	boolean	false	none	none
emailMessageId	string	false	none	id needed to reply to client email
fileId	string	false	none	none
fileURL	string	false	none	none
groupId	string	false	none	chatbot response options
isDropDown	boolean	false	none	none
link	string	false	none	bss chatbot response
localId	integer	false	none	none
location	string	false	none	lat,lng pair;
openSystemDialog	boolean	false	none	none
operatorId	string	false	none	none
payload	schema.ChatMessagePayloadType	false	none	none
replyToMessageId	integer	false	none	none
singleChoices	[schema.SingleChoice]	false	none	none
telegramMessageId	integer	false	none	none
text	string	false	none	none
transferToQueue	boolean	false	none	none
userId	integer	false	none	none
vkmessageId	integer	false	none	messengers

schema.ChatMessagePayloadType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	text
anonymous	file
anonymous	rating
anonymous	single-choice
anonymous	card
anonymous	carousel
anonymous	product

schema.ChatMessageQuery

Properties

Name	Type	Required	Restrictions	Description
author	schema.ActorType	false	none	Internal
chatId	integer	false	none	ChatId and TicketId are mutually exclusive.
clientId	integer	false	none	none
deleted	boolean	false	none	none
desc	boolean	false	none	none
fromId	integer	false	none	none
limit	integer	false	none	none
offset	integer	false	none	none
q	string	false	none	none
read	boolean	false	none	none
ticketId	integer	false	none	none
ticketMessageIds	[integer]	false	none	none
toId	integer	false	none	none
untilId	integer	false	none	none

schema.ChatType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	regular
anonymous	personal_manager
anonymous	system

schema.ChatTypingInput

Properties

Name	Type	Required	Restrictions	Description
chatType	schema.ChatType	false	none	none

schema.CheckOpenTicketsRequest

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
query	schema.TicketQuery	false	none	none

schema.Client

Properties

Name	Type	Required	Restrictions	Description
avgRating	number	false	none	none
blockReason	string	false	none	none
blocked	boolean	false	none	none
blockedAt	string	false	none	none
blockedUntil	string	false	none	none
channel	schema.Channel	false	none	none
channelId	integer	false	none	Polymorphic relation, channel_id + a specific user id.
channelTypes	[schema.ChannelType]	false	none	none
comments	[schema.ClientComment]	false	none	none
companies	[schema.Company]	false	none	none
createdAt	string	false	none	none
crmclientId	string	false	none	none
crmid	integer	false	none	none
details	schema.ClientDetails	false	none	none
ednaId	integer	false	none	none
emailAddr	string	false	none	for email channel clients
facebook	schema.FacebookUser	false	none	none
facebookId	integer	false	none	none
groupName	string	false	none	none
id	integer	false	none	none
infoRequest	schema.InfoRequest	false	none	none
infobip	schema.InfobipUser	false	none	none
infobipId	integer	false	none	none
lastComment	schema.ClientComment	false	none	none
lastTicketAt	string	false	none	none
lastTicketId	integer	false	none	none
markerName	string	false	none	none
markerType	string	false	none	loyal or disloyal client
messagedAt	string	false	none	none
name	string	false	none	none
online	boolean	false	none	none
parent	schema.Client	false	none	Transient
parentId	integer	false	none	none
personalManagerId	integer	false	none	none
priority	integer	false	none	none
project	schema.Project	false	none	none
projectId	integer	false	none	none
seenAt	string	false	none	none
shortName	string	false	none	none
telegram	schema.TelegramUser	false	none	none
telegramId	integer	false	none	none
totalOpenTickets	integer	false	none	none
totalTickets	integer	false	none	none
type	schema.ClientType	false	none	len=64
updatedAt	string	false	none	none
userWhoBlockedId	integer	false	none	none
viber	schema.ViberUser	false	none	none
viberId	string	false	none	none
vk	schema.VKUser	false	none	none
vkid	integer	false	none	none

schema.ClientAnonSignup

Properties

Name	Type	Required	Restrictions	Description
channel	string	false	none	none
name	string	false	none	none

schema.ClientAuth

Properties

Name	Type	Required	Restrictions	Description
client	schema.Client	false	none	none
session	schema.ClientSession	false	none	none

schema.ClientAuthCRMInput

Properties

Name	Type	Required	Restrictions	Description
channel	string	false	none	Название канала на английском языке, например, support.
credentials	string	false	none	Любая безопасная строка, по которой внешняя система сможет авторизовать пользователя.
project	string	false	none	Название проекта на английском языке.

schema.ClientAuthInput

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	Токен внутренний сессии на сервере чата

schema.ClientComment

Properties

Name	Type	Required	Restrictions	Description
author	schema.User	false	none	transient
authorId	integer	false	none	none
channelType	schema.ChannelType	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
deletedByUserId	integer	false	none	none
editedAt	string	false	none	none
editedByUserId	integer	false	none	none
editedByUsername	string	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
rating	integer	false	none	none
ratingState	schema.RatingState	false	none	none
text	string	false	none	none

schema.ClientDetailField

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
id	integer	false	none	none
name	string	false	none	none
position	integer	false	none	none
updatedAt	string	false	none	none
value	string	false	none	none

schema.ClientDetails

Properties

Name	Type	Required	Restrictions	Description
birthday	string	false	none	none
branchBik	string	false	none	БИК подразделения банка
branchExtRef	string	false	none	Идентификатор в АБС подразделения банка
branchId	string	false	none	Идентификатор подразделения банка в iSimpleBank 2.0
branchName	string	false	none	Наименование подразделения банка
cardRef	string	false	none	Идентификатор клиента в карточном бэк
cellphone	string	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
crmurl	string	false	none	none
email	string	false	none	none
extRef	string	false	none	Идентификатор клиента в АБС
fields	[schema.ClientDetailField]	false	none	Transient
firstName	string	false	none	none
inn	string	false	none	none
lastName	string	false	none	none
middleName	string	false	none	none
sex	string	false	none	none
token	string	false	none	none
updatedAt	string	false	none	none

schema.ClientGroup

Properties

Name	Type	Required	Restrictions	Description
clientGroupMembers	[schema.ClientGroupMember]	false	none	none
clientGroups	[schema.ClientGroup]	false	none	Transient
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
id	integer	false	none	none
memberTotals	schema.GroupMemberTotals	false	none	none
parentId	integer	false	none	none
priority	integer	false	none	none
projectId	integer	false	none	none
ticketTotals	schema.GroupTicketTotals	false	none	Dashboard
title	string	false	none	none
totalClientGroups	integer	false	none	none
totalMembers	integer	false	none	none
totalOnlineMembers	integer	false	none	none
totalOpenTickets	integer	false	none	none
totals	schema.TicketTotalRow	false	none	Deprecated
updatedAt	string	false	none	none

schema.ClientGroupMember

Properties

Name	Type	Required	Restrictions	Description
client	schema.Client	false	none	none
clientGroupId	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
restoredAt	string	false	none	none
totals	schema.TicketTotalRow	false	none	Transient
updatedAt	string	false	none	none

schema.ClientInput

Properties

Name	Type	Required	Restrictions	Description
channel	string	false	none	Used in auth.
channelId	integer	false	none	none
crmclientId	string	false	none	none
crmid	integer	false	none	none
ednaId	integer	false	none	none
emailAddr	string	false	none	none
facebookId	integer	false	none	none
infobipId	integer	false	none	none
name	string	false	none	none
project	string	false	none	Deprecated, use Channel.
shortName	string	false	none	none
telegramId	integer	false	none	none
type	schema.ClientType	false	none	Internal
viberId	string	false	none	none
vkid	integer	false	none	none

schema.ClientInputName

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Имя клиента

schema.ClientInputProject

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Имя клиента
project	string	false	none	Название проекта на английском

schema.ClientProduct

Properties

Name	Type	Required	Restrictions	Description
boughtAt	string	false	none	none
clientId	integer	false	none	none
expiresAt	string	false	none	none
productId	integer	false	none	none
ticketId	integer	false	none	none

schema.ClientSession

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
createdAt	string	false	none	none
id	integer	false	none	none
integration	boolean	false	none	Deprecated
integrationCredentials	string	false	none	none
integrationHash	string	false	none	Credentials sha1
token	string	false	none	len=255

schema.ClientType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	internal
anonymous	crm
anonymous	channel

schema.Company

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
crmid	integer	false	none	none
details	schema.CompanyDetails	false	none	Transient
extRef	string	false	none	none
id	integer	false	none	none
name	string	false	none	none
projectId	integer	false	none	none
totalMembers	integer	false	none	none
updatedAt	string	false	none	none

schema.CompanyDetails

Properties

Name	Type	Required	Restrictions	Description
companyId	integer	false	none	none
createdAt	string	false	none	none
inn	string	false	none	ИНН
internationalAddress	string	false	none	Итоговый полный международный адрес
internationalName	string	false	none	Международное наименование
kpp	string	false	none	КПП
ogrn	string	false	none	ОГРН
ogrndate	string	false	none	Дата ОГРН
phone	string	false	none	Телефоны
resident	boolean	false	none	признак "Нерезидент"
shortName	string	false	none	Сокращенное наименование
updatedAt	string	false	none	none

schema.CorporateChat

Properties

Name	Type	Required	Restrictions	Description
admin	schema.User	false	none	none
adminId	integer	false	none	none
changedAt	string	false	none	none
corporateChatEventId	integer	false	none	none
corporateChatMessageId	integer	false	none	Last message id.
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
initiated	boolean	false	none	has messages from users(not system messsages)
members	[schema.CorporateChatMember]	false	none	none
membersCount	integer	false	none	none
myId	integer	false	none	none
otherUser	schema.User	false	none	for private chats
secondMemberId	integer	false	none	transient
title	string	false	none	none
totalMessages	integer	false	none	none
type	schema.CorporateChatType	false	none	len=32

schema.CorporateChatAction

Properties

Name	Type	Required	Restrictions	Description
actorId	integer	false	none	User who made an action.
comment	string	false	none	none
corporateChatId	integer	false	none	none
createdAt	string	false	none	none
id	integer	false	none	none
text	string	false	none	Transitive
type	schema.CorporateChatActionType	false	none	len=32
userId	integer	false	none	none

schema.CorporateChatActionType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	created
anonymous	deleted
anonymous	member_left
anonymous	member_joined
anonymous	member_invited
anonymous	member_kicked

schema.CorporateChatMember

Properties

Name	Type	Required	Restrictions	Description
corporateChatId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
me	boolean	false	none	Transient
updatedAt	string	false	none	none
userId	integer	false	none	none

schema.CorporateChatMessage

Properties

Name	Type	Required	Restrictions	Description
action	schema.CorporateChatAction	false	none	none
actionId	integer	false	none	none
corporateChatEventId	integer	false	none	none
corporateChatId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
fileId	string	false	none	none
fileURL	string	false	none	none
id	integer	false	none	none
listened	boolean	false	none	none
listenedAt	string	false	none	none
localId	integer	false	none	none
mentionedUserIds	sets.Int64	false	none	none
my	boolean	false	none	Transitive
pushed	boolean	false	none	none
read	boolean	false	none	none
readAt	string	false	none	none
received	boolean	false	none	Flags
receivedAt	string	false	none	none
replyToMessageId	integer	false	none	none
text	string	false	none	none
type	schema.CorporateChatMessagePayloadType	false	none	Payload
uid	string	false	none	none
updatedAt	string	false	none	none
user	schema.User	false	none	none
userId	integer	false	none	none

schema.CorporateChatMessagePayloadType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	text
anonymous	file
anonymous	action

schema.CorporateChatType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	private
anonymous	group

schema.CredentialsRequest

Properties

Name	Type	Required	Restrictions	Description
credentials	string	false	none	none

schema.EdnaChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	Matches channel id.
restoredAt	string	false	none	none
updatedAt	string	false	none	none
uuid	string	false	none	len=36

schema.EmptyResponseApi1

Properties

Name	Type	Required	Restrictions	Description
error	schema.Error	false	none	none
ok	boolean	false	none	none
rels	schema.Graph	false	none	none
result	object	false	none	none

schema.Error

Properties

Name	Type	Required	Restrictions	Description
code	schema.ErrorCode	false	none	none
text	string	false	none	none

schema.ErrorCode

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	not_found
anonymous	forbidden
anonymous	unauthorized
anonymous	invalid

schema.FacebookChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
pageId	string	false	none	len=255
pageName	string	false	none	len=1024
restoredAt	string	false	none	none
updatedAt	string	false	none	none
uuid	string	false	none	len=36

schema.FacebookUser

Properties

Name	Type	Required	Restrictions	Description
channelId	integer	false	none	none
createdAt	string	false	none	none
firstName	string	false	none	len=255
gender	string	false	none	len=6
id	integer	false	none	none
lastName	string	false	none	len=255
profilePicture	string	false	none	len=255
updatedAt	string	false	none	none
userId	string	false	none	Facebook data

schema.File

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
contentType	string	false	none	len=128
createdAt	string	false	none	none
id	string	false	none	len=255
imageHeight	integer	false	none	none
imageWidth	integer	false	none	none
name	string	false	none	Original file name.
owner	schema.FileOwnerType	false	none	none
ownerClientId	integer	false	none	none
path	string	false	none	Relative filesystem path
size	integer	false	none	Size in bytes
type	schema.ActorType	false	none	len=255
userId	integer	false	none	none

schema.FileOwnerType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	public
anonymous	client

schema.FileTokenRequest

Properties

Name	Type	Required	Restrictions	Description
fileId	string	false	none	none

schema.FileType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	file
anonymous	image
anonymous	audio
anonymous	xlxs
anonymous	csv

schema.FinishRatingPollRequest

Properties

Name	Type	Required	Restrictions	Description
rated	boolean	false	none	none
ratingId	integer	false	none	none
ratingPollId	integer	false	none	none

schema.GlobalPermissions

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	false	none	none

schema.Graph

Properties

Name	Type	Required	Restrictions	Description
categories	[schema.Category]	false	none	none
channels	[schema.Channel]	false	none	none
chatBotPlatforms	[schema.ChatBotPlatform]	false	none	none
chatMessages	[schema.ChatMessage]	false	none	none
chats	[schema.Chat]	false	none	none
clientDetails	[schema.ClientDetails]	false	none	none
clientGroups	[schema.ClientGroup]	false	none	none
clients	[schema.Client]	false	none	none
companies	[schema.Company]	false	none	none
corporateChatMessages	[schema.CorporateChatMessage]	false	none	none
corporateChats	[schema.CorporateChat]	false	none	none
crmcustomers	[schema.CRMClient]	false	none	none
eventUser	schema.User	false	none	none
files	[schema.File]	false	none	none
groups	[schema.Group]	false	none	none
groupsPermissions	[schema.GroupPermissions]	false	none	none
inbox	[schema.Inbox]	false	none	none
infoRequests	[schema.InfoRequest]	false	none	none
orgs	[schema.Org]	false	none	none
personalManagers	[schema.PersonalManager]	false	none	none
projects	[schema.Project]	false	none	none
ratingPolls	[schema.RatingPoll]	false	none	none
ratings	[schema.Rating]	false	none	none
tags	[schema.Tag]	false	none	none
targetViolations	[schema.TargetViolation]	false	none	none
targets	[schema.Target]	false	none	none
ticketActions	[schema.TicketAction]	false	none	none
ticketMembers	[schema.TicketMember]	false	none	none
ticketMessages	[schema.TicketMessage]	false	none	none
tickets	[schema.Ticket]	false	none	none
totalAssignedToBot	integer	false	none	none
userRoles	[schema.UserRole]	false	none	none
userSkills	[schema.UserSkill]	false	none	none
users	[schema.User]	false	none	none
waitTickets	[schema.WaitTicket]	false	none	none

schema.GreetingResponse

Properties

Name	Type	Required	Restrictions	Description
greeting	string	false	none	none
greetingBold	string	false	none	none

schema.Group

Properties

Name	Type	Required	Restrictions	Description
admin	boolean	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
groups	[schema.Group]	false	none	Transient
id	integer	false	none	none
memberTotals	schema.GroupMemberTotals	false	none	none
members	[schema.GroupMember]	false	none	none
options	schema.GroupOptions	false	none	none
parentId	integer	false	none	none
permissions	schema.ProjectPermissions	false	none	none
project	schema.Project	false	none	none
projectId	integer	false	none	none
ticketTotals	schema.GroupTicketTotals	false	none	Dashboard
title	string	false	none	none
totalGroups	integer	false	none	none
totalMembers	integer	false	none	none
totalOnlineMembers	integer	false	none	none
totalOpenTickets	integer	false	none	none
totals	schema.TicketTotalRow	false	none	Deprecated
updatedAt	string	false	none	none

schema.GroupMember

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
groupId	integer	false	none	none
id	integer	false	none	none
restoredAt	string	false	none	none
totals	schema.TicketTotalRow	false	none	Transient
updatedAt	string	false	none	none
user	schema.User	false	none	none
userId	integer	false	none	none

schema.GroupMemberTotals

Properties

Name	Type	Required	Restrictions	Description
activeMembers	integer	false	none	none
groupId	integer	false	none	none
inactiveMembers	integer	false	none	none
onlineMembers	integer	false	none	none

schema.GroupOptions

Properties

Name	Type	Required	Restrictions	Description
receiveProjectNotifications	boolean	false	none	none

schema.GroupPermissions

Properties

Name	Type	Required	Restrictions	Description
admin	boolean	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
groups	[schema.GroupPermissions]	false	none	Transient
id	integer	false	none	none
memberTotals	schema.GroupMemberTotals	false	none	none
members	[schema.GroupMember]	false	none	none
options	schema.GroupOptions	false	none	len=4000
parentId	integer	false	none	none
permissions	schema.ProjectPermissions	false	none	len=4000
project	schema.Project	false	none	none
projectId	integer	false	none	none
ticketTotals	schema.GroupTicketTotals	false	none	Dashboard
title	string	false	none	none
totalGroups	integer	false	none	none
totalMembers	integer	false	none	none
totalOnlineMembers	integer	false	none	none
totalOpenTickets	integer	false	none	none
totals	schema.TicketTotalRow	false	none	Deprecated
updatedAt	string	false	none	none

schema.GroupTicketTotals

Properties

Name	Type	Required	Restrictions	Description
groupId	integer	false	none	none
inProgressTickets	integer	false	none	none
openTickets	integer	false	none	none
pendingTickets	integer	false	none	none

schema.IQChatAPNS

Properties

Name	Type	Required	Restrictions	Description
certificate	string	false	none	P12
channelId	integer	false	none	Primary key.
createdAt	string	false	none	none
enabled	boolean	false	none	none
key	string	false	none	text
p8Key	string	false	none	P8
p8KeyID	string	false	none	len=255
p8TeamID	string	false	none	len=255
password	string	false	none	len=255
production	boolean	false	none	none
topic	string	false	none	len=255
type	schema.IQChatAPNSType	false	none	none
updatedAt	string	false	none	none

schema.IQChatAPNSType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	p12
anonymous	p8

schema.IQChatChannel

Properties

Name	Type	Required	Restrictions	Description
apns	schema.IQChatAPNS	false	none	Transient
channelId	integer	false	none	Primary key.
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
restoredAt	string	false	none	none
updatedAt	string	false	none	none

schema.Inbox

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
totalOpenThreads	integer	false	none	none
totalUnreadMessages	integer	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	Id

schema.InfoRequest

Properties

Name	Type	Required	Restrictions	Description
clientConsent	boolean	false	none	согласие на обработку данных
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
email	string	false	none	none
fields	[schema.InfoRequestField]	false	none	none
id	integer	false	none	none
name	string	false	none	none
phone	string	false	none	none
processingDataLink	string	false	none	none
projectId	integer	false	none	none
state	schema.InfoRequestState	false	none	none
ticketId	integer	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	none

schema.InfoRequestField

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
id	integer	false	none	none
name	string	false	none	none
position	integer	false	none	none
updatedAt	string	false	none	none
value	string	false	none	none

schema.InfoRequestState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	pending
anonymous	ignored
anonymous	finished

schema.InfoResponse

Properties

Name	Type	Required	Restrictions	Description
clientConsent	boolean	false	none	none
clientId	integer	false	none	none
email	string	false	none	none
firstName	string	false	none	none
phone	string	false	none	none
requestId	integer	false	none	none
surName	string	false	none	none

schema.InfobipChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	Matches channel id.
phone	string	false	none	none
restoredAt	string	false	none	none
updatedAt	string	false	none	none
uuid	string	false	none	len=36

schema.InfobipUser

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
id	integer	false	none	none
name	string	false	none	none
phone	string	false	none	none
updatedAt	string	false	none	none

schema.License

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
current	boolean	false	none	none
expired	boolean	false	none	none
id	integer	false	none	none
terms	schema.LicenseTerms	false	none	Transient
updatedAt	string	false	none	none

schema.LicenseTerms

Properties

Name	Type	Required	Restrictions	Description
activeDirectory	boolean	false	none	none
audioMessagesEnabled	boolean	false	none	none
autogenerated	boolean	false	none	none
channelTypes	[schema.ChannelType]	false	none	none
chat	boolean	false	none	Deprecated: use ChannelTypes with ChannelTypeIQChat instead
chatBotPlatformTypes	[schema.ChatBotPlatformType]	false	none	none
chatBotsEnabled	boolean	false	none	none
corporateChatEnabled	boolean	false	none	none
corporateChatUsers	integer	false	none	0 means unlimited
enableChatBotExtensions	boolean	false	none	none
enableChatBotFaq	boolean	false	none	none
enableChatBotWorkflow	boolean	false	none	none
expiresAt	string	false	none	none
helpDeskEnabled	boolean	false	none	none
helpDeskIntegrationTypes	[string]	false	none	none
iqpro	boolean	false	none	Pro version with additional functionalities
mailingLists	boolean	false	none	none
mailings	boolean	false	none	none
personalManagersEnabled	boolean	false	none	none
personalManagersOnline	integer	false	none	0 means unlimited.
postManagementEnabled	boolean	false	none	none
productShowcase	boolean	false	none	витрина продуктов
projects	integer	false	none	0 means unlimited.
publicFunctionTypes	[string]	false	none	none
publicsCount	integer	false	none	none
ratingPolls	boolean	false	none	none
reports	boolean	false	none	none
serverId	string	false	none	none
social	boolean	false	none	Deprecated: use ChannelTypes with allowed channel types instead
title	string	false	none	none
type	schema.LicenseType	false	none	none
uniqueChatBots	integer	false	none	0 means unlimited
users	integer	false	none	0 means unlimited.

schema.LicenseType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	commercial
anonymous	trial
anonymous	test

schema.Marker

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
greenMarkerName	string	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
redMarkerName	string	false	none	none
updatedAt	string	false	none	none

schema.MarkerType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	green
anonymous	red
anonymous	unmarked

schema.Org

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	MaxInbox int32 `db:"max_inbox"` // Deprecated
domain	string	false	none	none
id	integer	false	none	none
name	string	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none

schema.Period

Properties

Name	Type	Required	Restrictions	Description
end	string	false	none	none
hoursEnd	integer	false	none	none
hoursStart	integer	false	none	none
minutesEnd	integer	false	none	none
minutesStart	integer	false	none	none
start	string	false	none	none
type	schema.PeriodType	false	none	none

schema.PeriodType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	today
anonymous	yesterday
anonymous	week
anonymous	prev_week
anonymous	month
anonymous	prev_month
anonymous	7days
anonymous	30days
anonymous	90days
anonymous	custom

schema.PeriodicPayment

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	free
anonymous	paid

schema.PeriodicPaymentType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	none
anonymous	day
anonymous	week
anonymous	month
anonymous	year

schema.PersonalManager

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
userId	integer	false	none	none

schema.PersonalManagerResponse

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none

schema.PollOptionType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	one_of_list
anonymous	input
anonymous	stars
anonymous	fcr

schema.PollStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	active
anonymous	inactive
anonymous	draft
anonymous	deleted

schema.Price

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	free
anonymous	paid

schema.PriceDurationType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	none
anonymous	day
anonymous	week
anonymous	month
anonymous	year

schema.Product

Properties

Name	Type	Required	Restrictions	Description
clientProduct	schema.ClientProduct	false	none	none
connectedCount	integer	false	none	none
createdAt	string	false	none	none
crmid	integer	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
descriptionForAgents	string	false	none	none
descriptionForClients	string	false	none	none
icon	string	false	none	none
id	integer	false	none	none
name	string	false	none	none
periodicPayment	schema.PeriodicPayment	false	none	none
periodicPaymentPrice	integer	false	none	none
periodicPaymentType	schema.PeriodicPaymentType	false	none	none
price	schema.Price	false	none	none
priceDurationType	schema.PriceDurationType	false	none	none
priceRUR	integer	false	none	none
productsNeededToEnable	[schema.Product]	false	none	none
projectId	integer	false	none	none
restriction	boolean	false	none	none
type	schema.ProductType	false	none	none
updatedAt	string	false	none	none
validityPeriod	schema.ValidityPeriod	false	none	none
validityPeriodDuration	integer	false	none	none
validityPeriodType	schema.ValidityPeriodType	false	none	none

schema.ProductOfferState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	pending
anonymous	accepted
anonymous	declined

schema.ProductType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	product
anonymous	service
anonymous	package

schema.Project

Properties

Name	Type	Required	Restrictions	Description
archivedAt	string	false	none	none
createdAt	string	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
id	integer	false	none	none
license	schema.License	false	none	none
name	string	false	none	none
options	schema.ProjectOptions	false	none	none
permissions	schema.ProjectPermissions	false	none	none
responseTimeSettings	schema.ResponseTimeSettings	false	none	none
restoredAt	string	false	none	none
slug	string	false	none	none
state	schema.ProjectState	false	none	len=32
totalAgentCount	integer	false	none	none
totalAssignedTickets	integer	false	none	Total open assigned tickets
totalChannelCount	integer	false	none	none
totalClientCount	integer	false	none	Transient
totalOpenTickets	integer	false	none	none
totalTickets	integer	false	none	none
updatedAt	string	false	none	none
wikiLinks	schema.WikiLinks	false	none	none

schema.ProjectOptions

Properties

Name	Type	Required	Restrictions	Description
afterWaitAction	schema.AfterWaitAction	false	none	none
allowUserFileUpload	boolean	false	none	none
confirmOfflineSending	boolean	false	none	none
createdAt	string	false	none	none
displayNotificationForPostponed	boolean	false	none	none
enableUserRatings	boolean	false	none	none
extendedWaitingTime	boolean	false	none	none
maxActiveTickets	integer	false	none	none
maxActiveTicketsPerUser	integer	false	none	none
noReplyTime	integer	false	none	in seconds
processingDataLink	string	false	none	none
projectId	integer	false	none	none
reassignEnabled	boolean	false	none	reassign settings
reassignGroupIds	sets.Int64	false	none	none
reassignTo	string	false	none	agent, group or queue
reassignUserIds	sets.Int64	false	none	none
requireCategory	boolean	false	none	none
requireRegistration	boolean	false	none	none
returnPostponedToQueue	boolean	false	none	none
sameUserAssign	boolean	false	none	none
sameUserAssignTime	integer	false	none	none
showFCRFor	string	false	none	none
showWaitButton	boolean	false	none	none
spellingCheck	boolean	false	none	none
ticketWaitTime	integer	false	none	none
updatedAt	string	false	none	none

schema.ProjectPermissions

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	false	none	none

schema.ProjectState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	active
anonymous	archived
anonymous	deleted

schema.PushTokenInput

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	none
type	schema.PushTokenType	false	none	none

schema.PushTokenType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	apns
anonymous	fcm

schema.QueryRatingPollRequest

Properties

Name	Type	Required	Restrictions	Description
query	schema.RatingPollQuery	false	none	none

schema.Rating

Properties

Name	Type	Required	Restrictions	Description
clientId	integer	false	none	none
comment	string	false	none	none
createdAt	string	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
ratingPollId	integer	false	none	none
state	schema.RatingState	false	none	none
ticketId	integer	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	none
value	integer	false	none	none

schema.RatingIdRequest

Properties

Name	Type	Required	Restrictions	Description
ratingId	integer	false	none	none

schema.RatingInput

Properties

Name	Type	Required	Restrictions	Description
comment	string	false	none	none
value	integer	false	none	none

schema.RatingPoll

Properties

Name	Type	Required	Restrictions	Description
categories	[schema.Category]	false	none	none
categoryFilter	boolean	false	none	none
categoryIds	sets.Int64	false	none	len=4000
channelFilter	boolean	false	none	none
channelIds	sets.Int64	false	none	len=4000
channels	[schema.Channel]	false	none	none
clientGroup	schema.ClientGroup	false	none	none
clientGroupFilter	boolean	false	none	none
clientGroupId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
feedbackThanks	boolean	false	none	none
feedbackThanksText	string	false	none	none
id	integer	false	none	none
marker	schema.Marker	false	none	none
markerFilter	boolean	false	none	none
markerTypes	sets.String	false	none	none
order	integer	false	none	none
projectId	integer	false	none	none
questions	[schema.RatingPollQuestion]	false	none	none
showOffer	boolean	false	none	none
status	schema.PollStatus	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none

schema.RatingPollAnswer

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
fcr	boolean	false	none	none
id	integer	false	none	none
order	integer	false	none	none
ratingPollQuestionId	integer	false	none	none
text	string	false	none	none
updatedAt	string	false	none	none

schema.RatingPollClientAnswer

Properties

Name	Type	Required	Restrictions	Description
answerInput	string	false	none	none
answerStars	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
fcr	boolean	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
rating	schema.Rating	false	none	none
ratingId	integer	false	none	none
ratingPollAnswerId	integer	false	none	none
ratingPollAnswerText	string	false	none	Transition
ratingPollQuestionId	integer	false	none	none
ticketId	integer	false	none	none
type	schema.PollOptionType	false	none	none
updatedAt	string	false	none	none

schema.RatingPollClientAnswerInput

Properties

Name	Type	Required	Restrictions	Description
answerInput	string	false	none	none
answerStars	integer	false	none	none
clientId	integer	false	none	none
fcr	boolean	false	none	none
projectId	integer	false	none	none
ratingId	integer	false	none	none
ratingPollAnswerId	integer	false	none	none
ratingPollQuestionId	integer	false	none	none
type	schema.PollOptionType	false	none	none

schema.RatingPollQuery

Properties

Name	Type	Required	Restrictions	Description
categoryId	string	false	none	none
channelId	integer	false	none	none
channelIdQ	string	false	none	none
clientId	integer	false	none	none
desc	boolean	false	none	none
enabled	boolean	false	none	none
fromOrder	integer	false	none	none
limit	integer	false	none	none
markerType	string	false	none	none
projectId	integer	false	none	none
ratingId	integer	false	none	none

schema.RatingPollQuestion

Properties

Name	Type	Required	Restrictions	Description
answers	[schema.RatingPollAnswer]	false	none	none
asTicketRating	boolean	false	none	none
clientAnswer	schema.RatingPollClientAnswer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
order	integer	false	none	none
ratingPollId	integer	false	none	none
text	string	false	none	none
type	schema.PollOptionType	false	none	none
updatedAt	string	false	none	none

schema.RatingPollResponse

Properties

Name	Type	Required	Restrictions	Description
poll	schema.RatingPoll	false	none	none

schema.RatingRequest

Properties

Name	Type	Required	Restrictions	Description
rating	schema.RatingInput	false	none	none
ratingId	integer	false	none	none

schema.RatingState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	pending
anonymous	ignored
anonymous	rated
anonymous	poll
anonymous	finished

schema.RequestIdRequest

Properties

Name	Type	Required	Restrictions	Description
requestId	integer	false	none	none

schema.ResponseApi1

Properties

Name	Type	Required	Restrictions	Description
error	schema.Error	false	none	none
ok	boolean	false	none	none
rels	schema.Graph	false	none	none
result	object	false	none	none

schema.ResponseTimeSettings

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
fieldFive	integer	false	none	none
fieldFour	integer	false	none	none
fieldOne	integer	false	none	before how many seconds
fieldSix	integer	false	none	after how many seconds
fieldThree	integer	false	none	none
fieldTwo	integer	false	none	none
projectId	integer	false	none	none
updatedAt	string	false	none	none

schema.SendRatingPollRequest

Properties

Name	Type	Required	Restrictions	Description
ratingPollClientAnswerInput	schema.RatingPollClientAnswerInput	false	none	none

schema.SingleChoice

Properties

Name	Type	Required	Restrictions	Description
chatMessageId	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
tag	string	false	none	tags for bss bot buttons
title	string	false	none	none
updatedAt	string	false	none	none
value	string	false	none	none

schema.SystemChatSettings

Properties

Name	Type	Required	Restrictions	Description
botId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
enabled	boolean	false	none	none
greetFrom	string	false	none	none
id	integer	false	none	none
lifetime	integer	false	none	lifetime is measured in seconds
message	string	false	none	message to be sent by the operator to the client
messageForBot	string	false	none	message to be sent to the bot
operatorName	string	false	none	none
projectId	integer	false	none	none
updatedAt	string	false	none	none

schema.Tag

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
text	string	false	none	none

schema.Target

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deletedAt	string	false	none	none
enabled	boolean	false	none	none
id	integer	false	none	none
inactivityTime	string	false	none	none
optimalDuration	string	false	none	none
pendingTime	string	false	none	none
projectId	integer	false	none	none
reactionTime	string	false	none	none
replyTime	string	false	none	none
responseTime	string	false	none	none
title	string	false	none	Transient
type	schema.TargetType	false	none	none
updatedAt	string	false	none	none

schema.TargetType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	reaction_time
anonymous	response_time
anonymous	inactivity_time
anonymous	pending_time
anonymous	reply_time
anonymous	optimal_duration
anonymous	bad_word
anonymous	low_rating
anonymous	auto_block
anonymous	users_block
anonymous	missed_after_assigned
anonymous	missed_before_assigned
anonymous	closed_with_no_answer
anonymous	client_msg_in_postponed

schema.TargetViolation

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
duration	integer	false	none	none
id	integer	false	none	none
projectId	integer	false	none	none
resolved	boolean	false	none	none
startedAt	string	false	none	none
statusId	integer	false	none	Inactive status id.
targetId	integer	false	none	none
ticketId	integer	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	none

schema.TelegramChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	Matches channel id.
restoredAt	string	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	Telegram data
userName	string	false	none	Bot name, len=1024
uuid	string	false	none	len=36

schema.TelegramUser

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
firstName	string	false	none	none
id	integer	false	none	Matches external id.
lastName	string	false	none	none
updatedAt	string	false	none	none
userName	string	false	none	none

schema.Ticket

Properties

Name	Type	Required	Restrictions	Description
acceptTime	integer	false	none	Duration before the ticket has been accepted.
acceptTimeOK	boolean	false	none	none
acceptedAt	string	false	none	none
accepterId	integer	false	none	none
assignTime	integer	false	none	Deprecated, use AcceptTime; duration before the ticket has been assigned.
assignedAt	string	false	none	none
assigneeId	integer	false	none	none
autoClosed	boolean	false	none	none
avgReplyTime	integer	false	none	none
blockReason	string	false	none	none
blocked	boolean	false	none	none
blockedAt	string	false	none	none
blockedUntil	string	false	none	none
botFlowState	schema.BotFlowState	false	none	bss bot
bsssessionId	string	false	none	none
cannotAssignReason	schema.TicketCannotAssignReason	false	none	none
categoryId	integer	false	none	none
channelId	integer	false	none	none
chatId	integer	false	none	none
checkReassign	boolean	false	none	reassign if agent does not respond after a ticket was assigned to him
clientId	integer	false	none	none
closedAt	string	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
fcr	boolean	false	none	none
greeted	boolean	false	none	Greeting message has been sent.
groupId	integer	false	none	none
hasComments	boolean	false	none	none
hasWaitTicket	boolean	false	none	none
id	integer	false	none	none
infoRequest	schema.InfoRequest	false	none	none
infoRequestId	integer	false	none	none
initiatorClient	boolean	false	none	none
ip	string	false	none	none
ipcity	string	false	none	none
ipcountry	string	false	none	none
lost	boolean	false	none	Like Missed, but for Target & reports
members	[schema.TicketMember]	false	none	none
messageId	integer	false	none	Last message id.
missed	boolean	false	none	none
notifyWaitReturn	boolean	false	none	none
open	boolean	false	none	none
openedAt	string	false	none	none
permissions	schema.TicketPermissions	false	none	none
postponedUntil	string	false	none	none
priority	integer	false	none	none
projectId	integer	false	none	none
ratingId	integer	false	none	none
reactionChecked	boolean	false	none	none
reassignedAt	string	false	none	none
registered	boolean	false	none	Marked as registered.
registeredAt	string	false	none	none
registeredBy	integer	false	none	none
repeat	boolean	false	none	none
respondedAt	string	false	none	none
responseTime	integer	false	none	Agent reaction time from the assign time til the first reply.
skipRegistration	boolean	false	none	Transient
state	schema.TicketState	false	none	len=32
status	schema.TicketStatus	false	none	none
statusChangedAt	string	false	none	none
systemTicket	boolean	false	none	none
tagIds	sets.Int64	false	none	none
ticketComments	[schema.TicketComment]	false	none	none
title	string	false	none	len=255
totalAssignments	integer	false	none	none
totalMembers	integer	false	none	none
totalMessages	integer	false	none	none
totalResponseTime	integer	false	none	Time from the creation til the first reply.
totalResponseTimeOK	boolean	false	none	none
totalTime	integer	false	none	Total time this ticket has been opened.
totalTimeOK	boolean	false	none	none
transferredFromBot	boolean	false	none	none
ua	string	false	none	none
uabrowser	string	false	none	none
uabrowserVersion	string	false	none	none
uamobile	boolean	false	none	none
uaos	string	false	none	none
uaosversion	string	false	none	none
uaplatform	string	false	none	none
updatedAt	string	false	none	none
userWhoBlocked	schema.User	false	none	none
userWhoBlockedId	integer	false	none	none
violationId	integer	false	none	none
waitTicket	schema.WaitTicket	false	none	none
waitingTimeReply	boolean	false	none	none

schema.TicketAction

Properties

Name	Type	Required	Restrictions	Description
actorId	integer	false	none	User who made an action.
comment	string	false	none	none
createdAt	string	false	none	none
groupId	integer	false	none	Assigned group.
id	integer	false	none	none
text	string	false	none	Transitive
ticketId	integer	false	none	none
type	schema.TicketActionType	false	none	len=32
userId	integer	false	none	Assignee, member, etc.

schema.TicketActionType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	opened
anonymous	closed
anonymous	assigned
anonymous	assigned_to_group
anonymous	unassigned
anonymous	member_left
anonymous	member_joined
anonymous	member_invited
anonymous	member_kicked
anonymous	repeat_ticket

schema.TicketCannotAssignReason

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	nonworkhours
anonymous	nooperators

schema.TicketComment`}`

Properties

Name	Type	Required	Restrictions	Description
author	schema.User	false	none	transient
authorId	integer	false	none	none
channelType	schema.ChannelType	false	none	none
chatId	integer	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
deletedByUserId	integer	false	none	none
editedAt	string	false	none	none
editedByUserId	integer	false	none	none
editedByUsername	string	false	none	none
id	integer	false	none	none
text	string	false	none	none
ticketId	integer	false	none	none

schema.TicketList

Properties

Name	Type	Required	Restrictions	Description
graph	schema.Graph	false	none	none
items	[schema.Ticket]	false	none	none
totalCount	integer	false	none	none

schema.TicketMember

Properties

Name	Type	Required	Restrictions	Description
assignedAt	string	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
id	integer	false	none	none
me	boolean	false	none	Transient
ticketId	integer	false	none	none
unassignedAt	string	false	none	none
updatedAt	string	false	none	none
userId	integer	false	none	none

schema.TicketMessage

Properties

Name	Type	Required	Restrictions	Description
actionId	integer	false	none	none
actions	[schema.Action]	false	none	none
author	schema.ActorType	false	none	Author
autoreplyId	integer	false	none	none
botpressPayload	string	false	none	none
clientId	integer	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
disableFreeText	boolean	false	none	none
emailMessageId	string	false	none	id needed to reply to client email
fileId	string	false	none	len=255
greeting	boolean	false	none	none
id	integer	false	none	none
infoRequest	schema.InfoRequest	false	none	none
infoRequestId	integer	false	none	none
isDropDown	boolean	false	none	none
listened	boolean	false	none	none
listenedAt	string	false	none	none
localId	integer	false	none	none
my	boolean	false	none	Transitive
productId	integer	false	none	none
ratingId	integer	false	none	none
read	boolean	false	none	none
readAt	string	false	none	none
received	boolean	false	none	Flags
receivedAt	string	false	none	none
replyTime	integer	false	none	none
replyToMessageId	integer	false	none	none
singleChoices	[schema.SingleChoice]	false	none	none
telegramMessageId	integer	false	none	none
text	string	false	none	len=4000
ticketId	integer	false	none	none
type	schema.TicketMessageType	false	none	Payload
uid	string	false	none	40 chars, sha1(chatId, client
updatedAt	string	false	none	none
userId	integer	false	none	none
vkmessageId	integer	false	none	none

schema.TicketMessageType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	text
anonymous	file
anonymous	action
anonymous	rating
anonymous	info_request
anonymous	single-choice
anonymous	product
anonymous	card
anonymous	carousel

schema.TicketPermissions

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	false	none	none

schema.TicketQuery

Properties

Name	Type	Required	Restrictions	Description
accepterIds	[integer]	false	none	none
assigneeIds	[integer]	false	none	none
blocked	boolean	false	none	none
categoryIds	[integer]	false	none	none
channelIds	[integer]	false	none	none
chatId	integer	false	none	none
chatTypes	[schema.ChatType]	false	none	none
clientId	integer	false	none	none
clientName	string	false	none	none
companyId	integer	false	none	none
connected	boolean	false	none	Includes the children tickets.
desc	boolean	false	none	none
endHMS	string	false	none	none
excludeIds	[integer]	false	none	none
groupIds	[integer]	false	none	none
groupIsNil	boolean	false	none	Queries "group_id is null" when true.
haveCategory	boolean	false	none	none
limit	integer	false	none	none
marker	schema.MarkerType	false	none	client's marker type (loyal or disloyal)
noCategory	boolean	false	none	none
noTag	boolean	false	none	none
notBlocked	boolean	false	none	none
offset	integer	false	none	none
open	boolean	false	none	none
orderByBlockedAt	boolean	false	none	none
orderByClient	boolean	false	none	none
orderByIP	boolean	false	none	none
orderByPriority	boolean	false	none	none
parentId	integer	false	none	none
period	schema.Period	false	none	none
personalManager	boolean	false	none	none
priorities	[integer]	false	none	none
projectId	integer	false	none	none
ratingStates	[schema.RatingState]	false	none	none
ratings	[integer]	false	none	none
startHMS	string	false	none	none
state	schema.TicketState	false	none	none
systemTicket	boolean	false	none	none
tagId	string	false	none	none
tagIds	[string]	false	none	none
tagIdsStr	string	false	none	none
tagRegex	string	false	none	none
whoBlockedIds	[integer]	false	none	none

schema.TicketState

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	pending
anonymous	postponed
anonymous	on_wait
anonymous	work_in_progress
anonymous	closed

schema.TicketStatus

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous
anonymous	awaiting_client
anonymous	awaiting_user

schema.TicketTotalRow

Properties

Name	Type	Required	Restrictions	Description
assigneeId	integer	false	none	none
channelId	integer	false	none	Internal
groupId	integer	false	none	none
totalInProgressTickets	integer	false	none	none
totalOpenTickets	integer	false	none	none
totalPendingTickets	integer	false	none	none
workload	number	false	none	none

schema.TokenResponse

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	none

schema.User

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
assignedAt	string	false	none	none
avatarId	string	false	none	Avatar file id
busy	boolean	false	none	user is active but does not receive any chats or tickets
changePassword	boolean	false	none	none
corporateChatDisabledAt	string	false	none	none
corporateChatEnabled	boolean	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
department	string	false	none	none
displayName	string	false	none	Transient
email	string	false	none	none
groupsPermissions	[schema.GroupPermissions]	false	none	none
groupsPermissionsIds	sets.Int64	false	none	none
id	integer	false	none	none
lastActiveAt	string	false	none	none
lastMessageAt	string	false	none	none
lastSeenAt	string	false	none	none
loggedInAt	string	false	none	none
login	string	false	none	none
mobileActive	boolean	false	none	Приложение для операторов
name	string	false	none	none
online	boolean	false	none	none
permissions	schema.GlobalPermissions	false	none	none
position	string	false	none	none
pseudonym	string	false	none	none
rating	number	false	none	none
restoredAt	string	false	none	none
roleId	integer	false	none	none
scheduleId	integer	false	none	none
skillIds	sets.Int64	false	none	none
totalAssignedTickets	integer	false	none	none
totals	schema.TicketTotalRow	false	none	none
type	schema.UserType	false	none	none
updatedAt	string	false	none	none

schema.UserPushTokenInput

Properties

Name	Type	Required	Restrictions	Description
token	string	false	none	none
type	schema.PushTokenType	false	none	none
userId	integer	false	none	none

schema.UserRole

Properties

Name	Type	Required	Restrictions	Description
admin	boolean	false	none	none
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
id	integer	false	none	none
permissions	schema.GlobalPermissions	false	none	len=4000
restoredAt	string	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none

schema.UserSkill

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
description	string	false	none	none
id	integer	false	none	none
title	string	false	none	none
updatedAt	string	false	none	none

schema.UserType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	user
anonymous	service
anonymous	bot

schema.VKChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
groupId	integer	false	none	none
id	integer	false	none	none
name	string	false	none	none
restoredAt	string	false	none	none
updatedAt	string	false	none	none
uuid	string	false	none	len=36

schema.VKUser

Properties

Name	Type	Required	Restrictions	Description
birthDate	string	false	none	none
city	string	false	none	none
country	string	false	none	none
createdAt	string	false	none	New
firstName	string	false	none	none
id	integer	false	none	Matches VK user id.
lastName	string	false	none	none
mobilePhone	string	false	none	none
photo	string	false	none	none
screenName	string	false	none	none
sex	integer	false	none	none
updatedAt	string	false	none	none

schema.ValidityPeriod

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	enabled
anonymous	indefinite
anonymous	one_time

schema.ValidityPeriodType

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	none
anonymous	day
anonymous	month
anonymous	year

schema.Version

Properties

Name	Type	Required	Restrictions	Description
commit	string	false	none	none
date	string	false	none	none
version	string	false	none	none

schema.ViberChannel

Properties

Name	Type	Required	Restrictions	Description
createdAt	string	false	none	none
deleted	boolean	false	none	none
deletedAt	string	false	none	none
icon	string	false	none	none
id	integer	false	none	Matches channel id.
restoredAt	string	false	none	none
updatedAt	string	false	none	none
uri	string	false	none	viber URI to find the bot in browser
userId	string	false	none	Viber data
userName	string	false	none	Bot name, len=1024
uuid	string	false	none	len=36

schema.ViberUser

Properties

Name	Type	Required	Restrictions	Description
avatar	string	false	none	none
createdAt	string	false	none	none
id	integer	false	none	Matches external id.
name	string	false	none	none
updatedAt	string	false	none	none
viberId	string	false	none	none

schema.WaitTicket

Properties

Name	Type	Required	Restrictions	Description
changedAt	string	false	none	none
deleted	boolean	false	none	none
ticketId	integer	false	none	none
userId	integer	false	none	none
waitUntil	string	false	none	none

schema.WikiLinks

Properties

Name	Type	Required	Restrictions	Description
activeDirectory	string	false	none	none
automation	string	false	none	none
bans	string	false	none	none
categories	string	false	none	none
categoriesReports	string	false	none	none
channels	string	false	none	none
clientReports	string	false	none	none
clients	string	false	none	none
companies	string	false	none	none
dashboard	string	false	none	none
datesReports	string	false	none	none
generalSettings	string	false	none	none
groups	string	false	none	none
inbox	string	false	none	none
integrations	string	false	none	none
license	string	false	none	none
mailing	string	false	none	none
myClients	string	false	none	none
onlineReports	string	false	none	none
personalManagers	string	false	none	none
posting	string	false	none	none
productsServices	string	false	none	none
projectSettings	string	false	none	none
projects	string	false	none	none
quickReplies	string	false	none	none
ratingPolls	string	false	none	none
roles	string	false	none	none
routing	string	false	none	none
statusReports	string	false	none	none
targets	string	false	none	none
ticketReports	string	false	none	none
tickets	string	false	none	none
userProfile	string	false	none	none
userReports	string	false	none	none
userSkills	string	false	none	none
users	string	false	none	none
violationReports	string	false	none	none
workSchedules	string	false	none	none
workingHours	string	false	none	none
workingHoursReports	string	false	none	none

sets.Int64

{
  "property1": true,
  "property2": true
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	false	none	none

sets.String

{
  "property1": true,
  "property2": true
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	false	none	none

Page tree

Schema Public API

schema.AcceptProductRequest

Properties

schema.Action

Properties

schema.ActorType

Properties

Enumerated Values

schema.AfterWaitAction

Properties

Enumerated Values

schema.AudioMessageEnabledFor

Properties

Enumerated Values

schema.BotFlowState

Properties

Enumerated Values

schema.CRMClient

Properties

schema.CRMClientField

Properties

schema.CRMCompany

Properties

schema.Category

Properties

schema.Channel

Properties

schema.ChannelType

Properties

Enumerated Values

schema.Chat

Properties

schema.ChatBotPlatform

Properties

schema.ChatBotPlatformType

Properties

Enumerated Values

schema.ChatEvent

Properties

schema.ChatEventType

Properties

Enumerated Values

schema.ChatInfoInput

Properties

schema.ChatMessage

Properties

schema.ChatMessageInput

Properties

schema.ChatMessagePayloadType

Properties

Enumerated Values

schema.ChatMessageQuery

Properties

schema.ChatType

Properties

Enumerated Values

schema.ChatTypingInput

Properties

schema.CheckOpenTicketsRequest

Properties

schema.Client

Properties

schema.ClientAnonSignup

Properties

schema.ClientAuth

Properties

schema.ClientAuthCRMInput

Properties

schema.ClientAuthInput

Properties

schema.ClientComment

Properties

schema.ClientDetailField

Properties

schema.ClientDetails

Properties

schema.ClientGroup

Properties

schema.ClientGroupMember