Reference
Queries#
messageCatalogue#
Requires: scope messages:read.
messageCatalogue(platformId: ID): [MessageTypeView!]!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformMessages#
Requires: scope messages:read.
platformMessages(platformId: ID, filter: PlatformMessageFilter): [PlatformMessageView!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
filter | PlatformMessageFilter |
platformMessageRouting#
Requires: scope messages:read.
platformMessageRouting(platformId: ID, profileId: ID): [MessageRoutingRuleView!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
profileId | ID |
platformMessageSettings#
Requires: scope messages:read.
platformMessageSettings(platformId: ID): PlatformMessageSettingsView!
| Argument | Type | |
|---|---|---|
platformId | ID |
platformMessageCopy#
Requires: scope messages:read.
platformMessageCopy(type: String): [PlatformMessageCopy!]!
| Argument | Type | |
|---|---|---|
type | String |
previewPlatformMessageCopy#
Requires: scope messages:read.
previewPlatformMessageCopy(type: String!, variant: String!, template: String!, data: JSONObject!): PlatformMessageCopyPreview!
| Argument | Type | |
|---|---|---|
type | String! | |
variant | String! | |
template | String! | |
data | JSONObject! |
Mutations#
sendAssistantMessage#
Requires: scope messages:write · feature ai_assistant.
sendAssistantMessage(profileId: ID, bookkeeperId: ID, enterpriseId: ID, conversationId: ID!, input: SendAssistantMessageInput!): AssistantMessageView!
| Argument | Type | |
|---|---|---|
profileId | ID | |
bookkeeperId | ID | |
enterpriseId | ID | |
conversationId | ID! | |
input | SendAssistantMessageInput! |
rateAssistantMessage#
Requires: scope messages:write · feature ai_assistant.
rateAssistantMessage(profileId: ID, bookkeeperId: ID, enterpriseId: ID, messageId: ID!, input: RateAssistantMessageInput!): AssistantMessageView!
| Argument | Type | |
|---|---|---|
profileId | ID | |
bookkeeperId | ID | |
enterpriseId | ID | |
messageId | ID! | |
input | RateAssistantMessageInput! |
requestBookkeeperMessageChannel#
Requires: scope messages:write.
requestBookkeeperMessageChannel(bookkeeperId: ID!, type: MessageChannelType): RequestBookkeeperMessageChannelResult!
| Argument | Type | |
|---|---|---|
bookkeeperId | ID! | |
type | MessageChannelType |
updateBookkeeperMessageChannel#
Requires: scope messages:write.
updateBookkeeperMessageChannel(bookkeeperId: ID!, input: UpdateBookkeeperMessageChannelInput!, type: MessageChannelType): BookkeeperMessageChannelConfigView!
| Argument | Type | |
|---|---|---|
bookkeeperId | ID! | |
input | UpdateBookkeeperMessageChannelInput! | |
type | MessageChannelType |
disableBookkeeperMessageChannel#
Requires: scope messages:write.
disableBookkeeperMessageChannel(bookkeeperId: ID!, type: MessageChannelType): Boolean!
| Argument | Type | |
|---|---|---|
bookkeeperId | ID! | |
type | MessageChannelType |
acknowledgeMessage#
Requires: scope messages:write.
acknowledgeMessage(platformId: ID, input: AcknowledgeMessageInput!): PlatformMessageView!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | AcknowledgeMessageInput! |
acknowledgeMessages#
Requires: scope messages:write.
acknowledgeMessages(platformId: ID, inputs: [AcknowledgeMessageInput!]!): [PlatformMessageView!]!
| Argument | Type | |
|---|---|---|
platformId | ID | |
inputs | [AcknowledgeMessageInput!]! |
markMessageRead#
Requires: scope messages:write.
markMessageRead(platformId: ID, id: ID!): PlatformMessageView!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
resendPlatformMessage#
Requires: scope messages:write.
resendPlatformMessage(platformId: ID, id: ID!): PlatformMessageView!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
setPlatformMessageRouting#
Requires: scope messages:write.
setPlatformMessageRouting(platformId: ID, input: SetMessageRoutingInput!): MessageRoutingRuleView!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | SetMessageRoutingInput! |
clearPlatformMessageRouting#
Requires: scope messages:write.
clearPlatformMessageRouting(platformId: ID, id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
platformId | ID | |
id | ID! |
updatePlatformMessageSettings#
Requires: scope messages:write.
updatePlatformMessageSettings(platformId: ID, input: UpdatePlatformMessageSettingsInput!): PlatformMessageSettingsView!
| Argument | Type | |
|---|---|---|
platformId | ID | |
input | UpdatePlatformMessageSettingsInput! |
setPlatformMessageCopy#
Requires: scope messages:write.
setPlatformMessageCopy(input: SetPlatformMessageCopyInput!): PlatformMessageCopy!
| Argument | Type | |
|---|---|---|
input | SetPlatformMessageCopyInput! |
clearPlatformMessageCopy#
Requires: scope messages:write.
clearPlatformMessageCopy(id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! |