Serialized Form

Package com.bytedesk.ai.ai_statistic

Class com.bytedesk.ai.ai_statistic.AiStatisticEntity

class AiStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the statistic

name

String name

Name of the statistic

type

String type

Type of statistic (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.ai.ai_statistic.AiStatisticRequest

class AiStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.ai.ai_statistic.AiStatisticResponse

class AiStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.ai.ai_statistic.event

Class com.bytedesk.ai.ai_statistic.event.AiStatisticCreateEvent

class AiStatisticCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

AiStatisticEntity statistic

Class com.bytedesk.ai.ai_statistic.event.AiStatisticDeleteEvent

class AiStatisticDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

AiStatisticEntity statistic

Class com.bytedesk.ai.ai_statistic.event.AiStatisticUpdateEvent

class AiStatisticUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

AiStatisticEntity statistic

Package com.bytedesk.ai.demos.booking

Class com.bytedesk.ai.demos.booking.BookingEntity

class BookingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

bookingClass

String bookingClass

bookingDate

ZonedDateTime bookingDate

bookingNumber

String bookingNumber

consumer

ConsumerEntity consumer

from

String from

status

String status

to

String to

Class com.bytedesk.ai.demos.booking.BookingRequest

class BookingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

bookingClass

String bookingClass

bookingDate

ZonedDateTime bookingDate

bookingNumber

String bookingNumber

consumerUid

String consumerUid

from

String from

status

String status

to

String to

Class com.bytedesk.ai.demos.booking.BookingResponse

class BookingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

bookingClass

String bookingClass

bookingDate

ZonedDateTime bookingDate

bookingNumber

String bookingNumber

consumer

ConsumerResponse consumer

from

String from

status

String status

to

String to

Package com.bytedesk.ai.demos.booking.event

Class com.bytedesk.ai.demos.booking.event.AbstractBookingEvent

class AbstractBookingEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

booking

BookingEntity booking

Class com.bytedesk.ai.demos.booking.event.BookingCreateEvent

class BookingCreateEvent extends AbstractBookingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.demos.booking.event.BookingDeleteEvent

class BookingDeleteEvent extends AbstractBookingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.demos.booking.event.BookingUpdateEvent

class BookingUpdateEvent extends AbstractBookingEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ai.demos.consumer

Class com.bytedesk.ai.demos.consumer.ConsumerEntity

class ConsumerEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

bookings

List<BookingEntity> bookings

description

String description

Description of the consumer

name

String name

Name of the consumer

type

String type

Type of consumer (BOOKING, SHOPPING, etc.)

Class com.bytedesk.ai.demos.consumer.ConsumerRequest

class ConsumerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.ai.demos.consumer.ConsumerResponse

class ConsumerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.ai.demos.consumer.event

Class com.bytedesk.ai.demos.consumer.event.AbstractConsumerEvent

class AbstractConsumerEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

consumer

ConsumerEntity consumer

Class com.bytedesk.ai.demos.consumer.event.ConsumerCreateEvent

class ConsumerCreateEvent extends AbstractConsumerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.demos.consumer.event.ConsumerDeleteEvent

class ConsumerDeleteEvent extends AbstractConsumerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.demos.consumer.event.ConsumerUpdateEvent

class ConsumerUpdateEvent extends AbstractConsumerEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ai.mcp_client

Class com.bytedesk.ai.mcp_client.McpClientEntity

class McpClientEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the mcp_client

name

String name

Name of the mcp_client

type

String type

Type of mcp_client (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.ai.mcp_client.McpClientRequest

class McpClientRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.ai.mcp_client.McpClientResponse

class McpClientResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.ai.mcp_client.event

Class com.bytedesk.ai.mcp_client.event.AbstractMcpClientEvent

class AbstractMcpClientEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

mcp_client

McpClientEntity mcp_client

Class com.bytedesk.ai.mcp_client.event.McpClientCreateEvent

class McpClientCreateEvent extends AbstractMcpClientEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.mcp_client.event.McpClientDeleteEvent

class McpClientDeleteEvent extends AbstractMcpClientEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.mcp_client.event.McpClientUpdateEvent

class McpClientUpdateEvent extends AbstractMcpClientEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ai.mcp_server

Class com.bytedesk.ai.mcp_server.McpServerEntity

class McpServerEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

Category UID for organizing servers (optional)

description

String description

MCP Server description

enabled

Boolean enabled

Whether the server is enabled

name

String name

MCP Server name

serverConfig

String serverConfig

Server configuration in JSON format Contains all server-specific configuration including: - serverVersion, serverUrl, host, port, protocol - authToken, authType, authHeaders - connectionTimeout, readTimeout, maxRetries - capabilities, availableTools, availableResources, availablePrompts - environmentVars, healthCheckUrl, healthCheckInterval - priority, tags, metadata, usageStats - autoStart and other settings

status

String status

Server status (ACTIVE, INACTIVE, ERROR, CONNECTING, etc.)

type

String type

Type of MCP server

Class com.bytedesk.ai.mcp_server.McpServerRequest

class McpServerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

description

String description

enabled

Boolean enabled

name

String name

serverConfig

String serverConfig

Server configuration in JSON format Contains all server-specific configuration including: - serverVersion, serverUrl, host, port, protocol - authToken, authType, authHeaders - connectionTimeout, readTimeout, maxRetries - capabilities, availableTools, availableResources, availablePrompts - environmentVars, healthCheckUrl, healthCheckInterval - priority, tags, metadata, usageStats - autoStart and other settings

serverType

String serverType

status

McpServerStatusEnum status

Class com.bytedesk.ai.mcp_server.McpServerResponse

class McpServerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

description

String description

enabled

Boolean enabled

name

String name

serverConfig

String serverConfig

Server configuration in JSON format Contains all server-specific configuration including: - serverVersion, serverUrl, host, port, protocol - authToken, authType, authHeaders - connectionTimeout, readTimeout, maxRetries - capabilities, availableTools, availableResources, availablePrompts - environmentVars, healthCheckUrl, healthCheckInterval - priority, tags, metadata, usageStats - autoStart and other settings

status

McpServerStatusEnum status

type

String type

Package com.bytedesk.ai.mcp_server.event

Class com.bytedesk.ai.mcp_server.event.McpServerCreateEvent

class McpServerCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

mcpServer

McpServerEntity mcpServer

Class com.bytedesk.ai.mcp_server.event.McpServerDeleteEvent

class McpServerDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

mcpServer

McpServerEntity mcpServer

Class com.bytedesk.ai.mcp_server.event.McpServerUpdateEvent

class McpServerUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

mcpServer

McpServerEntity mcpServer

Package com.bytedesk.ai.model

Class com.bytedesk.ai.model.LlmModelEntity

class LlmModelEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the model capabilities

enabled

Boolean enabled

free

Boolean free

name

String name

Model name used for API calls

nickname

String nickname

User-friendly nickname for the model

providerType

String providerType

Type of the model provider

providerUid

String providerUid

Associated provider UID

systemEnabled

Boolean systemEnabled

tagList

List<String> tagList

标签列表

type

String type

Type of LLM model (TEXT, EMBEDDING, etc.)

Class com.bytedesk.ai.model.LlmModelRequest

class LlmModelRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

free

Boolean free

name

String name

nickname

String nickname

providerType

String providerType

providerUid

String providerUid

systemEnabled

Boolean systemEnabled

tagList

List<String> tagList

Class com.bytedesk.ai.model.LlmModelResponse

class LlmModelResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

free

Boolean free

name

String name

nickname

String nickname

providerType

String providerType

providerUid

String providerUid

systemEnabled

Boolean systemEnabled

tagList

List<String> tagList

type

String type

Package com.bytedesk.ai.model.event

Class com.bytedesk.ai.model.event.LlmModelCreateEvent

class LlmModelCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

lmModel

LlmModelEntity lmModel

Class com.bytedesk.ai.model.event.LlmModelUpdateEvent

class LlmModelUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

llmModelEntity

LlmModelEntity llmModelEntity

Package com.bytedesk.ai.prompt

Class com.bytedesk.ai.prompt.PromptEntity

class PromptEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the prompt

enabled

boolean enabled

Whether the prompt is enabled

locale

String locale

Preferred locale (e.g. zh-CN, en-US)

metadata

String metadata

Extra metadata (JSON)

name

String name

Name of the prompt

systemPrompt

String systemPrompt

System prompt template (TEXT)

tags

String tags

Optional tags (JSON array) Example: ["sales", "support"]

type

String type

Type of prompt (CUSTOMER, TICKET, ARTICLE, etc.)

userPrompt

String userPrompt

User prompt template (TEXT)

variables

String variables

Template variables (JSON) Example: {"customerName": "string", "lang": "zh-CN"}

Class com.bytedesk.ai.prompt.PromptRequest

class PromptRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

locale

String locale

metadata

String metadata

name

String name

systemPrompt

String systemPrompt

tags

String tags

userPrompt

String userPrompt

variables

String variables

Class com.bytedesk.ai.prompt.PromptResponse

class PromptResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

boolean enabled

locale

String locale

metadata

String metadata

name

String name

systemPrompt

String systemPrompt

tags

String tags

type

String type

userPrompt

String userPrompt

variables

String variables

Package com.bytedesk.ai.prompt.event

Class com.bytedesk.ai.prompt.event.AbstractPromptEvent

class AbstractPromptEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

prompt

PromptEntity prompt

Class com.bytedesk.ai.prompt.event.PromptCreateEvent

class PromptCreateEvent extends AbstractPromptEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.prompt.event.PromptDeleteEvent

class PromptDeleteEvent extends AbstractPromptEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ai.prompt.event.PromptUpdateEvent

class PromptUpdateEvent extends AbstractPromptEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ai.provider

Class com.bytedesk.ai.provider.LlmProviderEntity

class LlmProviderEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

baseUrl

String baseUrl

cozeBotId

String cozeBotId

description

String description

enabled

Boolean enabled

logo

String logo

nickname

String nickname

ragflowId

String ragflowId

ragflowType

String ragflowType

status

String status

systemEnabled

Boolean systemEnabled

type

String type

webUrl

String webUrl

Class com.bytedesk.ai.provider.LlmProviderRequest

class LlmProviderRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

baseUrl

String baseUrl

cozeBotId

String cozeBotId

description

String description

enabled

Boolean enabled

logo

String logo

nickname

String nickname

ragflowId

String ragflowId

ragflowType

String ragflowType

status

String status

systemEnabled

Boolean systemEnabled

webUrl

String webUrl

Class com.bytedesk.ai.provider.LlmProviderResponse

class LlmProviderResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

baseUrl

String baseUrl

cozeBotId

String cozeBotId

description

String description

enabled

Boolean enabled

logo

String logo

nickname

String nickname

ragflowId

String ragflowId

ragflowType

String ragflowType

status

String status

systemEnabled

Boolean systemEnabled

type

String type

webUrl

String webUrl

Package com.bytedesk.ai.provider.event

Class com.bytedesk.ai.provider.event.LlmProviderCreateEvent

class LlmProviderCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

llmProvider

LlmProviderEntity llmProvider

Class com.bytedesk.ai.provider.event.LlmProviderUpdateEvent

class LlmProviderUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

lmProvider

LlmProviderEntity lmProvider

Package com.bytedesk.ai.robot

Class com.bytedesk.ai.robot.RobotEntity

class RobotEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

Avatar image URL for the robot

categoryUid

String categoryUid

Associated category UID for robot classification

description

String description

Description of the robot's capabilities

kbEnabled

Boolean kbEnabled

是否启用知识库问答

kbSourceEnabled

Boolean kbSourceEnabled

kbUid

String kbUid

关联的知识库UID

llm

RobotLlm llm

LLM configuration settings for the robot

name

String name

Internal name of the robot

nickname

String nickname

Display name shown to customers

settings

RobotSettingsEntity settings

Configuration settings reference All settings are managed through the settings entity

system

Boolean system

Whether this is a system-provided robot

type

String type

Type of robot service (SERVICE, ASK, CHAT)

Class com.bytedesk.ai.robot.RobotProtobuf

class RobotProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

extra

String extra

kbEnabled

Boolean kbEnabled

kbSourceEnabled

Boolean kbSourceEnabled

kbUid

String kbUid

llm

RobotLlm llm

nickname

String nickname

orgUid

String orgUid

type

String type

uid

String uid

Class com.bytedesk.ai.robot.RobotProtobufBasic

class RobotProtobufBasic extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

机器人头像，用于显示

nickname

String nickname

机器人昵称，用于显示

orgUid

String orgUid

组织UID

type

String type

类型：ROBOT

uid

String uid

机器人唯一标识，用于后续从数据库获取完整配置

Class com.bytedesk.ai.robot.RobotRequest

class RobotRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

categoryUid

String categoryUid

description

String description

kbEnabled

Boolean kbEnabled

Whether knowledge base is enabled

kbSourceEnabled

Boolean kbSourceEnabled

Whether KB source is enabled

kbUid

String kbUid

Associated knowledge base UID

llm

RobotLlm llm

Embedded LLM configuration for the robot

messageUid

String messageUid

name

String name

nickname

String nickname

prompt

String prompt

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

settingsUid

String settingsUid

Robot settings reference UID If not provided, will use the default settings

system

Boolean system

threadUid

String threadUid

user

String user

Class com.bytedesk.ai.robot.RobotResponse

class RobotResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

categoryUid

String categoryUid

description

String description

kbEnabled

Boolean kbEnabled

Whether knowledge base is enabled

kbSourceEnabled

Boolean kbSourceEnabled

Whether KB source is enabled

kbUid

String kbUid

Associated knowledge base UID

llm

RobotLlm llm

Embedded LLM configuration for the robot

name

String name

nickname

String nickname

settings

RobotSettingsResponse settings

Robot settings (loaded from settings entity)

system

Boolean system

type

String type

Package com.bytedesk.ai.robot_message

Class com.bytedesk.ai.robot_message.RobotMessageEntity

class RobotMessageEntity extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accuracy

Double accuracy

aiModel

String aiModel

aiProvider

String aiProvider

answer

String answer

completionTokens

Integer completionTokens

isUnAnswered

Boolean isUnAnswered

prompt

String prompt

promptTokens

Integer promptTokens

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

rateType

String rateType

recall

Double recall

robot

String robot

threadUid

String threadUid

topic

String topic

totalTokens

Integer totalTokens

Class com.bytedesk.ai.robot_message.RobotMessageRequest

class RobotMessageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModel

String aiModel

aiProvider

String aiProvider

answer

String answer

completionTokens

Integer completionTokens

isUnAnswered

Boolean isUnAnswered

prompt

String prompt

promptTokens

Integer promptTokens

robot

String robot

robotNickname

String robotNickname

status

String status

threadUid

String threadUid

topic

String topic

totalTokens

Integer totalTokens

user

String user

userNickname

String userNickname

Class com.bytedesk.ai.robot_message.RobotMessageResponse

class RobotMessageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModel

String aiModel

aiProvider

String aiProvider

answer

String answer

channel

ChannelEnum channel

completionTokens

Integer completionTokens

content

String content

extra

MessageExtra extra

isUnAnswered

Boolean isUnAnswered

prompt

String prompt

promptTokens

Integer promptTokens

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

rateType

String rateType

robot

UserProtobuf robot

status

MessageStatusEnum status

threadUid

String threadUid

topic

String topic

totalTokens

Integer totalTokens

type

MessageTypeEnum type

user

UserProtobuf user

Package com.bytedesk.ai.robot_message.event

Class com.bytedesk.ai.robot_message.event.RobotMessageUnanswered

class RobotMessageUnanswered extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

robotMessage

RobotMessageEntity robotMessage

Package com.bytedesk.ai.robot_settings

Class com.bytedesk.ai.robot_settings.RobotSettingsEntity

class RobotSettingsEntity extends BaseSettingsEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

draftRateDownSettings

RatedownSettingsEntity draftRateDownSettings

Draft Rating down settings

draftToolsSettings

RobotToolsSettingsEntity draftToolsSettings

Spring AI tools orchestration draft

rateDownSettings

RatedownSettingsEntity rateDownSettings

Rating down settings

toolsSettings

RobotToolsSettingsEntity toolsSettings

Spring AI tools orchestration (published)

Class com.bytedesk.ai.robot_settings.RobotSettingsRequest

class RobotSettingsRequest extends BaseSettingsRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

rateDownSettings

RatedownSettingsRequest rateDownSettings

Rating down settings (Robot-specific)

toolsSettings

RobotToolsSettingsRequest toolsSettings

Spring AI tools settings (Robot-specific)

Class com.bytedesk.ai.robot_settings.RobotSettingsResponse

class RobotSettingsResponse extends BaseSettingsResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

draftRateDownSettings

RatedownSettingsResponse draftRateDownSettings

Draft rating down settings (Robot-specific)

draftToolsSettings

RobotToolsSettingsResponse draftToolsSettings

Spring AI tools settings draft

rateDownSettings

RatedownSettingsResponse rateDownSettings

Rating down settings (Robot-specific)

toolsSettings

RobotToolsSettingsResponse toolsSettings

Spring AI tools settings (published)

Package com.bytedesk.ai.robot_settings.event

Class com.bytedesk.ai.robot_settings.event.RobotSettingsCreateEvent

class RobotSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

robotSettings

RobotSettingsEntity robotSettings

Class com.bytedesk.ai.robot_settings.event.RobotSettingsUpdateEvent

class RobotSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

robotSettings

RobotSettingsEntity robotSettings

Package com.bytedesk.ai.robot_settings.tools

Class com.bytedesk.ai.robot_settings.tools.RobotToolConfig

class RobotToolConfig extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

beanName

String beanName

Spring bean name when bindingType == SPRING_BEAN / FUNCTION_BEAN

bindingType

String bindingType

Binding type: CLASS, SPRING_BEAN, FUNCTION_BEAN, HTTP_ENDPOINT, CUSTOM

category

String category

Visual category (utility / workflow / knowledge etc.)

className

String className

Fully-qualified class name when bindingType == CLASS

description

String description

Short description of what the tool does.

enabled

Boolean enabled

Whether this tool is enabled for the current robot template.

endpoint

String endpoint

External endpoint when bindingType == HTTP_ENDPOINT

icon

String icon

Optional emoji/icon string for quick visual cues in the UI.

inputSchema

String inputSchema

JSON schema snippet describing the tool input payload.

key

String key

Unique identifier for locating and deduplicating a tool (e.g. spring.datetime)

metadata

Map<String,Object> metadata

Free-form metadata reserved for provider specific hints.

methodName

String methodName

Optional method name for CLASS binding. When omitted all @Tool methods are exposed.

name

String name

Display name shown to admins when configuring the tool.

orderIndex

Integer orderIndex

Maximum priority/order used when presenting tools to the LLM.

outputSchema

String outputSchema

JSON schema or textual hint describing the response payload.

requiresApproval

Boolean requiresApproval

Whether the tool requires manual approval before execution.

systemPrompt

String systemPrompt

Custom instructions injected before executing the tool.

Class com.bytedesk.ai.robot_settings.tools.RobotToolsSettingsEntity

class RobotToolsSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultToolPrompt

String defaultToolPrompt

enabled

Boolean enabled

invocationMode

String invocationMode

maxToolInvocations

Integer maxToolInvocations

toolChoice

String toolChoice

toolConfigs

List<RobotToolConfig> toolConfigs

Class com.bytedesk.ai.robot_settings.tools.RobotToolsSettingsRequest

class RobotToolsSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultToolPrompt

String defaultToolPrompt

enabled

Boolean enabled

invocationMode

String invocationMode

maxToolInvocations

Integer maxToolInvocations

toolChoice

String toolChoice

toolConfigs

List<RobotToolConfig> toolConfigs

Class com.bytedesk.ai.robot_settings.tools.RobotToolsSettingsResponse

class RobotToolsSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultToolPrompt

String defaultToolPrompt

enabled

Boolean enabled

invocationMode

String invocationMode

maxToolInvocations

Integer maxToolInvocations

toolChoice

String toolChoice

toolConfigs

List<RobotToolConfig> toolConfigs

Package com.bytedesk.ai.robot_thread

Class com.bytedesk.ai.robot_thread.RobotThreadEntity

class RobotThreadEntity extends AbstractThreadEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Class com.bytedesk.ai.robot_thread.RobotThreadRequest

class RobotThreadRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Class com.bytedesk.ai.robot_thread.RobotThreadResponse

class RobotThreadResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Package com.bytedesk.ai.robot.event

Class com.bytedesk.ai.robot.event.RobotCreateEvent

class RobotCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

robot

RobotEntity robot

Package com.bytedesk.ai.robot.settings

Class com.bytedesk.ai.robot.settings.RobotRoutingSettingsEntity

class RobotRoutingSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultRobot

Boolean defaultRobot

nonWorktimeRobot

Boolean nonWorktimeRobot

offlineRobot

Boolean offlineRobot

robot

RobotEntity robot

Class com.bytedesk.ai.robot.settings.RobotRoutingSettingsRequest

class RobotRoutingSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultRobot

Boolean defaultRobot

nonWorktimeRobot

Boolean nonWorktimeRobot

非工作时间段，是否启用机器人接待

offlineRobot

Boolean offlineRobot

无客服在线时，是否启用机器人接待

queueRobot

Boolean queueRobot

queueRobotCount

Integer queueRobotCount

robotUid

String robotUid

Class com.bytedesk.ai.robot.settings.RobotRoutingSettingsResponse

class RobotRoutingSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultRobot

Boolean defaultRobot

nonWorktimeRobot

Boolean nonWorktimeRobot

非工作时间段，是否启用机器人接待

offlineRobot

Boolean offlineRobot

无客服在线时，是否启用机器人接待

robot

RobotProtobuf robot

Package com.bytedesk.ai.segment

Exception com.bytedesk.ai.segment.SegmentException

class SegmentException extends RuntimeException implements Serializable

Package com.bytedesk.ai.springai.event

Class com.bytedesk.ai.springai.event.LlmTokenUsageEvent

class LlmTokenUsageEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModelType

String aiModelType

AI模型类型 (gpt-4, gpt-3.5, claude, gemini, etc.)

aiProvider

String aiProvider

AI提供商 (openai, baidu, zhipuai, etc.)

completionTokens

long completionTokens

Completion token数量

orgUid

String orgUid

组织UID

promptTokens

long promptTokens

Prompt token数量

responseTime

long responseTime

响应时间（毫秒）

success

boolean success

请求是否成功

tokenUnitPrice

BigDecimal tokenUnitPrice

Token单价（USD）

Package com.bytedesk.ai.springai.providers.dify

Class com.bytedesk.ai.springai.providers.dify.DifyRequest

class DifyRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

apiUrl

String apiUrl

autoGenerateTitle

Boolean autoGenerateTitle

是否自动生成标题

conversationId

String conversationId

对话 ID，需要基于之前的对话继续对话时传入

description

String description

enabled

Boolean enabled

firstId

String firstId

分页查询时的第一条消息ID

inputs

Map<String,Object> inputs

输入变量，key-value对象，提供给 Prompt 模板使用

kbUid

String kbUid

lastId

String lastId

分页查询时的最后一个对话ID

limit

Integer limit

查询限制数量

name

String name

对话的新标题

pinned

Boolean pinned

是否只返回置顶对话

query

String query

用户输入内容

responseMode

String responseMode

响应模式： - streaming 流式响应（推荐） - blocking 阻塞式响应

user

String user

用户标识，用于定义终端用户的身份，必须与用户的真实 ID 保持一致

Class com.bytedesk.ai.springai.providers.dify.DifyResponse

class DifyResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

回答内容

apiKey

String apiKey

apiUrl

String apiUrl

conversationId

String conversationId

对话 ID

description

String description

difyCreatedAt

Integer difyCreatedAt

Dify API 创建时间戳（与 BaseResponse 的 createdAt 区分）

enabled

Boolean enabled

feedback

String feedback

反馈评分，如果返回 like，代表赞，如果返回 dislike，代表踩，如果返回 null，代表没有反馈

id

String id

消息唯一标识符

kbUid

String kbUid

metadata

Map<String,Object> metadata

元数据

name

String name

retrieval

List<DifyResponse.RetrievalItem> retrieval

引用和归属分段列表

type

String type

usage

DifyResponse.Usage usage

模型使用情况

Package com.bytedesk.ai.springai.providers.gitee

Class com.bytedesk.ai.springai.providers.gitee.GiteeRequest

class GiteeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

Gitee AI API Key

apiUrl

String apiUrl

Gitee AI API 基础URL

maxTokens

Integer maxTokens

最大tokens数量

message

String message

用户消息/提示

model

String model

模型名称

stream

Boolean stream

流式输出

temperature

Double temperature

温度参数 (0.0-2.0)

topP

Double topP

Top-p 参数 (0.0-1.0)

Package com.bytedesk.ai.springai.providers.maxkb

Class com.bytedesk.ai.springai.providers.maxkb.MaxkbRequest

class MaxkbRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

apiUrl

String apiUrl

description

String description

enabled

Boolean enabled

kbUid

String kbUid

name

String name

Class com.bytedesk.ai.springai.providers.maxkb.MaxkbResponse

class MaxkbResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

apiUrl

String apiUrl

description

String description

enabled

Boolean enabled

kbUid

String kbUid

name

String name

type

String type

Package com.bytedesk.ai.springai.providers.n8n

Class com.bytedesk.ai.springai.providers.n8n.N8nRequest

class N8nRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentId

String agentId

RAGFlow 代理ID

apiKey

String apiKey

apiUrl

String apiUrl

chatId

String chatId

RAGFlow 聊天ID

description

String description

enabled

Boolean enabled

kbUid

String kbUid

messageContent

String messageContent

消息内容（简单消息）

messages

List<Map<String,Object>> messages

消息列表

model

String model

模型名称

name

String name

role

String role

消息角色（user, assistant, system）

stream

Boolean stream

是否流式响应

Class com.bytedesk.ai.springai.providers.n8n.N8nResponse

class N8nResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

apiUrl

String apiUrl

description

String description

enabled

Boolean enabled

kbUid

String kbUid

name

String name

type

String type

Package com.bytedesk.ai.springai.providers.ollama

Class com.bytedesk.ai.springai.providers.ollama.OllamaRequest

class OllamaRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

baseUrl

String baseUrl

message

String message

model

String model

prompt

String prompt

tag

String tag

Class com.bytedesk.ai.springai.providers.ollama.OllamaResponse

class OllamaResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

baseUrl

String baseUrl

model

String model

Package com.bytedesk.ai.springai.providers.openrouter

Class com.bytedesk.ai.springai.providers.openrouter.OpenrouterRequest

class OpenrouterRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

OpenRouter API Key

apiUrl

String apiUrl

OpenRouter API 基础URL

httpReferer

String httpReferer

HTTP Referer (可选，用于识别应用)

maxTokens

Integer maxTokens

最大tokens数量

message

String message

用户消息/提示

model

String model

模型名称

stream

Boolean stream

流式输出

temperature

Double temperature

温度参数 (0.0-2.0)

topP

Double topP

Top-p 参数 (0.0-1.0)

xTitle

String xTitle

X-Title 头部 (可选，用于显示应用名称)

Package com.bytedesk.ai.springai.providers.ragflow

Class com.bytedesk.ai.springai.providers.ragflow.RagflowRequest

class RagflowRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentId

String agentId

RAGFlow 代理ID

apiKey

String apiKey

apiUrl

String apiUrl

chatId

String chatId

RAGFlow 聊天ID

description

String description

enabled

Boolean enabled

kbUid

String kbUid

messageContent

String messageContent

消息内容（简单消息）

messages

List<Map<String,Object>> messages

消息列表

model

String model

模型名称

name

String name

role

String role

消息角色（user, assistant, system）

stream

Boolean stream

是否流式响应

Class com.bytedesk.ai.springai.providers.ragflow.RagflowResponse

class RagflowResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

apiUrl

String apiUrl

description

String description

enabled

Boolean enabled

kbUid

String kbUid

name

String name

type

String type

Package com.bytedesk.ai.statistic_token

Class com.bytedesk.ai.statistic_token.StatisticTokenEntity

class StatisticTokenEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModelType

String aiModelType

AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

aiProvider

String aiProvider

AI provider (openai, baidu, zhipuai, etc.)

avgResponseTime

Long avgResponseTime

Average response time in milliseconds

completionTokens

Long completionTokens

Number of completion tokens consumed

date

String date

Date for daily statistics (YYYY-MM-DD format)

failedRequests

Long failedRequests

Number of failed requests

hour

Integer hour

Hour of the day for hourly statistics (0-23)

promptTokens

Long promptTokens

Number of prompt tokens consumed

status

String status

Statistics status (active/archived)

successRequests

Long successRequests

Number of successful requests

tokenUnitPrice

BigDecimal tokenUnitPrice

Cost per token in USD (using BigDecimal for precision)

totalCost

BigDecimal totalCost

Total cost in USD (using BigDecimal for precision)

totalRequests

Long totalRequests

Total number of requests made

totalTokens

Long totalTokens

Total number of tokens consumed

type

String type

Statistic token type

Class com.bytedesk.ai.statistic_token.StatisticTokenHourlyResponse

class StatisticTokenHourlyResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModelType

String aiModelType

AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

aiProvider

String aiProvider

AI provider (openai, baidu, zhipuai, etc.)

avgResponseTime

Long avgResponseTime

Average response time in milliseconds for this hour

completionTokens

Long completionTokens

Completion tokens consumed in this hour

date

String date

Date in YYYY-MM-DD format

failedRequests

Long failedRequests

Failed requests in this hour

hour

Integer hour

Hour of the day (0-23)

hourlyData

List<StatisticTokenHourlyResponse> hourlyData

List of hourly data points for the entire day (0-23 hours)

orgUid

String orgUid

Organization UID

promptTokens

Long promptTokens

Prompt tokens consumed in this hour

successRate

Double successRate

Success rate percentage for this hour

successRequests

Long successRequests

Successful requests in this hour

totalCost

BigDecimal totalCost

Total cost in USD for this hour

totalRequests

Long totalRequests

Total requests made in this hour

totalTokens

Long totalTokens

Total tokens consumed in this hour

Class com.bytedesk.ai.statistic_token.StatisticTokenRequest

class StatisticTokenRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModelType

String aiModelType

AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

aiProvider

String aiProvider

AI provider (openai, baidu, zhipuai, etc.)

avgResponseTime

Long avgResponseTime

Average response time in milliseconds

completionTokens

Long completionTokens

Number of completion tokens consumed

date

String date

Date for daily statistics (YYYY-MM-DD format)

failedRequests

Long failedRequests

Number of failed requests

hour

Integer hour

Hour of the day for hourly statistics (0-23)

promptTokens

Long promptTokens

Number of prompt tokens consumed

status

String status

Statistics status (active/archived)

successRequests

Long successRequests

Number of successful requests

tokenUnitPrice

BigDecimal tokenUnitPrice

Cost per token in USD

totalCost

BigDecimal totalCost

Total cost in USD

totalRequests

Long totalRequests

Total number of requests made

totalTokens

Long totalTokens

Total number of tokens consumed

Class com.bytedesk.ai.statistic_token.StatisticTokenResponse

class StatisticTokenResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

aiModelType

String aiModelType

AI model type (gpt-4, gpt-3.5, claude, gemini, etc.)

aiProvider

String aiProvider

AI provider (openai, baidu, zhipuai, etc.)

avgResponseTime

Long avgResponseTime

Average response time in milliseconds

completionTokens

Long completionTokens

Number of completion tokens consumed

date

String date

Date for daily statistics (YYYY-MM-DD format)

failedRequests

Long failedRequests

Number of failed requests

hour

Integer hour

Hour of the day for hourly statistics (0-23)

promptTokens

Long promptTokens

Number of prompt tokens consumed

status

String status

Statistics status (active/archived)

successRequests

Long successRequests

Number of successful requests

tokenUnitPrice

BigDecimal tokenUnitPrice

Cost per token in USD

totalCost

BigDecimal totalCost

Total cost in USD

totalRequests

Long totalRequests

Total number of requests made

totalTokens

Long totalTokens

Total number of tokens consumed

type

String type

Package com.bytedesk.ai.statistic_token.event

Class com.bytedesk.ai.statistic_token.event.StatisticTokenCreateEvent

class StatisticTokenCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic_token

StatisticTokenEntity statistic_token

Class com.bytedesk.ai.statistic_token.event.StatisticTokenDeleteEvent

class StatisticTokenDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic_token

StatisticTokenEntity statistic_token

Class com.bytedesk.ai.statistic_token.event.StatisticTokenUpdateEvent

class StatisticTokenUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic_token

StatisticTokenEntity statistic_token

Package com.bytedesk.call.call_statistic

Class com.bytedesk.call.call_statistic.CallStatisticEntity

class CallStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the statistic display

description

String description

Description of the statistic

name

String name

Name of the statistic

order

Integer order

Display order of the statistic

type

String type

Type of statistic (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.call.call_statistic.CallStatisticRequest

class CallStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.call.call_statistic.CallStatisticResponse

class CallStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.call.call_statistic.event

Class com.bytedesk.call.call_statistic.event.CallStatisticCreateEvent

class CallStatisticCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

CallStatisticEntity statistic

Class com.bytedesk.call.call_statistic.event.CallStatisticDeleteEvent

class CallStatisticDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

CallStatisticEntity statistic

Class com.bytedesk.call.call_statistic.event.CallStatisticUpdateEvent

class CallStatisticUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

CallStatisticEntity statistic

Package com.bytedesk.call.esl.client.dptools

Exception com.bytedesk.call.esl.client.dptools.ExecuteException

class ExecuteException extends Exception implements Serializable

serialVersionUID:

1L

Package com.bytedesk.call.esl.client.inbound

Exception com.bytedesk.call.esl.client.inbound.InboundConnectionFailure

class InboundConnectionFailure extends Exception implements Serializable

serialVersionUID:

1L

Package com.bytedesk.call.janus_audio

Class com.bytedesk.call.janus_audio.JanusAudioEntity

class JanusAudioEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the janus_audio

name

String name

Name of the janus_audio

thread

ThreadEntity thread

type

String type

Type of janus_audio (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.call.janus_audio.JanusAudioRequest

class JanusAudioRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.call.janus_audio.JanusAudioResponse

class JanusAudioResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.call.janus_audio.event

Class com.bytedesk.call.janus_audio.event.JanusAudioCreateEvent

class JanusAudioCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_audio

JanusAudioEntity janus_audio

Class com.bytedesk.call.janus_audio.event.JanusAudioDeleteEvent

class JanusAudioDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_audio

JanusAudioEntity janus_audio

Class com.bytedesk.call.janus_audio.event.JanusAudioUpdateEvent

class JanusAudioUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_audio

JanusAudioEntity janus_audio

Package com.bytedesk.call.janus_video

Class com.bytedesk.call.janus_video.JanusVideoEntity

class JanusVideoEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the janus_video

name

String name

Name of the janus_video

thread

ThreadEntity thread

type

String type

Type of janus_video (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.call.janus_video.JanusVideoRequest

class JanusVideoRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.call.janus_video.JanusVideoResponse

class JanusVideoResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.call.janus_video.event

Class com.bytedesk.call.janus_video.event.JanusVideoCreateEvent

class JanusVideoCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_video

JanusVideoEntity janus_video

Class com.bytedesk.call.janus_video.event.JanusVideoDeleteEvent

class JanusVideoDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_video

JanusVideoEntity janus_video

Class com.bytedesk.call.janus_video.event.JanusVideoUpdateEvent

class JanusVideoUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

janus_video

JanusVideoEntity janus_video

Package com.bytedesk.call.mrcp

Class com.bytedesk.call.mrcp.CallMrcpEntity

class CallMrcpEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the mrcp

name

String name

Name of the mrcp

type

String type

Type of mrcp (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.call.mrcp.CallMrcpRequest

class CallMrcpRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.call.mrcp.CallMrcpResponse

class CallMrcpResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.call.mrcp.event

Class com.bytedesk.call.mrcp.event.CallMrcpCreateEvent

class CallMrcpCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

CallMrcpEntity tag

Class com.bytedesk.call.mrcp.event.CallMrcpDeleteEvent

class CallMrcpDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

CallMrcpEntity tag

Class com.bytedesk.call.mrcp.event.CallMrcpUpdateEvent

class CallMrcpUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

CallMrcpEntity tag

Package com.bytedesk.call.mrcp4j.client

Exception com.bytedesk.call.mrcp4j.client.MrcpInvocationException

class MrcpInvocationException extends MrcpException implements Serializable

Serialized Fields

_response

MrcpResponse _response

Package com.bytedesk.call.mrcp4j.common

Exception com.bytedesk.call.mrcp4j.common.MrcpException

class MrcpException extends Exception implements Serializable

Package com.bytedesk.call.mrcp4j.message.header

Exception com.bytedesk.call.mrcp4j.message.header.IllegalValueException

class IllegalValueException extends MrcpException implements Serializable

Package com.bytedesk.call.xml_curl.xml.acl

Class com.bytedesk.call.xml_curl.xml.acl.AclConfiguration

class AclConfiguration extends Configuration implements Serializable

Serialized Fields

networkLists

AclNetworkLists networkLists

Class com.bytedesk.call.xml_curl.xml.acl.AclList

class AclList extends Object implements Serializable

Serialized Fields

aclDefault

String aclDefault

name

String name

node

List<AclNode> node

Class com.bytedesk.call.xml_curl.xml.acl.AclNode

class AclNode extends Object implements Serializable

Serialized Fields

cidr

String cidr

domain

String domain

type

String type

Package com.bytedesk.call.xml_curl.xml.dialplan

Class com.bytedesk.call.xml_curl.xml.dialplan.Action

class Action extends Object implements Serializable

Serialized Fields

application

AppEnum application

data

String data

Class com.bytedesk.call.xml_curl.xml.dialplan.Condition

class Condition extends Object implements Serializable

Serialized Fields

action

List<Action> action

expression

String expression

匹配被叫分机号正则表达式

field

String field

requireNested

String requireNested

Class com.bytedesk.call.xml_curl.xml.dialplan.Context

class Context extends Object implements Serializable

Serialized Fields

extension

List<Extension> extension

name

String name

Class com.bytedesk.call.xml_curl.xml.dialplan.Extension

class Extension extends Object implements Serializable

Serialized Fields

condition

List<Condition> condition

name

String name

Package com.bytedesk.call.xml_curl.xml.group

Class com.bytedesk.call.xml_curl.xml.group.Group

class Group extends Object implements Serializable

Serialized Fields

users

Users users

Class com.bytedesk.call.xml_curl.xml.group.Groups

class Groups extends Object implements Serializable

Serialized Fields

group

List<Group> group

Package com.bytedesk.call.xml_curl.xml.odbccdr

Class com.bytedesk.call.xml_curl.xml.odbccdr.OdbcCdrConfiguration

class OdbcCdrConfiguration extends Configuration implements Serializable

Serialized Fields

settings

Settings settings

tables

OdbcCdrTables tables

Package com.bytedesk.call.xml_curl.xml.param

Class com.bytedesk.call.xml_curl.xml.param.Params

class Params extends Object implements Serializable

Serialized Fields

param

List<Param> param

Package com.bytedesk.call.xml_curl.xml.sofia

Class com.bytedesk.call.xml_curl.xml.sofia.GlobalSettings

class GlobalSettings extends Object implements Serializable

Serialized Fields

param

List<Param> param

log-level auto-restart debug-presence capture-server

Class com.bytedesk.call.xml_curl.xml.sofia.Param

class Param extends Object implements Serializable

Serialized Fields

name

String name

value

String value

Class com.bytedesk.call.xml_curl.xml.sofia.Sofia

class Sofia extends Configuration implements Serializable

Serialized Fields

globalSettings

GlobalSettings globalSettings

profiles

Profiles profiles

Package com.bytedesk.call.xml_curl.xml.sofia.aliase

Class com.bytedesk.call.xml_curl.xml.sofia.aliase.Alias

class Alias extends Object implements Serializable

Serialized Fields

name

String name

Class com.bytedesk.call.xml_curl.xml.sofia.aliase.Aliases

class Aliases extends Object implements Serializable

Serialized Fields

alias

List<Alias> alias

Package com.bytedesk.call.xml_curl.xml.sofia.domain

Class com.bytedesk.call.xml_curl.xml.sofia.domain.DirectoryDomain

class DirectoryDomain extends Object implements Serializable

Serialized Fields

groups

Groups groups

name

String name

params

Params params

variables

Variables variables

Class com.bytedesk.call.xml_curl.xml.sofia.domain.Domain

class Domain extends Object implements Serializable

Serialized Fields

alias

String alias

name

String name

parse

String parse

Class com.bytedesk.call.xml_curl.xml.sofia.domain.Domains

class Domains extends Object implements Serializable

Serialized Fields

domain

List<Domain> domain

Package com.bytedesk.call.xml_curl.xml.sofia.gateway

Class com.bytedesk.call.xml_curl.xml.sofia.gateway.Gateway

class Gateway extends Object implements Serializable

Serialized Fields

name

String name

param

List<Param> param

Class com.bytedesk.call.xml_curl.xml.sofia.gateway.Gateways

class Gateways extends Object implements Serializable

Serialized Fields

gateway

List<Gateway> gateway

Package com.bytedesk.call.xml_curl.xml.sofia.profile

Class com.bytedesk.call.xml_curl.xml.sofia.profile.Profile

class Profile extends Object implements Serializable

Serialized Fields

aliases

Aliases aliases

domains

Domains domains

gateways

Gateways gateways

name

String name

settings

Settings settings

Class com.bytedesk.call.xml_curl.xml.sofia.profile.Profiles

class Profiles extends Object implements Serializable

Serialized Fields

profile

List<Profile> profile

Package com.bytedesk.call.xml_curl.xml.sofia.setting

Class com.bytedesk.call.xml_curl.xml.sofia.setting.Settings

class Settings extends Object implements Serializable

Serialized Fields

param

List<Param> param

Package com.bytedesk.call.xml_curl.xml.user

Class com.bytedesk.call.xml_curl.xml.user.User

class User extends Object implements Serializable

Serialized Fields

gateways

Gateways gateways

id

String id

params

Params params

type

String type

variables

Variables variables

Class com.bytedesk.call.xml_curl.xml.user.Users

class Users extends Object implements Serializable

Serialized Fields

user

List<User> user

Package com.bytedesk.call.xml_curl.xml.variables

Class com.bytedesk.call.xml_curl.xml.variables.Variable

class Variable extends Object implements Serializable

Serialized Fields

name

String name

value

String value

Class com.bytedesk.call.xml_curl.xml.variables.Variables

class Variables extends Object implements Serializable

Serialized Fields

variable

List<Variable> variable

Package com.bytedesk.call.xml_curl.xml.xmlcdr

Class com.bytedesk.call.xml_curl.xml.xmlcdr.XmlCdrConfiguration

class XmlCdrConfiguration extends Configuration implements Serializable

Serialized Fields

settings

Settings settings

Package com.bytedesk.control.license

Class com.bytedesk.control.license.LicenseEntity

class LicenseEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

activatedAt

ZonedDateTime activatedAt

description

String description

edition

String edition

email

String email

enabled

Boolean enabled

encryptedLicenseKey

String encryptedLicenseKey

expiryDate

ZonedDateTime expiryDate

lastCheckedAt

ZonedDateTime lastCheckedAt

licenseKey

String licenseKey

mobile

String mobile

name

String name

serverDomains

String serverDomains

serverIps

String serverIps

userType

String userType

Class com.bytedesk.control.license.LicenseRequest

class LicenseRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

activatedAt

ZonedDateTime activatedAt

description

String description

edition

String edition

email

String email

enabled

Boolean enabled

encryptedLicenseKey

String encryptedLicenseKey

expiryDate

ZonedDateTime expiryDate

lastCheckedAt

ZonedDateTime lastCheckedAt

licenseKey

String licenseKey

mobile

String mobile

name

String name

serverDomains

String serverDomains

serverIps

String serverIps

userType

String userType

Class com.bytedesk.control.license.LicenseResponse

class LicenseResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

activatedAt

ZonedDateTime activatedAt

description

String description

edition

String edition

email

String email

enabled

Boolean enabled

encryptedLicenseKey

String encryptedLicenseKey

expiryDate

ZonedDateTime expiryDate

lastCheckedAt

ZonedDateTime lastCheckedAt

licenseKey

String licenseKey

mobile

String mobile

name

String name

serverDomains

String serverDomains

serverIps

String serverIps

userType

String userType

Package com.bytedesk.control.license.event

Class com.bytedesk.control.license.event.AbstractLicenseEvent

class AbstractLicenseEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

license

LicenseEntity license

Class com.bytedesk.control.license.event.LicenseCreateEvent

class LicenseCreateEvent extends AbstractLicenseEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.control.license.event.LicenseUpdateEvent

class LicenseUpdateEvent extends AbstractLicenseEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.control.trace

Class com.bytedesk.control.trace.TraceEntity

class TraceEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the trace

name

String name

Name of the trace

type

String type

Type of trace (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.control.trace.TraceRequest

class TraceRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.control.trace.TraceResponse

class TraceResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.control.trace.event

Class com.bytedesk.control.trace.event.TraceCreateEvent

class TraceCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

trace

TraceEntity trace

Class com.bytedesk.control.trace.event.TraceDeleteEvent

class TraceDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

trace

TraceEntity trace

Class com.bytedesk.control.trace.event.TraceUpdateEvent

class TraceUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

trace

TraceEntity trace

Package com.bytedesk.core.action

Class com.bytedesk.core.action.ActionEntity

class ActionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

action

String action

The specific action or operation performed

description

String description

Detailed description of the action

extra

String extra

Additional data or context information about the action in JSON format

ip

String ip

IP address of the user who performed the action

ipLocation

String ipLocation

Geographic location derived from the IP address

title

String title

Title or name of the action performed

type

String type

Type of action (LOG, LOGIN, LOGOUT, CREATE, UPDATE, DELETE, etc.)

user

UserEntity user

User who performed the action

Class com.bytedesk.core.action.ActionRequest

class ActionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

action

String action

description

String description

extra

String extra

ip

String ip

ipLocation

String ipLocation

nickname

String nickname

title

String title

Class com.bytedesk.core.action.ActionResponse

class ActionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

action

String action

description

String description

extra

String extra

ip

String ip

ipLocation

String ipLocation

title

String title

type

String type

user

UserProtobuf user

Package com.bytedesk.core.action.event

Class com.bytedesk.core.action.event.AbstractActionEvent

class AbstractActionEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

action

ActionEntity action

Class com.bytedesk.core.action.event.ActionCreateEvent

class ActionCreateEvent extends AbstractActionEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.announcement

Class com.bytedesk.core.announcement.AnnouncementEntity

class AnnouncementEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the announcement

name

String name

Name of the announcement

type

String type

Type of announcement (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.announcement.AnnouncementRequest

class AnnouncementRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.announcement.AnnouncementResponse

class AnnouncementResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.announcement.event

Class com.bytedesk.core.announcement.event.AbstractAnnouncementEvent

class AbstractAnnouncementEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

announcement

AnnouncementEntity announcement

Class com.bytedesk.core.announcement.event.AnnouncementCreateEvent

class AnnouncementCreateEvent extends AbstractAnnouncementEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.announcement.event.AnnouncementDeleteEvent

class AnnouncementDeleteEvent extends AbstractAnnouncementEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.announcement.event.AnnouncementUpdateEvent

class AnnouncementUpdateEvent extends AbstractAnnouncementEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.asset

Class com.bytedesk.core.asset.AssetEntity

class AssetEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the asset

name

String name

Name of the asset

type

String type

Type of asset (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.asset.AssetRequest

class AssetRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.asset.AssetResponse

class AssetResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.asset.event

Class com.bytedesk.core.asset.event.AbstractAssetEvent

class AbstractAssetEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

asset

AssetEntity asset

Class com.bytedesk.core.asset.event.AssetCreateEvent

class AssetCreateEvent extends AbstractAssetEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.asset.event.AssetDeleteEvent

class AssetDeleteEvent extends AbstractAssetEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.asset.event.AssetUpdateEvent

class AssetUpdateEvent extends AbstractAssetEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.assistant

Class com.bytedesk.core.assistant.AssistantEntity

class AssistantEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

Class com.bytedesk.core.assistant.AssistantRequest

class AssistantRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

Class com.bytedesk.core.assistant.AssistantResponse

class AssistantResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

Package com.bytedesk.core.balance

Class com.bytedesk.core.balance.BalanceEntity

class BalanceEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

name

String name

state

String state

Class com.bytedesk.core.balance.BalanceRequest

class BalanceRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

state

String state

Class com.bytedesk.core.balance.BalanceResponse

class BalanceResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

state

String state

Package com.bytedesk.core.base

Class com.bytedesk.core.base.BaseContent

class BaseContent extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.base.BaseEntity

class BaseEntity extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdAt

ZonedDateTime createdAt

deleted

boolean deleted

id

Long id

level

String level

orgUid

String orgUid

platform

String platform

uid

@NotBlank(message="uid is required") String uid

updatedAt

ZonedDateTime updatedAt

userUid

String userUid

version

int version

Class com.bytedesk.core.base.BaseEntityNoOrg

class BaseEntityNoOrg extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdAt

ZonedDateTime createdAt

deleted

boolean deleted

id

Long id

level

String level

platform

String platform

uid

@NotBlank(message="uid is required") String uid

updatedAt

ZonedDateTime updatedAt

userUid

String userUid

version

int version

Class com.bytedesk.core.base.BaseExcel

class BaseExcel extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

uid

String uid

Class com.bytedesk.core.base.BaseExtra

class BaseExtra extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.base.BaseRequest

class BaseRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

来源

content

String content

内容

exportAll

Boolean exportAll

level

String level

orgUid

String orgUid

组织唯一标识

pageNumber

int pageNumber

页码，从0开始

pageSize

int pageSize

每页大小，默认10

platform

String platform

searchText

String searchText

sortBy

String sortBy

sortDirection

String sortDirection

superUser

Boolean superUser

type

String type

类型

uid

String uid

唯一标识

userUid

String userUid

用户唯一标识

Class com.bytedesk.core.base.BaseRequestNoOrg

class BaseRequestNoOrg extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

来源

content

String content

内容

exportAll

Boolean exportAll

level

String level

pageNumber

int pageNumber

页码，从0开始

pageSize

int pageSize

每页大小，默认10

platform

String platform

searchText

String searchText

sortBy

String sortBy

sortDirection

String sortDirection

superUser

Boolean superUser

type

String type

类型

uid

String uid

唯一标识

userUid

String userUid

用户唯一标识

Class com.bytedesk.core.base.BaseResponse

class BaseResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdAt

ZonedDateTime createdAt

level

String level

orgUid

String orgUid

platform

String platform

uid

String uid

updatedAt

ZonedDateTime updatedAt

userUid

String userUid

Class com.bytedesk.core.base.BaseResponseNoOrg

class BaseResponseNoOrg extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

createdAt

ZonedDateTime createdAt

level

String level

platform

String platform

uid

String uid

updatedAt

ZonedDateTime updatedAt

userUid

String userUid

Package com.bytedesk.core.black

Class com.bytedesk.core.black.BlackEntity

class BlackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

blackAvatar

String blackAvatar

blackNickname

String blackNickname

blackUid

String blackUid

blockIp

Boolean blockIp

endTime

ZonedDateTime endTime

name

String name

reason

String reason

startTime

ZonedDateTime startTime

threadTopic

String threadTopic

threadUid

String threadUid

type

String type

userAvatar

String userAvatar

userNickname

String userNickname

Class com.bytedesk.core.black.BlackExcel

class BlackExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

blackNickname

String blackNickname

blockIp

String blockIp

createdAt

ZonedDateTime createdAt

endTime

ZonedDateTime endTime

name

String name

reason

String reason

startTime

ZonedDateTime startTime

userNickname

String userNickname

Class com.bytedesk.core.black.BlackRequest

class BlackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

blackAvatar

String blackAvatar

blackNickname

String blackNickname

blackUid

String blackUid

blockIp

Boolean blockIp

endTime

ZonedDateTime endTime

reason

String reason

startTime

ZonedDateTime startTime

threadTopic

String threadTopic

threadUid

String threadUid

userAvatar

String userAvatar

userNickname

String userNickname

Class com.bytedesk.core.black.BlackResponse

class BlackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

blackAvatar

String blackAvatar

blackNickname

String blackNickname

blackUid

String blackUid

blockIp

Boolean blockIp

endTime

ZonedDateTime endTime

name

String name

reason

String reason

startTime

ZonedDateTime startTime

threadTopic

String threadTopic

threadUid

String threadUid

userAvatar

String userAvatar

userNickname

String userNickname

Package com.bytedesk.core.black.event

Class com.bytedesk.core.black.event.AbstractBlackEvent

class AbstractBlackEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

black

BlackEntity black

Class com.bytedesk.core.black.event.BlackCreateEvent

class BlackCreateEvent extends AbstractBlackEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.black.event.BlackDeleteEvent

class BlackDeleteEvent extends AbstractBlackEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.black.event.BlackUpdateEvent

class BlackUpdateEvent extends AbstractBlackEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.calendar

Class com.bytedesk.core.calendar.CalendarEntity

class CalendarEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

allDay

Boolean allDay

All-day schedule flag

color

String color

Color theme for the calendar display

description

String description

Description of the calendar

endAt

ZonedDateTime endAt

Schedule end time (optional)

location

String location

Location (meeting room, address, etc.)

name

String name

Name of the calendar

order

Integer order

Display order

remindAt

ZonedDateTime remindAt

Reminder time (optional)

startAt

ZonedDateTime startAt

Schedule start time (optional)

status

String status

Status (SCHEDULED, DONE, CANCELED, etc.)

type

String type

Type of calendar (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.calendar.CalendarRequest

class CalendarRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

allDay

Boolean allDay

color

String color

description

String description

endAt

ZonedDateTime endAt

location

String location

name

String name

order

Integer order

remindAt

ZonedDateTime remindAt

startAt

ZonedDateTime startAt

status

String status

Class com.bytedesk.core.calendar.CalendarResponse

class CalendarResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

allDay

Boolean allDay

color

String color

description

String description

endAt

ZonedDateTime endAt

location

String location

name

String name

order

Integer order

remindAt

ZonedDateTime remindAt

startAt

ZonedDateTime startAt

status

String status

type

String type

Package com.bytedesk.core.calendar.event

Class com.bytedesk.core.calendar.event.AbstractCalendarEvent

class AbstractCalendarEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

calendar

CalendarEntity calendar

Class com.bytedesk.core.calendar.event.CalendarCreateEvent

class CalendarCreateEvent extends AbstractCalendarEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.calendar.event.CalendarDeleteEvent

class CalendarDeleteEvent extends AbstractCalendarEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.calendar.event.CalendarUpdateEvent

class CalendarUpdateEvent extends AbstractCalendarEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.category

Class com.bytedesk.core.category.CategoryEntity

class CategoryEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

children

List<CategoryEntity> children

kbUid

String kbUid

name

String name

order

Integer order

parent

CategoryEntity parent

type

String type

Class com.bytedesk.core.category.CategoryRequest

class CategoryRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

kbUid

String kbUid

name

String name

order

Integer order

parentUid

String parentUid

Class com.bytedesk.core.category.CategoryResponse

class CategoryResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

children

List<CategoryResponse> children

kbUid

String kbUid

memberCount

Integer memberCount

name

String name

order

Integer order

parentUid

String parentUid

type

String type

userUid

String userUid

Package com.bytedesk.core.category.event

Class com.bytedesk.core.category.event.AbstractCategoryEvent

class AbstractCategoryEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

category

CategoryEntity category

Class com.bytedesk.core.category.event.CategoryCreateEvent

class CategoryCreateEvent extends AbstractCategoryEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.category.event.CategoryUpdateEvent

class CategoryUpdateEvent extends AbstractCategoryEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.clipboard

Class com.bytedesk.core.clipboard.ClipboardEntity

class ClipboardEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

name

String name

type

String type

Class com.bytedesk.core.clipboard.ClipboardRequest

class ClipboardRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.clipboard.ClipboardResponse

class ClipboardResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

type

MessageTypeEnum type

Package com.bytedesk.core.config.properties

Class com.bytedesk.core.config.properties.BytedeskPropertiesResponse

class BytedeskPropertiesResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

custom

BytedeskPropertiesResponse.Custom custom

debug

Boolean debug

features

BytedeskPropertiesResponse.Features features

licenseKey

String licenseKey

testing

BytedeskPropertiesResponse.Testing testing

version

String version

Package com.bytedesk.core.contract

Class com.bytedesk.core.contract.ContractEntity

class ContractEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the contract

name

String name

Name of the contract

type

String type

Type of contract (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.contract.ContractRequest

class ContractRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.contract.ContractResponse

class ContractResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.contract.event

Class com.bytedesk.core.contract.event.AbstractContractEvent

class AbstractContractEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

contract

ContractEntity contract

Class com.bytedesk.core.contract.event.ContractCreateEvent

class ContractCreateEvent extends AbstractContractEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.contract.event.ContractDeleteEvent

class ContractDeleteEvent extends AbstractContractEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.contract.event.ContractUpdateEvent

class ContractUpdateEvent extends AbstractContractEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.department

Class com.bytedesk.core.department.DepartmentEntity

class DepartmentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

children

Set<DepartmentEntity> children

Child departments under this department

description

String description

Description of the department's function

name

String name

Name of the department

parent

DepartmentEntity parent

Parent department in the hierarchy

Class com.bytedesk.core.department.DepartmentRequest

class DepartmentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

parentUid

String parentUid

Class com.bytedesk.core.department.DepartmentResponse

class DepartmentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

children

Set<DepartmentResponse> children

description

String description

memberCount

Integer memberCount

name

String name

parentUid

String parentUid

Package com.bytedesk.core.document

Class com.bytedesk.core.document.DocumentEntity

class DocumentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the document

name

String name

Name of the document

type

String type

Type of document (DOCS、EXCEP、PPT, etc.)

Class com.bytedesk.core.document.DocumentRequest

class DocumentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.document.DocumentResponse

class DocumentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.document.event

Class com.bytedesk.core.document.event.AbstractDocumentEvent

class AbstractDocumentEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

document

DocumentEntity document

Class com.bytedesk.core.document.event.DocumentCreateEvent

class DocumentCreateEvent extends AbstractDocumentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.document.event.DocumentDeleteEvent

class DocumentDeleteEvent extends AbstractDocumentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.document.event.DocumentUpdateEvent

class DocumentUpdateEvent extends AbstractDocumentEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.email

Class com.bytedesk.core.email.EmailEntity

class EmailEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyEnabled

Boolean autoReplyEnabled

autoSyncEnabled

Boolean autoSyncEnabled

connectionError

String connectionError

connectionStatus

String connectionStatus

debug

Boolean debug

description

String description

displayName

String displayName

emailAddress

String emailAddress

emailPassword

String emailPassword

enabled

Boolean enabled

exchangeHost

String exchangeHost

exchangePort

Integer exchangePort

exchangeSslEnabled

Boolean exchangeSslEnabled

imapHost

String imapHost

imapPort

Integer imapPort

imapSslEnabled

Boolean imapSslEnabled

lastSyncTime

ZonedDateTime lastSyncTime

name

String name

pop3Host

String pop3Host

pop3Port

Integer pop3Port

pop3SslEnabled

Boolean pop3SslEnabled

protocol

String protocol

provider

String provider

senderName

String senderName

smtpHost

String smtpHost

smtpPort

Integer smtpPort

smtpSslEnabled

Boolean smtpSslEnabled

smtpTlsEnabled

Boolean smtpTlsEnabled

syncInterval

Integer syncInterval

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.core.email.EmailExtra

class EmailExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

String attachments

附件信息

bccAddresses

String bccAddresses

密送邮箱地址

ccAddresses

String ccAddresses

抄送邮箱地址

contentHtml

String contentHtml

邮件内容（HTML）

contentText

String contentText

邮件内容（纯文本）

emailAddress

String emailAddress

邮件地址

emailConfigUid

String emailConfigUid

邮件配置ID

emailDate

String emailDate

邮件发送/接收时间

emailSize

Long emailSize

邮件大小（字节）

errorMessage

String errorMessage

错误信息

forwardFromMessageId

String forwardFromMessageId

转发的原邮件ID

fromAddress

String fromAddress

发件人邮箱地址

fromName

String fromName

发件人姓名

hasAttachments

Boolean hasAttachments

是否有附件

messageId

String messageId

邮件消息ID

protocol

String protocol

邮件协议类型

replyToMessageId

String replyToMessageId

回复的原邮件ID

status

String status

邮件状态

subject

String subject

邮件主题

threadId

String threadId

邮件线程ID

toAddresses

String toAddresses

收件人邮箱地址

Class com.bytedesk.core.email.EmailRequest

class EmailRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyEnabled

Boolean autoReplyEnabled

autoSyncEnabled

Boolean autoSyncEnabled

debug

Boolean debug

description

String description

emailAddress

String emailAddress

emailPassword

String emailPassword

enabled

Boolean enabled

exchangeHost

String exchangeHost

exchangePort

Integer exchangePort

exchangeSslEnabled

Boolean exchangeSslEnabled

imapHost

String imapHost

imapPort

Integer imapPort

imapSslEnabled

Boolean imapSslEnabled

name

String name

pop3Host

String pop3Host

pop3Port

Integer pop3Port

pop3SslEnabled

Boolean pop3SslEnabled

protocol

String protocol

provider

String provider

senderName

String senderName

smtpHost

String smtpHost

smtpPort

Integer smtpPort

smtpSslEnabled

Boolean smtpSslEnabled

smtpTlsEnabled

Boolean smtpTlsEnabled

syncInterval

Integer syncInterval

workgroupUid

String workgroupUid

Class com.bytedesk.core.email.EmailResponse

class EmailResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyEnabled

Boolean autoReplyEnabled

autoSyncEnabled

Boolean autoSyncEnabled

connectionError

String connectionError

connectionStatus

String connectionStatus

debug

Boolean debug

description

String description

emailAddress

String emailAddress

emailPassword

String emailPassword

enabled

Boolean enabled

exchangeHost

String exchangeHost

exchangePort

Integer exchangePort

exchangeSslEnabled

Boolean exchangeSslEnabled

imapHost

String imapHost

imapPort

Integer imapPort

imapSslEnabled

Boolean imapSslEnabled

lastSyncTime

ZonedDateTime lastSyncTime

name

String name

pop3Host

String pop3Host

pop3Port

Integer pop3Port

pop3SslEnabled

Boolean pop3SslEnabled

protocol

String protocol

provider

String provider

senderName

String senderName

smtpHost

String smtpHost

smtpPort

Integer smtpPort

smtpSslEnabled

Boolean smtpSslEnabled

smtpTlsEnabled

Boolean smtpTlsEnabled

syncInterval

Integer syncInterval

type

String type

workgroupUid

String workgroupUid

Package com.bytedesk.core.email_message

Class com.bytedesk.core.email_message.EmailMessageEntity

class EmailMessageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

String attachments

bccAddresses

String bccAddresses

ccAddresses

String ccAddresses

contentHtml

String contentHtml

contentText

String contentText

description

String description

emailConfigUid

String emailConfigUid

emailDate

ZonedDateTime emailDate

emailSize

Long emailSize

errorMessage

String errorMessage

forwardFromMessageId

String forwardFromMessageId

fromAddress

String fromAddress

fromName

String fromName

hasAttachments

Boolean hasAttachments

important

Boolean important

messageId

String messageId

name

String name

read

Boolean read

replyToMessageId

String replyToMessageId

status

String status

subject

String subject

threadId

String threadId

toAddresses

String toAddresses

type

String type

Class com.bytedesk.core.email_message.EmailMessageRequest

class EmailMessageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

attachmentList

List<EmailMessageRequest.EmailAttachment> attachmentList

附件列表（发送时使用）

attachments

String attachments

bccAddresses

String bccAddresses

bccAddressList

List<String> bccAddressList

密送列表（发送时使用）

ccAddresses

String ccAddresses

ccAddressList

List<String> ccAddressList

抄送列表（发送时使用）

contentHtml

String contentHtml

contentText

String contentText

customHeaders

Map<String,String> customHeaders

自定义邮件头（发送时使用）

description

String description

emailAddress

String emailAddress

emailConfigUid

String emailConfigUid

emailDate

ZonedDateTime emailDate

emailSize

Long emailSize

encoding

String encoding

邮件编码（发送时使用，默认UTF-8）

errorMessage

String errorMessage

forwardFromMessageId

String forwardFromMessageId

fromAddress

String fromAddress

fromName

String fromName

hasAttachments

Boolean hasAttachments

htmlContent

String htmlContent

邮件HTML内容（发送时使用）

important

Boolean important

messageId

String messageId

name

String name

priority

Integer priority

邮件优先级（发送时使用） 1: 高优先级, 3: 普通优先级, 5: 低优先级

read

Boolean read

replyToMessageId

String replyToMessageId

requestReceipt

Boolean requestReceipt

是否请求送达回执（发送时使用）

status

String status

subject

String subject

textContent

String textContent

邮件文本内容（发送时使用）

threadId

String threadId

toAddresses

String toAddresses

toAddressList

List<String> toAddressList

收件人列表（发送时使用）

Class com.bytedesk.core.email_message.EmailMessageResponse

class EmailMessageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

String attachments

bccAddresses

String bccAddresses

ccAddresses

String ccAddresses

contentHtml

String contentHtml

contentText

String contentText

description

String description

duration

Long duration

发送用时（毫秒）

emailConfigUid

String emailConfigUid

emailDate

ZonedDateTime emailDate

emailSize

Long emailSize

errorMessage

String errorMessage

forwardFromMessageId

String forwardFromMessageId

fromAddress

String fromAddress

fromName

String fromName

hasAttachments

Boolean hasAttachments

important

Boolean important

messageId

String messageId

messageSize

Long messageSize

邮件大小（字节）- 发送时使用

name

String name

read

Boolean read

recipientCount

Integer recipientCount

收件人数量

replyToMessageId

String replyToMessageId

sendId

String sendId

邮件发送ID（用于追踪）

sendStatus

EmailMessageResponse.SendStatus sendStatus

发送状态

sendTime

ZonedDateTime sendTime

发送时间

serverMessageId

String serverMessageId

邮件服务器返回的Message-ID（发送时使用）

status

String status

subject

String subject

threadId

String threadId

toAddresses

String toAddresses

type

String type

Package com.bytedesk.core.email_message.event

Class com.bytedesk.core.email_message.event.EmailMessageCreateEvent

class EmailMessageCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

email

EmailMessageEntity email

Class com.bytedesk.core.email_message.event.EmailMessageDeleteEvent

class EmailMessageDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

email

EmailMessageEntity email

Class com.bytedesk.core.email_message.event.EmailMessageUpdateEvent

class EmailMessageUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

email

EmailMessageEntity email

Package com.bytedesk.core.email_template

Class com.bytedesk.core.email_template.EmailTemplateEntity

class EmailTemplateEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

contentType

String contentType

defaultTemplate

Boolean defaultTemplate

description

String description

enabled

Boolean enabled

language

String language

name

String name

plainText

String plainText

preheader

String preheader

status

String status

subject

String subject

tagList

List<String> tagList

templateType

String templateType

templateVersion

Integer templateVersion

useCount

Long useCount

Class com.bytedesk.core.email_template.EmailTemplateRequest

class EmailTemplateRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

contentType

String contentType

defaultTemplate

Boolean defaultTemplate

description

String description

enabled

Boolean enabled

language

String language

name

String name

plainText

String plainText

preheader

String preheader

status

String status

subject

String subject

tagList

List<String> tagList

templateType

String templateType

templateVersion

Integer templateVersion

Class com.bytedesk.core.email_template.EmailTemplateResponse

class EmailTemplateResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

contentType

String contentType

defaultTemplate

Boolean defaultTemplate

description

String description

enabled

Boolean enabled

language

String language

name

String name

plainText

String plainText

preheader

String preheader

status

String status

subject

String subject

tagList

List<String> tagList

templateType

String templateType

templateVersion

Integer templateVersion

useCount

Long useCount

Package com.bytedesk.core.email.event

Class com.bytedesk.core.email.event.AbstractEmailEvent

class AbstractEmailEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

email

EmailEntity email

Class com.bytedesk.core.email.event.EmailCreateEvent

class EmailCreateEvent extends AbstractEmailEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.email.event.EmailDeleteEvent

class EmailDeleteEvent extends AbstractEmailEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.email.event.EmailUpdateEvent

class EmailUpdateEvent extends AbstractEmailEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.exception

Exception com.bytedesk.core.exception.BaseException

class BaseException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.EmailExistsException

class EmailExistsException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.EmailNotFoundException

class EmailNotFoundException extends org.springframework.security.core.AuthenticationException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.ExistsException

class ExistsException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.ForbiddenException

class ForbiddenException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.MobileExistsException

class MobileExistsException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.MobileNotFoundException

class MobileNotFoundException extends org.springframework.security.core.AuthenticationException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.NotFoundException

class NotFoundException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.NotLoginException

class NotLoginException extends BaseException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.TabooException

class TabooException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception com.bytedesk.core.exception.UserDisabledException

class UserDisabledException extends BaseException implements Serializable

serialVersionUID:

-3297016350L

Exception com.bytedesk.core.exception.UsernameExistsException

class UsernameExistsException extends BaseException implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.favorite

Class com.bytedesk.core.favorite.FavoriteEntity

class FavoriteEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

收藏分类

content

String content

收藏的消息内容

description

String description

收藏描述/备注

favoriteSource

String favoriteSource

收藏来源：手动收藏、自动收藏等

isPinned

Boolean isPinned

是否置顶

messageChannel

String messageChannel

消息来源渠道：WEB、ANDROID、IOS等

messageExtra

String messageExtra

消息额外信息（JSON格式）

messageSender

String messageSender

消息发送人信息（JSON格式）

messageStatus

String messageStatus

消息状态

messageType

String messageType

消息类型：TEXT、IMAGE、FILE、AUDIO、VIDEO等

name

String name

收藏名称/标题

originalMessageUid

String originalMessageUid

原始消息ID（如果是从消息收藏的）

originalThreadUid

String originalThreadUid

原始会话ID（如果是从会话收藏的）

tagList

List<String> tagList

收藏的标签列表

threadInfo

String threadInfo

会话信息（JSON格式）

type

String type

收藏类型：THREAD(会话收藏)、CUSTOMER(客户收藏)、MESSAGE(消息收藏)

Class com.bytedesk.core.favorite.FavoriteRequest

class FavoriteRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

收藏分类

description

String description

收藏描述/备注

favoriteSource

String favoriteSource

收藏来源：手动收藏、自动收藏等

isPinned

Boolean isPinned

是否置顶

messageChannel

String messageChannel

消息来源渠道：WEB、ANDROID、IOS等

messageExtra

String messageExtra

消息额外信息（JSON格式）

messageSender

String messageSender

消息发送人信息（JSON格式）

messageStatus

String messageStatus

消息状态

messageType

String messageType

消息类型：TEXT、IMAGE、FILE、AUDIO、VIDEO等

name

String name

收藏名称/标题

originalMessageUid

String originalMessageUid

原始消息ID（如果是从消息收藏的）

originalThreadUid

String originalThreadUid

原始会话ID（如果是从会话收藏的）

tagList

List<String> tagList

收藏的标签列表

threadInfo

String threadInfo

会话信息（JSON格式）

Class com.bytedesk.core.favorite.FavoriteResponse

class FavoriteResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

收藏分类

content

String content

收藏的消息内容

description

String description

收藏描述/备注

favoriteSource

String favoriteSource

收藏来源：手动收藏、自动收藏等

isPinned

Boolean isPinned

是否置顶

messageChannel

String messageChannel

消息来源渠道：WEB、ANDROID、IOS等

messageExtra

String messageExtra

消息额外信息（JSON格式）

messageSender

String messageSender

消息发送人信息（JSON格式）

messageStatus

String messageStatus

消息状态

messageType

String messageType

消息类型：TEXT、IMAGE、FILE、AUDIO、VIDEO等

name

String name

收藏名称/标题

originalMessageUid

String originalMessageUid

原始消息ID（如果是从消息收藏的）

originalThreadUid

String originalThreadUid

原始会话ID（如果是从会话收藏的）

tagList

List<String> tagList

收藏的标签列表

threadInfo

String threadInfo

会话信息（JSON格式）

type

String type

收藏类型：THREAD(会话收藏)、CUSTOMER(客户收藏)、MESSAGE(消息收藏)

Package com.bytedesk.core.favorite.event

Class com.bytedesk.core.favorite.event.AbstractFavoriteEvent

class AbstractFavoriteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

favorite

FavoriteEntity favorite

Class com.bytedesk.core.favorite.event.FavoriteCreateEvent

class FavoriteCreateEvent extends AbstractFavoriteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.favorite.event.FavoriteDeleteEvent

class FavoriteDeleteEvent extends AbstractFavoriteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.favorite.event.FavoriteUpdateEvent

class FavoriteUpdateEvent extends AbstractFavoriteEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.feature

Class com.bytedesk.core.feature.FeatureEntity

class FeatureEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Unique feature code identifier (e.g., im.chat, ticket.basic)

configSchema

String configSchema

JSON schema for feature configuration options

defaultConfig

String defaultConfig

Default configuration values for the feature in JSON format

description

String description

Description of the feature functionality

enabled

Boolean enabled

Whether the feature is enabled

isPremium

Boolean isPremium

Whether this is a premium feature requiring special access

minVersion

String minVersion

Minimum version required to support this feature

moduleName

String moduleName

Module name that the feature belongs to (e.g., im, ticket, forum)

name

String name

Display name of the feature

sortOrder

Integer sortOrder

Sort order for feature display

Class com.bytedesk.core.feature.FeatureRequest

class FeatureRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.feature.FeatureResponse

class FeatureResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.goods

Class com.bytedesk.core.goods.GoodsEntity

class GoodsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the goods

extra

String extra

业务扩展字段（建议为JSON字符串）

image

String image

商品图片

name

String name

Name of the goods

price

Double price

商品价格

quantity

Integer quantity

商品数量（订单场景可选）

tagList

List<String> tagList

商品标签列表

title

String title

商品标题（优先用于展示；为空时可回退到 name）

type

String type

Type of goods (CUSTOMER, TICKET, ARTICLE, etc.)

url

String url

商品链接

Class com.bytedesk.core.goods.GoodsRequest

class GoodsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

extra

String extra

image

String image

name

String name

price

Double price

quantity

Integer quantity

tagList

List<String> tagList

title

String title

url

String url

Class com.bytedesk.core.goods.GoodsResponse

class GoodsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

extra

String extra

image

String image

name

String name

price

Double price

quantity

Integer quantity

tagList

List<String> tagList

title

String title

type

String type

url

String url

Package com.bytedesk.core.goods.event

Class com.bytedesk.core.goods.event.AbstractGoodsEvent

class AbstractGoodsEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

goods

GoodsEntity goods

Class com.bytedesk.core.goods.event.GoodsCreateEvent

class GoodsCreateEvent extends AbstractGoodsEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.goods.event.GoodsDeleteEvent

class GoodsDeleteEvent extends AbstractGoodsEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.goods.event.GoodsUpdateEvent

class GoodsUpdateEvent extends AbstractGoodsEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.gray_release

Class com.bytedesk.core.gray_release.GrayReleaseEntity

class GrayReleaseEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

enableGrayRelease

Boolean enableGrayRelease

endTime

ZonedDateTime endTime

features

String features

grayReleasePercentage

Integer grayReleasePercentage

startTime

ZonedDateTime startTime

status

String status

whitelistUsers

String whitelistUsers

Class com.bytedesk.core.gray_release.GrayReleaseMetrics

class GrayReleaseMetrics extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

errorMessage

String errorMessage

feature

String feature

success

Boolean success

timestamp

ZonedDateTime timestamp

userUid

String userUid

Package com.bytedesk.core.group

Class com.bytedesk.core.group.GroupEntity

class GroupEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

admins

List<UserEntity> admins

Administrators of the group

allowInvite

Boolean allowInvite

Whether members can invite others to the group

avatar

String avatar

Group avatar or profile picture URL

creator

UserEntity creator

User who created the group

description

String description

Description of the group's purpose

external

Boolean external

Whether this is an external group (open to external users)

maxMembers

Integer maxMembers

Maximum number of members allowed in the group

members

List<MemberEntity> members

Members of the group

muteAll

Boolean muteAll

Whether all members are muted (only admins can speak)

name

String name

Name of the group

needApproval

Boolean needApproval

Whether approval is required to join the group

showTopTip

Boolean showTopTip

Whether to show top notification banner

status

String status

Current status of the group (NORMAL, ARCHIVED, etc.)

topTip

String topTip

Top notification banner content

type

String type

Type of group (NORMAL, PROJECT, DEPARTMENT, etc.)

Class com.bytedesk.core.group.GroupRequest

class GroupRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

adminUids

List<String> adminUids

avatar

String avatar

description

String description

isExternal

Boolean isExternal

memberUids

List<String> memberUids

name

String name

robotUids

List<String> robotUids

showTopTip

Boolean showTopTip

status

GroupStatusEnum status

topTip

String topTip

Class com.bytedesk.core.group.GroupResponse

class GroupResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

admins

List<UserProtobuf> admins

avatar

String avatar

creator

UserProtobuf creator

description

String description

isExternal

Boolean isExternal

memberCount

Integer memberCount

memberPreview

List<MemberProtobuf> memberPreview

name

String name

showTopTip

Boolean showTopTip

status

GroupStatusEnum status

topTip

String topTip

type

GroupTypeEnum type

Package com.bytedesk.core.group_invite

Class com.bytedesk.core.group_invite.GroupInviteEntity

class GroupInviteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Class com.bytedesk.core.group_invite.GroupInviteRequest

class GroupInviteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.group_invite.GroupInviteResponse

class GroupInviteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.group_invite.event

Class com.bytedesk.core.group_invite.event.AbstractGroupInviteEvent

class AbstractGroupInviteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

groupInvite

GroupInviteEntity groupInvite

Class com.bytedesk.core.group_invite.event.GroupInviteCreateEvent

class GroupInviteCreateEvent extends AbstractGroupInviteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.group_invite.event.GroupInviteDeleteEvent

class GroupInviteDeleteEvent extends AbstractGroupInviteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.group_invite.event.GroupInviteUpdateEvent

class GroupInviteUpdateEvent extends AbstractGroupInviteEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.group_notice

Class com.bytedesk.core.group_notice.GroupNoticeEntity

class GroupNoticeEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Class com.bytedesk.core.group_notice.GroupNoticeRequest

class GroupNoticeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.group_notice.GroupNoticeResponse

class GroupNoticeResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.group_notice.event

Class com.bytedesk.core.group_notice.event.AbstractGroupNoticeEvent

class AbstractGroupNoticeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

groupNotice

GroupNoticeEntity groupNotice

Class com.bytedesk.core.group_notice.event.GroupNoticeCreateEvent

class GroupNoticeCreateEvent extends AbstractGroupNoticeEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.group_notice.event.GroupNoticeDeleteEvent

class GroupNoticeDeleteEvent extends AbstractGroupNoticeEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.group_notice.event.GroupNoticeUpdateEvent

class GroupNoticeUpdateEvent extends AbstractGroupNoticeEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.group.event

Class com.bytedesk.core.group.event.AbstractGroupEvent

class AbstractGroupEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

group

GroupEntity group

Class com.bytedesk.core.group.event.GroupCreateEvent

class GroupCreateEvent extends AbstractGroupEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.group.event.GroupUpdateEvent

class GroupUpdateEvent extends AbstractGroupEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.intention

Class com.bytedesk.core.intention.IntentionEntity

class IntentionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the intention

name

String name

Name of the intention

type

String type

Type of intention (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.intention.IntentionRequest

class IntentionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.intention.IntentionResponse

class IntentionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.intention.event

Class com.bytedesk.core.intention.event.IntentionCreateEvent

class IntentionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intention

IntentionEntity intention

Class com.bytedesk.core.intention.event.IntentionDeleteEvent

class IntentionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intention

IntentionEntity intention

Class com.bytedesk.core.intention.event.IntentionUpdateEvent

class IntentionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intention

IntentionEntity intention

Package com.bytedesk.core.invoice

Class com.bytedesk.core.invoice.InvoiceEntity

class InvoiceEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

name

String name

state

String state

type

String type

Class com.bytedesk.core.invoice.InvoiceRequest

class InvoiceRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

state

String state

type

String type

Class com.bytedesk.core.invoice.InvoiceResponse

class InvoiceResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

state

String state

type

String type

Package com.bytedesk.core.ip_access

Class com.bytedesk.core.ip_access.IpAccessEntity

class IpAccessEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessCount

Integer accessCount

accessTime

ZonedDateTime accessTime

endpoint

String endpoint

httpMethod

String httpMethod

ip

String ip

ipLocation

String ipLocation

lastAccessTime

ZonedDateTime lastAccessTime

params

String params

Class com.bytedesk.core.ip_access.IpAccessRequest

class IpAccessRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

endpoint

String endpoint

httpMethod

String httpMethod

ip

String ip

ipLocation

String ipLocation

params

String params

Class com.bytedesk.core.ip_access.IpAccessResponse

class IpAccessResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessCount

Integer accessCount

accessTime

ZonedDateTime accessTime

endpoint

String endpoint

httpMethod

String httpMethod

ip

String ip

ipLocation

String ipLocation

lastAccessTime

ZonedDateTime lastAccessTime

params

String params

Package com.bytedesk.core.ip_black

Class com.bytedesk.core.ip_black.IpBlackEntity

class IpBlackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

blackNickname

String blackNickname

blackUid

String blackUid

endTime

ZonedDateTime endTime

ip

String ip

ipLocation

String ipLocation

reason

String reason

startTime

ZonedDateTime startTime

userNickname

String userNickname

userUid

String userUid

Class com.bytedesk.core.ip_black.IpBlackExcel

class IpBlackExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

blackNickname

String blackNickname

blackUid

String blackUid

endTime

String endTime

ip

String ip

ipLocation

String ipLocation

reason

String reason

startTime

String startTime

userNickname

String userNickname

userUid

String userUid

Class com.bytedesk.core.ip_black.IpBlackRequest

class IpBlackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

blackNickname

String blackNickname

blackUid

String blackUid

endTime

ZonedDateTime endTime

ip

String ip

ipLocation

String ipLocation

reason

String reason

startTime

ZonedDateTime startTime

userNickname

String userNickname

Class com.bytedesk.core.ip_black.IpBlackResponse

class IpBlackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

blackNickname

String blackNickname

blackUid

String blackUid

endTime

ZonedDateTime endTime

ip

String ip

ipLocation

String ipLocation

name

String name

reason

String reason

startTime

ZonedDateTime startTime

userNickname

String userNickname

Package com.bytedesk.core.ip_white

Class com.bytedesk.core.ip_white.IpWhiteEntity

class IpWhiteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

ip

String ip

Class com.bytedesk.core.ip_white.IpWhiteRequest

class IpWhiteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

ip

String ip

Class com.bytedesk.core.ip_white.IpWhiteResponse

class IpWhiteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

ip

String ip

Package com.bytedesk.core.llm

Class com.bytedesk.core.llm.LlmProviderConfigDefault

class LlmProviderConfigDefault extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultChatModel

String defaultChatModel

defaultChatProvider

String defaultChatProvider

defaultEmbeddingModel

String defaultEmbeddingModel

defaultEmbeddingProvider

String defaultEmbeddingProvider

defaultRerankModel

String defaultRerankModel

defaultRerankProvider

String defaultRerankProvider

defaultVisionModel

String defaultVisionModel

defaultVisionProvider

String defaultVisionProvider

defaultVoiceModel

String defaultVoiceModel

defaultVoiceProvider

String defaultVoiceProvider

Package com.bytedesk.core.member

Class com.bytedesk.core.member.MemberEntity

class MemberEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

Profile picture URL for the member

deptUid

String deptUid

Department UID that this member belongs to

description

String description

Brief description or bio of the member

email

@Email(message="email format error") String email

Email address of the member

jobNo

String jobNo

Employee job number or ID

jobTitle

String jobTitle

Job title or position of the member

mobile

String mobile

Mobile phone number (Chinese format supported)

nickname

String nickname

Display name of the team member

seatNo

String seatNo

Seat or desk number of the member

status

String status

Current status of the member (INVITING, ACTIVE, INACTIVE, etc.)

telephone

String telephone

Office telephone number

user

UserEntity user

Associated user account for this member

Class com.bytedesk.core.member.MemberProtobuf

class MemberProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

nickname

String nickname

type

String type

uid

String uid

Class com.bytedesk.core.member.MemberRequest

class MemberRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

deptUid

@NotBlank String deptUid

description

String description

email

@Email(message="email format error") String email

groupUid

String groupUid

群组的uid，用于查询特定群组的成员

inviteAccepted

Boolean inviteAccepted

jobNo

String jobNo

jobTitle

String jobTitle

keyword

String keyword

用于筛选成员的关键词，可以是昵称等

mobile

@NotBlank String mobile

nickname

@NotBlank String nickname

password

String password

roleUids

Set<String> roleUids

seatNo

String seatNo

status

String status

subDeptUids

Set<String> subDeptUids

telephone

String telephone

username

String username

Class com.bytedesk.core.member.MemberResponse

class MemberResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

deptUid

String deptUid

description

String description

email

String email

jobNo

String jobNo

jobTitle

String jobTitle

mobile

String mobile

nickname

String nickname

roles

Set<RoleResponseSimple> roles

seatNo

String seatNo

status

String status

telephone

String telephone

user

UserResponseSimple user

Package com.bytedesk.core.member.event

Class com.bytedesk.core.member.event.AbstractMemberEvent

class AbstractMemberEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

member

MemberEntity member

Class com.bytedesk.core.member.event.MemberCreateEvent

class MemberCreateEvent extends AbstractMemberEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.member.event.MemberUpdateEvent

class MemberUpdateEvent extends AbstractMemberEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.member.mq

Class com.bytedesk.core.member.mq.MemberBatchMessage

class MemberBatchMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

batchIndex

Integer batchIndex

批次索引（第几个Member）

batchTotal

Integer batchTotal

批次总数

batchUid

String batchUid

批次唯一标识

createTimestamp

Long createTimestamp

创建时间戳

isLastBatch

Boolean isLastBatch

是否为最后一个批次

memberExcelJson

String memberExcelJson

Member Excel数据（JSON格式）

operationType

String operationType

操作类型：batch_import

orgUid

String orgUid

组织唯一标识

retryCount

Integer retryCount

重试次数

Package com.bytedesk.core.menu

Class com.bytedesk.core.menu.MenuEntity

class MenuEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Primary color used when rendering this menu entry

description

String description

Description of the menu

enabled

Boolean enabled

Whether the menu entry is currently enabled

icon

String icon

Icon key (Ant Design icon name, etc.) for the menu entry

link

String link

External link that the menu points to

name

String name

Name of the menu

openInNewWindow

Boolean openInNewWindow

Whether to open the link in a new window/tab

order

Integer order

Sorting order (lower numbers appear first)

type

String type

Type of menu (ADMIN/DESKTOP, etc.)

Class com.bytedesk.core.menu.MenuRequest

class MenuRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

enabled

Boolean enabled

icon

String icon

link

String link

name

String name

openInNewWindow

Boolean openInNewWindow

order

Integer order

Class com.bytedesk.core.menu.MenuResponse

class MenuResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

enabled

Boolean enabled

icon

String icon

link

String link

name

String name

openInNewWindow

Boolean openInNewWindow

order

Integer order

type

String type

Package com.bytedesk.core.menu.event

Class com.bytedesk.core.menu.event.MenuCreateEvent

class MenuCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

menu

MenuEntity menu

Class com.bytedesk.core.menu.event.MenuDeleteEvent

class MenuDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

menu

MenuEntity menu

Class com.bytedesk.core.menu.event.MenuUpdateEvent

class MenuUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

menu

MenuEntity menu

Package com.bytedesk.core.message

Class com.bytedesk.core.message.AbstractMessageEntity

class AbstractMessageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

content

String content

extra

String extra

status

String status

type

String type

user

String user

sender信息的JSON表示

Class com.bytedesk.core.message.MessageEntity

class MessageEntity extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

thread

ThreadEntity thread

Associated conversation thread containing this message Many-to-one relationship: multiple messages can belong to one thread

Class com.bytedesk.core.message.MessageExtra

class MessageExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

orgUid

String orgUid

tabooOriginalContent

String tabooOriginalContent

translatedText

String translatedText

visibility

MessageVisibilityEnum visibility

Class com.bytedesk.core.message.MessageProtobuf

class MessageProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

ChannelEnum channel

content

String content

createdAt

ZonedDateTime createdAt

extra

String extra

status

MessageStatusEnum status

thread

ThreadProtobuf thread

type

MessageTypeEnum type

uid

String uid

user

UserProtobuf user

Class com.bytedesk.core.message.MessageRequest

class MessageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

componentType

String componentType

nickname

String nickname

searchDate

String searchDate

threadType

String threadType

threadUid

String threadUid

topic

String topic

Class com.bytedesk.core.message.MessageResponse

class MessageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

content

String content

extra

String extra

status

String status

thread

ThreadResponse thread

type

String type

user

UserProtobuf user

Package com.bytedesk.core.message_unread

Class com.bytedesk.core.message_unread.MessageUnreadEntity

class MessageUnreadEntity extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

thread

ThreadEntity thread

Associated conversation thread containing this message Many-to-one relationship: multiple messages can belong to one thread

Class com.bytedesk.core.message_unread.MessageUnreadRequest

class MessageUnreadRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

clearUnread

Boolean clearUnread

visitorUid

String visitorUid

Class com.bytedesk.core.message_unread.MessageUnreadResponse

class MessageUnreadResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

content

String content

extra

String extra

status

String status

thread

ThreadResponse thread

type

String type

user

UserProtobuf user

Package com.bytedesk.core.message.content

Class com.bytedesk.core.message.content.ArticleContent

class ArticleContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

contentHtml

String contentHtml

HTML正文

contentMarkdown

String contentMarkdown

Markdown正文

coverImageUrl

String coverImageUrl

封面图

kbUid

String kbUid

知识库标识

summary

String summary

摘要

title

String title

type

String type

内容类型: TEXT/MARKDOWN/HTML 等

uid

String uid

文章唯一标识

Class com.bytedesk.core.message.content.AudioContent

class AudioContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

caption

String caption

duration

String duration

filename

String filename

format

String format

hash

String hash

label

String label

mimeType

String mimeType

size

String size

url

String url

Class com.bytedesk.core.message.content.ButtonContent

class ButtonContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

enableShareButton

Boolean enableShareButton

是否启用分享按钮 用于extension类型

fallbackUrl

String fallbackUrl

备用URL 用于web_url、extension类型

gameMetadata

ButtonContent.GameMetadata gameMetadata

游戏元数据 用于game_play类型

messengerExtensions

Boolean messengerExtensions

是否启用Messenger扩展 用于web_url类型

payload

String payload

按钮载荷 用于postback、phone_number、game_play类型

timezone

String timezone

时区 用于account_link类型

title

String title

按钮标题 必填字段，最多20个字符

type

String type

按钮类型 必填字段

url

String url

URL地址 用于web_url、account_link、extension类型

viewStyle

String viewStyle

视图样式 用于extension类型 可选值：full, compact, tall

webviewHeightRatio

String webviewHeightRatio

WebView高度比例 用于web_url、extension类型 可选值：compact, tall, full

webviewShareButton

String webviewShareButton

WebView分享按钮设置 用于web_url类型 可选值：hide

Class com.bytedesk.core.message.content.DocumentContent

class DocumentContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

caption

String caption

filename

String filename

hash

String hash

label

String label

name

String name

size

String size

thumbnail

String thumbnail

type

String type

url

String url

Class com.bytedesk.core.message.content.EmailContent

class EmailContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

List<EmailContent.EmailAttachment> attachments

邮件附件列表

content

String content

邮件正文内容（支持HTML格式）

label

String label

邮件标签/说明

subject

String subject

邮件主题

textContent

String textContent

邮件纯文本内容（不含HTML标签）

Class com.bytedesk.core.message.content.FileContent

class FileContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

filename

String filename

hash

String hash

label

String label

name

String name

size

String size

type

String type

url

String url

Class com.bytedesk.core.message.content.FormContent

class FormContent extends BaseContent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.message.content.GoodsContent

class GoodsContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

商品描述

extra

String extra

业务扩展字段（建议为JSON字符串）

image

String image

商品图片

price

Double price

商品价格

quantity

Integer quantity

商品数量（订单场景可选）

tagList

List<String> tagList

商品标签列表

title

String title

商品标题

uid

String uid

商品唯一标识

url

String url

商品链接

Class com.bytedesk.core.message.content.ImageContent

class ImageContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

filename

String filename

hash

String hash

height

String height

label

String label

mimeType

String mimeType

size

String size

thumbnail

String thumbnail

url

String url

width

String width

Class com.bytedesk.core.message.content.InviteContent

class InviteContent extends BaseContent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.message.content.LeaveMsgContent

class LeaveMsgContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

status

String status

Class com.bytedesk.core.message.content.LinkContent

class LinkContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

imageUrl

String imageUrl

label

String label

title

String title

url

String url

Class com.bytedesk.core.message.content.LocationContent

class LocationContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

address

String address

label

String label

latitude

String latitude

longitude

String longitude

Class com.bytedesk.core.message.content.MusicContent

class MusicContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

album

String album

artist

String artist

coverUrl

String coverUrl

duration

String duration

label

String label

title

String title

url

String url

Class com.bytedesk.core.message.content.OrderContent

class OrderContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

extra

String extra

业务扩展字段（建议为JSON字符串）

goods

GoodsContent goods

商品信息

paymentMethod

String paymentMethod

支付方式

shippingAddress

OrderContent.ShippingAddress shippingAddress

收货地址

status

String status

订单状态：pending/paid/shipped/delivered

statusText

String statusText

状态文案（可选，前端优先展示该字段）

time

String time

下单时间（字符串，前端直接展示）

totalAmount

Double totalAmount

订单总金额

uid

String uid

订单号

Class com.bytedesk.core.message.content.QueueContent

class QueueContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

展示给用户的排队提示文本(可国际化处理后再塞入此字段)

estimatedWaitTime

String estimatedWaitTime

人性化预计等待时间描述，如 "约5分钟"；与 waitSeconds 同步，仅展示用。

position

Integer position

当前用户所在排队位置(从1开始)。为便于前端直接数字运算采用 Integer。

queueSize

Integer queueSize

当前队列总人数(含自己)，用于前端显示或动态估算。

serverTimestamp

Long serverTimestamp

服务端时间戳（毫秒）。用于前端进行动态剩余时间估算的基准。

waitSeconds

Integer waitSeconds

预计等待秒数(粗略估算)，前端可换算为分钟展示。为 null 表示无法估算。

Class com.bytedesk.core.message.content.QueueNotification

class QueueNotification extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

estimatedWaitMs

Long estimatedWaitMs

Estimated milliseconds until assignment using the same heuristic shown in Builder.

position

Integer position

Member position in the agent queue; null when no longer waiting (e.g. assigned).

queueMemberUid

String queueMemberUid

Queue member that triggered the update (null only for legacy fallbacks).

queueSize

Integer queueSize

Current queue size exposed for realtime dashboards, may be null when queue missing.

serverTimestamp

long serverTimestamp

Server side epoch millis when the payload was produced.

threadTopic

String threadTopic

threadUid

String threadUid

Associated conversation thread uid so clients can correlate with chat sessions.

user

String user

Class com.bytedesk.core.message.content.QuotationContent

class QuotationContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

quotedContent

String quotedContent

被引用消息的原始内容 对于文本消息，直接存储文本内容 对于其他类型消息，存储JSON格式的内容

quotedCreatedAt

ZonedDateTime quotedCreatedAt

quotedMessageType

MessageTypeEnum quotedMessageType

被引用消息的类型 对应 MessageTypeEnum

quotedMessageUid

String quotedMessageUid

quotedSenderName

String quotedSenderName

quotedSenderUid

String quotedSenderUid

Class com.bytedesk.core.message.content.RateContent

class RateContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

status

String status

Class com.bytedesk.core.message.content.RobotContent

class RobotContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

kbUid

String kbUid

question

String question

questionUid

String questionUid

reasonContent

String reasonContent

regenerationContext

String regenerationContext

robotUid

String robotUid

sources

List<RobotContent.SourceReference> sources

Class com.bytedesk.core.message.content.StickerContent

class StickerContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

caption

String caption

filename

String filename

hash

String hash

label

String label

mimeType

String mimeType

size

String size

url

String url

Class com.bytedesk.core.message.content.TicketContent

class TicketContent extends BaseContent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.message.content.TransferContent

class TransferContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

status

String status

Class com.bytedesk.core.message.content.VideoContent

class VideoContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

caption

String caption

coverUrl

String coverUrl

duration

String duration

filename

String filename

format

String format

hash

String hash

height

String height

label

String label

mimeType

String mimeType

size

String size

url

String url

width

String width

Class com.bytedesk.core.message.content.VoiceContent

class VoiceContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

caption

String caption

duration

String duration

format

String format

label

String label

url

String url

Class com.bytedesk.core.message.content.WelcomeContent

class WelcomeContent extends BaseContent implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

faqs

List<WelcomeContent.QA> faqs

kbUid

String kbUid

Class com.bytedesk.core.message.content.WelcomeContent.QA

class QA extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

question

String question

type

String type

uid

String uid

Package com.bytedesk.core.message.event

Class com.bytedesk.core.message.event.AbstractMessageEvent

class AbstractMessageEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message

MessageEntity message

Class com.bytedesk.core.message.event.MessageCreateEvent

class MessageCreateEvent extends AbstractMessageEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.message.event.MessageJsonEvent

class MessageJsonEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

json

String json

Class com.bytedesk.core.message.event.MessageUpdateEvent

class MessageUpdateEvent extends AbstractMessageEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.moment

Class com.bytedesk.core.moment.MomentEntity

class MomentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the moment display

description

String description

Description of the moment

name

String name

Name of the moment

order

Integer order

Display order of the moment

type

String type

Type of moment (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.moment.MomentRequest

class MomentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.moment.MomentResponse

class MomentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.moment.event

Class com.bytedesk.core.moment.event.AbstractMomentEvent

class AbstractMomentEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

moment

MomentEntity moment

Class com.bytedesk.core.moment.event.MomentCreateEvent

class MomentCreateEvent extends AbstractMomentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.moment.event.MomentDeleteEvent

class MomentDeleteEvent extends AbstractMomentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.moment.event.MomentUpdateEvent

class MomentUpdateEvent extends AbstractMomentEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.notice

Class com.bytedesk.core.notice.NoticeEntity

class NoticeEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

Main content of the notice

extra

String extra

Additional notice information stored as JSON format

status

String status

Current status of the notice (PENDING, PUBLISHED, ARCHIVED, etc.)

title

String title

Title of the notice or announcement

type

String type

Type of notice (LOGIN, SYSTEM, MAINTENANCE, etc.)

Class com.bytedesk.core.notice.NoticeProtobuf

class NoticeProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

extra

String extra

title

String title

type

String type

Class com.bytedesk.core.notice.NoticeRequest

class NoticeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

extra

String extra

status

String status

title

String title

Class com.bytedesk.core.notice.NoticeResponse

class NoticeResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

extra

String extra

status

String status

title

String title

type

String type

userUid

String userUid

Package com.bytedesk.core.notice_account

Class com.bytedesk.core.notice_account.NoticeAccountEntity

class NoticeAccountEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

type

String type

Class com.bytedesk.core.notice_account.NoticeAccountRequest

class NoticeAccountRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

Class com.bytedesk.core.notice_account.NoticeAccountResponse

class NoticeAccountResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

nickname

String nickname

topic

String topic

type

String type

Package com.bytedesk.core.notice.event

Class com.bytedesk.core.notice.event.AbstractNoticeEvent

class AbstractNoticeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

notice

NoticeEntity notice

Class com.bytedesk.core.notice.event.NoticeCreateEvent

class NoticeCreateEvent extends AbstractNoticeEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.notice.event.NoticeDeleteEvent

class NoticeDeleteEvent extends AbstractNoticeEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.notice.event.NoticeUpdateEvent

class NoticeUpdateEvent extends AbstractNoticeEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.notice.extra

Class com.bytedesk.core.notice.extra.NoticeExtraLogin

class NoticeExtraLogin extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

loginBrowser

String loginBrowser

loginDevice

String loginDevice

loginIp

String loginIp

loginLocation

String loginLocation

loginOs

String loginOs

loginTime

String loginTime

Package com.bytedesk.core.open_platform

Class com.bytedesk.core.open_platform.OpenPlatformEntity

class OpenPlatformEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the openPlatform

name

String name

Name of the openPlatform

type

String type

Type of openPlatform (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.open_platform.OpenPlatformRequest

class OpenPlatformRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.open_platform.OpenPlatformResponse

class OpenPlatformResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.open_platform.event

Class com.bytedesk.core.open_platform.event.AbstractOpenPlatformEvent

class AbstractOpenPlatformEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

openPlatform

OpenPlatformEntity openPlatform

Class com.bytedesk.core.open_platform.event.OpenPlatformCreateEvent

class OpenPlatformCreateEvent extends AbstractOpenPlatformEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.open_platform.event.OpenPlatformDeleteEvent

class OpenPlatformDeleteEvent extends AbstractOpenPlatformEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.open_platform.event.OpenPlatformUpdateEvent

class OpenPlatformUpdateEvent extends AbstractOpenPlatformEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.order

Class com.bytedesk.core.order.OrderEntity

class OrderEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

extra

String extra

业务扩展字段（建议为JSON字符串）

name

String name

兼容旧字段

orderDescription

String orderDescription

orderExtra

String orderExtra

orderImage

String orderImage

orderPrice

Double orderPrice

orderQuantity

Integer orderQuantity

orderTagList

List<String> orderTagList

orderTitle

String orderTitle

orderUid

String orderUid

商品快照（用于发送 ORDER 消息时直接构造 OrderContent）

orderUrl

String orderUrl

paymentMethod

String paymentMethod

支付方式

price

double price

shippingAddress

OrderEntity.ShippingAddress shippingAddress

收货地址

state

String state

status

String status

订单状态：pending/paid/shipped/delivered（或内部状态）

statusText

String statusText

状态文案（可选，前端优先展示）

time

String time

下单时间（字符串，前端直接展示）

title

String title

totalAmount

Double totalAmount

订单总金额

Class com.bytedesk.core.order.OrderRequest

class OrderRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

extra

String extra

orderDescription

String orderDescription

orderExtra

String orderExtra

orderImage

String orderImage

orderPrice

Double orderPrice

orderQuantity

Integer orderQuantity

orderTagList

List<String> orderTagList

orderTitle

String orderTitle

orderUid

String orderUid

orderUrl

String orderUrl

paymentMethod

String paymentMethod

price

Double price

shippingAddress

String shippingAddress

shippingName

String shippingName

shippingPhone

String shippingPhone

state

String state

status

String status

statusText

String statusText

time

String time

title

String title

totalAmount

Double totalAmount

Class com.bytedesk.core.order.OrderResponse

class OrderResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

extra

String extra

orderDescription

String orderDescription

orderExtra

String orderExtra

orderImage

String orderImage

orderPrice

Double orderPrice

orderQuantity

Integer orderQuantity

orderTagList

List<String> orderTagList

orderTitle

String orderTitle

orderUid

String orderUid

orderUrl

String orderUrl

paymentMethod

String paymentMethod

price

Double price

shippingAddress

String shippingAddress

shippingName

String shippingName

shippingPhone

String shippingPhone

state

String state

status

String status

statusText

String statusText

time

String time

title

String title

totalAmount

Double totalAmount

Package com.bytedesk.core.order.event

Class com.bytedesk.core.order.event.AbstractOrderEvent

class AbstractOrderEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

order

OrderEntity order

Class com.bytedesk.core.order.event.OrderCreateEvent

class OrderCreateEvent extends AbstractOrderEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.order.event.OrderDeleteEvent

class OrderDeleteEvent extends AbstractOrderEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.order.event.OrderUpdateEvent

class OrderUpdateEvent extends AbstractOrderEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.payment

Class com.bytedesk.core.payment.PaymentEntity

class PaymentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

name

String name

type

String type

Class com.bytedesk.core.payment.PaymentRequest

class PaymentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

type

String type

Class com.bytedesk.core.payment.PaymentResponse

class PaymentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

description

String description

type

String type

Package com.bytedesk.core.proto

Class com.bytedesk.core.proto.HelloReply

class HelloReply extends com.google.protobuf.GeneratedMessage implements Serializable

serialVersionUID:

0L

Serialized Fields

memoizedIsInitialized

byte memoizedIsInitialized

message_

Object message_

Class com.bytedesk.core.proto.HelloRequest

class HelloRequest extends com.google.protobuf.GeneratedMessage implements Serializable

serialVersionUID:

0L

Serialized Fields

memoizedIsInitialized

byte memoizedIsInitialized

name_

Object name_

Package com.bytedesk.core.push

Class com.bytedesk.core.push.PushEntity

class PushEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

content

String content

country

String country

deviceUid

String deviceUid

ip

String ip

ipLocation

String ipLocation

receiver

String receiver

sender

String sender

sendMessage

String sendMessage

sendSuccess

Boolean sendSuccess

status

String status

type

String type

Class com.bytedesk.core.push.PushRequest

class PushRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

country

String country

deviceUid

String deviceUid

forceRefresh

Boolean forceRefresh

ip

String ip

ipLocation

String ipLocation

name

String name

receiver

String receiver

sender

String sender

sendMessage

String sendMessage

sendSuccess

Boolean sendSuccess

status

String status

type

String type

Class com.bytedesk.core.push.PushResponse

class PushResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

content

String content

country

String country

deviceUid

String deviceUid

ip

String ip

ipLocation

String ipLocation

receiver

String receiver

sender

String sender

sendMessage

String sendMessage

sendSuccess

Boolean sendSuccess

status

PushStatusEnum status

type

String type

Class com.bytedesk.core.push.PushTokenEntity

class PushTokenEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

device

String device

name

String name

token

String token

type

String type

Package com.bytedesk.core.quartz

Class com.bytedesk.core.quartz.QuartzJob

class QuartzJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.quartz_task

Class com.bytedesk.core.quartz_task.QuartzTaskEntity

class QuartzTaskEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

cronExpression

String cronExpression

cron

description

String description

描述

durable

Boolean durable

jobClassName

String jobClassName

job class

jobGroup

String jobGroup

任务组名

jobMethodName

String jobMethodName

job method

jobName

String jobName

任务名称

misfirePolicy

String misfirePolicy

misfire policy

nonconcurrent

Boolean nonconcurrent

triggerGroup

String triggerGroup

triggerName

String triggerName

trigger

triggerState

String triggerState

triggerType

String triggerType

updateData

Boolean updateData

Class com.bytedesk.core.quartz_task.QuartzTaskRequest

class QuartzTaskRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

cronExpression

@NotBlank(message="cronExpression is required") String cronExpression

cron

description

String description

durable

Boolean durable

jobClassName

@NotBlank(message="jobClassName is required") String jobClassName

调用类

jobGroup

@NotBlank(message="jobGroup is required") String jobGroup

任务组名

jobMethodName

@NotBlank(message="jobMethodName is required") String jobMethodName

调用方法

jobName

@NotBlank(message="jobName is required") String jobName

任务名称

misfirePolicy

String misfirePolicy

nonconcurrent

Boolean nonconcurrent

triggerGroup

@NotBlank(message="triggerGroup is required") String triggerGroup

triggerName

@NotBlank(message="triggerName is required") String triggerName

trigger

triggerState

String triggerState

triggerType

String triggerType

updateData

Boolean updateData

Class com.bytedesk.core.quartz_task.QuartzTaskResponse

class QuartzTaskResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

cronExpression

String cronExpression

description

String description

durable

Boolean durable

jobClassName

String jobClassName

jobGroup

String jobGroup

jobMethodName

String jobMethodName

jobName

String jobName

misfirePolicy

String misfirePolicy

nonconcurrent

Boolean nonconcurrent

triggerGroup

String triggerGroup

triggerName

String triggerName

triggerState

String triggerState

triggerType

String triggerType

updateData

Boolean updateData

Package com.bytedesk.core.quartz_task.event

Class com.bytedesk.core.quartz_task.event.AbstractQuartzTaskEvent

class AbstractQuartzTaskEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

quartz_task

QuartzTaskEntity quartz_task

Class com.bytedesk.core.quartz_task.event.QuartzTaskCreateEvent

class QuartzTaskCreateEvent extends AbstractQuartzTaskEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz_task.event.QuartzTaskDeleteEvent

class QuartzTaskDeleteEvent extends AbstractQuartzTaskEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz_task.event.QuartzTaskUpdateEvent

class QuartzTaskUpdateEvent extends AbstractQuartzTaskEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.quartz.event

Class com.bytedesk.core.quartz.event.QuartzDay0Event

class QuartzDay0Event extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzDay8Event

class QuartzDay8Event extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzFiveMinEvent

class QuartzFiveMinEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzFiveSecondEvent

class QuartzFiveSecondEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzHalfHourEvent

class QuartzHalfHourEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzHourlyEvent

class QuartzHourlyEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.quartz.event.QuartzOneMinEvent

class QuartzOneMinEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.quartz.job

Class com.bytedesk.core.quartz.job.QuartzDaily0Job

class QuartzDaily0Job extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzDaily8Job

class QuartzDaily8Job extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzFiveMinJob

class QuartzFiveMinJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzFiveSecondJob

class QuartzFiveSecondJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzHalfHourJob

class QuartzHalfHourJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzHourlyJob

class QuartzHourlyJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Class com.bytedesk.core.quartz.job.QuartzOneMinJob

class QuartzOneMinJob extends org.springframework.scheduling.quartz.QuartzJobBean implements Serializable

serialVersionUID:

1L

Serialized Fields

quartzEventPublisher

QuartzEventPublisher quartzEventPublisher

Package com.bytedesk.core.rbac.auth

Class com.bytedesk.core.rbac.auth.AuthRequest

class AuthRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

captchaCode

String captchaCode

captchaUid

String captchaUid

code

String code

country

String country

device

String device

deviceUid

String deviceUid

email

String email

mobile

String mobile

password

String password

passwordHash

String passwordHash

passwordSalt

String passwordSalt

twoFactorEnabled

Boolean twoFactorEnabled

username

String username

Class com.bytedesk.core.rbac.auth.AuthToken

class AuthToken extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isAuthenticated

Boolean isAuthenticated

userDetails

UserDetailsImpl userDetails

Package com.bytedesk.core.rbac.auth.event

Class com.bytedesk.core.rbac.auth.event.AuthSuccessEvent

class AuthSuccessEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.auth.oauth2

Class com.bytedesk.core.rbac.auth.oauth2.OAuth2Entity

class OAuth2Entity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

openId

String openId

provider

String provider

refreshToken

String refreshToken

unionId

String unionId

user

UserEntity user

Class com.bytedesk.core.rbac.auth.oauth2.OAuth2Request

class OAuth2Request extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

openId

String openId

refreshToken

String refreshToken

unionId

String unionId

Class com.bytedesk.core.rbac.auth.oauth2.OAuth2Response

class OAuth2Response extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

openId

String openId

provider

String provider

refreshToken

String refreshToken

unionId

String unionId

user

UserResponse user

Package com.bytedesk.core.rbac.authority

Class com.bytedesk.core.rbac.authority.AuthorityEntity

class AuthorityEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

value

String value

Class com.bytedesk.core.rbac.authority.AuthorityRequest

class AuthorityRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

value

String value

Class com.bytedesk.core.rbac.authority.AuthorityResponse

class AuthorityResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

value

String value

Package com.bytedesk.core.rbac.authority.event

Class com.bytedesk.core.rbac.authority.event.AbstractAuthorityEvent

class AbstractAuthorityEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

authority

AuthorityEntity authority

Class com.bytedesk.core.rbac.authority.event.AuthorityCreateEvent

class AuthorityCreateEvent extends AbstractAuthorityEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.authority.event.AuthorityDeleteEvent

class AuthorityDeleteEvent extends AbstractAuthorityEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.authority.event.AuthorityUpdateEvent

class AuthorityUpdateEvent extends AbstractAuthorityEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.organization

Class com.bytedesk.core.rbac.organization.OrganizationEntity

class OrganizationEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

description

String description

enabled

Boolean enabled

forceValidateEmail

Boolean forceValidateEmail

forceValidateMobile

Boolean forceValidateMobile

identityImage

String identityImage

identityNumber

String identityNumber

identityType

String identityType

logo

String logo

name

@NotBlank String name

rejectReason

String rejectReason

user

UserEntity user

verifiedType

String verifiedType

verifyDate

ZonedDateTime verifyDate

verifyStatus

String verifyStatus

vip

Boolean vip

vipExpireDate

ZonedDateTime vipExpireDate

Class com.bytedesk.core.rbac.organization.OrganizationRequest

class OrganizationRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

description

String description

enabled

Boolean enabled

identityImage

String identityImage

identityNumber

String identityNumber

identityType

String identityType

logo

String logo

name

String name

rejectReason

String rejectReason

verifiedType

String verifiedType

verifyDate

ZonedDateTime verifyDate

verifyStatus

String verifyStatus

vip

Boolean vip

vipExpireDate

ZonedDateTime vipExpireDate

Class com.bytedesk.core.rbac.organization.OrganizationResponse

class OrganizationResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

description

String description

enabled

Boolean enabled

identityImage

String identityImage

identityNumber

String identityNumber

identityType

String identityType

logo

String logo

name

String name

rejectReason

String rejectReason

user

UserResponse user

verifiedType

String verifiedType

verifyDate

ZonedDateTime verifyDate

verifyStatus

String verifyStatus

vip

Boolean vip

vipExpireDate

ZonedDateTime vipExpireDate

Class com.bytedesk.core.rbac.organization.OrganizationResponseSimple

class OrganizationResponseSimple extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

description

String description

enabled

Boolean enabled

logo

String logo

name

String name

uid

String uid

user

UserResponseSimple user

verifyStatus

String verifyStatus

Package com.bytedesk.core.rbac.organization_apply

Class com.bytedesk.core.rbac.organization_apply.OrganizationApplyEntity

class OrganizationApplyEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Class com.bytedesk.core.rbac.organization_apply.OrganizationApplyRequest

class OrganizationApplyRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.rbac.organization_apply.OrganizationApplyResponse

class OrganizationApplyResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.rbac.organization_apply.event

Class com.bytedesk.core.rbac.organization_apply.event.AbstractOrganizationApplyEvent

class AbstractOrganizationApplyEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

organizationApply

OrganizationApplyEntity organizationApply

Class com.bytedesk.core.rbac.organization_apply.event.OrganizationApplyCreateEvent

class OrganizationApplyCreateEvent extends AbstractOrganizationApplyEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.organization_apply.event.OrganizationApplyDeleteEvent

class OrganizationApplyDeleteEvent extends AbstractOrganizationApplyEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.organization_apply.event.OrganizationApplyUpdateEvent

class OrganizationApplyUpdateEvent extends AbstractOrganizationApplyEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.organization.event

Class com.bytedesk.core.rbac.organization.event.AbstractOrganizationEvent

class AbstractOrganizationEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

organization

OrganizationEntity organization

Class com.bytedesk.core.rbac.organization.event.OrganizationCreateEvent

class OrganizationCreateEvent extends AbstractOrganizationEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.role

Class com.bytedesk.core.rbac.role.RoleEntity

class RoleEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

authorities

Set<AuthorityEntity> authorities

description

String description

name

@NotBlank String name

system

Boolean system

value

String value

Class com.bytedesk.core.rbac.role.RoleRequest

class RoleRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

authorityUids

Set<String> authorityUids

注意：不要给 authorityUids 默认初始化为空集合。 否则在 /role/update 时，即使前端未传该字段，反序列化后也会变成空集合， 导致 update() 误判为“请求明确携带 authorityUids”，从而清空角色权限。

description

String description

name

String name

system

Boolean system

value

String value

Class com.bytedesk.core.rbac.role.RoleResponse

class RoleResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

authorities

Set<AuthorityResponse> authorities

description

String description

name

String name

system

Boolean system

value

String value

Class com.bytedesk.core.rbac.role.RoleResponseSimple

class RoleResponseSimple extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

system

Boolean system

value

String value

Package com.bytedesk.core.rbac.role.event

Class com.bytedesk.core.rbac.role.event.AbstractRoleEvent

class AbstractRoleEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

role

RoleEntity role

Class com.bytedesk.core.rbac.role.event.RoleCreateEvent

class RoleCreateEvent extends AbstractRoleEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.role.event.RoleUpdateEvent

class RoleUpdateEvent extends AbstractRoleEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.token

Class com.bytedesk.core.rbac.token.TokenEntity

class TokenEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

channel

String channel

clientId

String clientId

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

lastActiveAt

ZonedDateTime lastActiveAt

name

String name

permanent

Boolean permanent

refreshToken

String refreshToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

type

String type

Class com.bytedesk.core.rbac.token.TokenRequest

class TokenRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

name

String name

permanent

Boolean permanent

refreshToken

String refreshToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

Class com.bytedesk.core.rbac.token.TokenResponse

class TokenResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

channel

String channel

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

name

String name

permanent

Boolean permanent

refreshToken

String refreshToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

type

String type

Package com.bytedesk.core.rbac.token.event

Class com.bytedesk.core.rbac.token.event.AbstractTokenEvent

class AbstractTokenEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

token

TokenEntity token

Class com.bytedesk.core.rbac.token.event.TokenCreateEvent

class TokenCreateEvent extends AbstractTokenEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.token.event.TokenUpdateEvent

class TokenUpdateEvent extends AbstractTokenEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.rbac.user

Class com.bytedesk.core.rbac.user.UserDetailsImpl

class UserDetailsImpl extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

authorities

Collection<? extends org.springframework.security.core.GrantedAuthority> authorities

avatar

String avatar

channel

String channel

country

String country

createdAt

ZonedDateTime createdAt

currentOrganization

OrganizationEntity currentOrganization

currentRoles

Set<RoleEntity> currentRoles

description

String description

device

String device

email

String email

emailVerified

Boolean emailVerified

enabled

Boolean enabled

id

Long id

mobile

String mobile

mobileVerified

Boolean mobileVerified

nickname

String nickname

orgUid

String orgUid

password

String password

platform

String platform

sex

String sex

superUser

Boolean superUser

uid

String uid

updatedAt

ZonedDateTime updatedAt

username

String username

userOrganizationRoles

Set<UserOrganizationRoleEntity> userOrganizationRoles

Class com.bytedesk.core.rbac.user.UserEntity

class UserEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

URL of the user's avatar image

country

String country

Country code for the user (default: 86 for China)

currentOrganization

OrganizationEntity currentOrganization

User's current active organization Users can belong to multiple organizations but can only be active in one at a time

currentRoles

Set<RoleEntity> currentRoles

Current roles assigned to the user in the active organization

description

String description

User description or bio

email

@Email(message="email format error") String email

User's email address for communication and verification

emailVerified

boolean emailVerified

Whether the user's email has been verified

enabled

boolean enabled

Whether the user account is enabled

extra

String extra

mobile

String mobile

User's mobile phone number

mobileVerified

boolean mobileVerified

Whether the user's mobile number has been verified

nickname

String nickname

Display name of the user

num

String num

User number for searching and adding friends

password

String password

Encrypted password for user authentication

passwordModifiedAt

ZonedDateTime passwordModifiedAt

Password last modified time for security compliance Used for tracking password changes and prompting users to update passwords Defaults to account creation time when user is created

registerSource

String registerSource

Registration source of the user Examples: USERNAME, EMAIL, MOBILE, GITHUB, WECHAT, GOOGLE, DINGTALK, FEISHU, FACEBOOK, DOUYIN, LDAP, OIDC, OPENID, ADMIN, IMPORT, UNKNOWN

sex

String sex

User's gender (MALE, FEMALE, UNKNOWN)

superUser

boolean superUser

Whether the user has super administrator privileges

username

@NotBlank(message="username is required") String username

Username used in JWT authentication (required field)

userOrganizationRoles

Set<UserOrganizationRoleEntity> userOrganizationRoles

User's roles across all organizations One user can belong to multiple organizations with different roles in each

Class com.bytedesk.core.rbac.user.UserOrganizationRoleEntity

class UserOrganizationRoleEntity extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

endDate

ZonedDateTime endDate

id

Long id

organization

OrganizationEntity organization

roles

Set<RoleEntity> roles

startDate

ZonedDateTime startDate

user

UserEntity user

Class com.bytedesk.core.rbac.user.UserProtobuf

class UserProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

extra

String extra

nickname

String nickname

type

String type

uid

String uid

Class com.bytedesk.core.rbac.user.UserRequest

class UserRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

captchaCode

String captchaCode

captchaUid

String captchaUid

code

String code

country

String country

currentOrganization

String currentOrganization

description

String description

email

@Email(message="email format error") String email

emailVerified

Boolean emailVerified

enabled

Boolean enabled

mobile

String mobile

mobileVerified

Boolean mobileVerified

newPassword

String newPassword

nickname

String nickname

num

String num

oldPassword

String oldPassword

password

String password

registerSource

String registerSource

roleUids

Set<String> roleUids

sex

UserEntity.Sex sex

username

String username

Class com.bytedesk.core.rbac.user.UserResponse

class UserResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

authorities

Set<org.springframework.security.core.GrantedAuthority> authorities

avatar

String avatar

country

String country

currentOrganization

OrganizationResponseSimple currentOrganization

currentRoles

Set<RoleResponseSimple> currentRoles

description

String description

email

String email

emailVerified

Boolean emailVerified

enabled

Boolean enabled

mobile

String mobile

mobileVerified

Boolean mobileVerified

nickname

String nickname

num

String num

passwordModifiedAt

String passwordModifiedAt

Password last modified time for security compliance tracking

platform

String platform

registerSource

String registerSource

sex

UserEntity.Sex sex

superUser

Boolean superUser

username

String username

Class com.bytedesk.core.rbac.user.UserResponseSimple

class UserResponseSimple extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

enabled

Boolean enabled

nickname

String nickname

superUser

Boolean superUser

uid

String uid

username

String username

Package com.bytedesk.core.rbac.user.event

Class com.bytedesk.core.rbac.user.event.AbstractUserEvent

class AbstractUserEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

user

UserEntity user

Class com.bytedesk.core.rbac.user.event.UserCreateEvent

class UserCreateEvent extends AbstractUserEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.user.event.UserLoginEvent

class UserLoginEvent extends AbstractUserEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.user.event.UserLogoutEvent

class UserLogoutEvent extends AbstractUserEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.rbac.user.event.UserUpdateEvent

class UserUpdateEvent extends AbstractUserEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.recharge

Class com.bytedesk.core.recharge.RechargeEntity

class RechargeEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

channel

String channel

description

String description

name

String name

state

String state

type

String type

Class com.bytedesk.core.recharge.RechargeRequest

class RechargeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

channel

String channel

description

String description

state

String state

type

String type

Class com.bytedesk.core.recharge.RechargeResponse

class RechargeResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

double amount

channel

String channel

description

String description

state

String state

type

String type

Package com.bytedesk.core.recommendation

Class com.bytedesk.core.recommendation.RecommendationEntity

class RecommendationEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the recommendation display

description

String description

Description of the recommendation

name

String name

Name of the recommendation

order

Integer order

Display order of the recommendation

type

String type

Type of recommendation (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.recommendation.RecommendationRequest

class RecommendationRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.recommendation.RecommendationResponse

class RecommendationResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.recommendation.event

Class com.bytedesk.core.recommendation.event.RecommendationCreateEvent

class RecommendationCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

recommendation

RecommendationEntity recommendation

Class com.bytedesk.core.recommendation.event.RecommendationDeleteEvent

class RecommendationDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

recommendation

RecommendationEntity recommendation

Class com.bytedesk.core.recommendation.event.RecommendationUpdateEvent

class RecommendationUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

recommendation

RecommendationEntity recommendation

Package com.bytedesk.core.relation

Class com.bytedesk.core.relation.RelationEntity

class RelationEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

关系分类

commentCount

Integer commentCount

评论数量

extra

String extra

关系额外信息（JSON格式）

fanCount

Integer fanCount

粉丝数量

favoriteCount

Integer favoriteCount

收藏数量

followCount

Integer followCount

关注数量

interactionFrequency

Integer interactionFrequency

互动频率（每月互动次数）

isMuted

Boolean isMuted

是否免打扰

isMutual

Boolean isMutual

是否互相关注

isPinned

Boolean isPinned

是否置顶

isPublic

Boolean isPublic

是否公开（其他用户可见）

isSpecial

Boolean isSpecial

是否特别关注

lastInteractionTime

ZonedDateTime lastInteractionTime

最后互动时间

likeCount

Integer likeCount

点赞数量

metadata

String metadata

关系元数据（JSON格式，存储扩展信息）

objectContentUid

String objectContentUid

关系客体内容ID（被关系的内容，如文章、视频等）

objectUserUid

String objectUserUid

关系客体用户ID（被关系的用户）

relationDurationDays

Integer relationDurationDays

关系持续时间（天数）

relationEndTime

ZonedDateTime relationEndTime

关系结束时间

relationQualityScore

Integer relationQualityScore

关系质量评分（0-100）

relationStartTime

ZonedDateTime relationStartTime

关系开始时间

remark

String remark

关系备注

shareCount

Integer shareCount

分享数量

source

String source

关系来源（如：推荐、搜索、分享等）

status

String status

关系状态：ACTIVE(活跃)、INACTIVE(非活跃)、BLOCKED(屏蔽)、DELETED(删除)

subjectUserUid

String subjectUserUid

关系主体用户ID（发起关系的用户）

subtype

String subtype

关系子类型（如：互相关注、单向关注等）

tagList

List<String> tagList

关系标签列表

type

String type

Type of relation (FOLLOW, LIKE, FAVORITE, etc.)

viewCount

Integer viewCount

浏览数量

weight

Integer weight

关系强度/权重（0-100，用于算法推荐）

Class com.bytedesk.core.relation.RelationRequest

class RelationRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

关系分类

commentCount

Integer commentCount

评论数量

extra

String extra

关系额外信息（JSON格式）

fanCount

Integer fanCount

粉丝数量

favoriteCount

Integer favoriteCount

收藏数量

followCount

Integer followCount

关注数量

interactionFrequency

Integer interactionFrequency

互动频率（每月互动次数）

isMuted

Boolean isMuted

是否免打扰

isMutual

Boolean isMutual

是否互相关注

isPinned

Boolean isPinned

是否置顶

isPublic

Boolean isPublic

是否公开（其他用户可见）

isSpecial

Boolean isSpecial

是否特别关注

lastInteractionTime

String lastInteractionTime

最后互动时间

likeCount

Integer likeCount

点赞数量

metadata

String metadata

关系元数据（JSON格式，存储扩展信息）

objectContentUid

String objectContentUid

关系客体内容ID（被关系的内容，如文章、视频等）

objectUserUid

String objectUserUid

关系客体用户ID（被关系的用户）

relationDurationDays

Integer relationDurationDays

关系持续时间（天数）

relationEndTime

String relationEndTime

关系结束时间

relationQualityScore

Integer relationQualityScore

关系质量评分（0-100）

relationStartTime

String relationStartTime

关系开始时间

remark

String remark

关系备注

shareCount

Integer shareCount

分享数量

source

String source

关系来源（如：推荐、搜索、分享等）

status

String status

关系状态

subjectUserUid

String subjectUserUid

关系主体用户ID（发起关系的用户）

subtype

String subtype

关系子类型（如：互相关注、单向关注等）

tagList

List<String> tagList

关系标签列表

viewCount

Integer viewCount

浏览数量

weight

Integer weight

关系强度/权重（0-100，用于算法推荐）

Class com.bytedesk.core.relation.RelationResponse

class RelationResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

category

String category

关系分类

commentCount

Integer commentCount

评论数量

extra

String extra

关系额外信息（JSON格式）

fanCount

Integer fanCount

粉丝数量

favoriteCount

Integer favoriteCount

收藏数量

followCount

Integer followCount

关注数量

interactionFrequency

Integer interactionFrequency

互动频率（每月互动次数）

isMuted

Boolean isMuted

是否免打扰

isMutual

Boolean isMutual

是否互相关注

isPinned

Boolean isPinned

是否置顶

isPublic

Boolean isPublic

是否公开（其他用户可见）

isSpecial

Boolean isSpecial

是否特别关注

lastInteractionTime

ZonedDateTime lastInteractionTime

最后互动时间

likeCount

Integer likeCount

点赞数量

metadata

String metadata

关系元数据（JSON格式，存储扩展信息）

objectContentUid

String objectContentUid

关系客体内容ID（被关系的内容，如文章、视频等）

objectUserUid

String objectUserUid

关系客体用户ID（被关系的用户）

relationDurationDays

Integer relationDurationDays

关系持续时间（天数）

relationEndTime

ZonedDateTime relationEndTime

关系结束时间

relationQualityScore

Integer relationQualityScore

关系质量评分（0-100）

relationStartTime

ZonedDateTime relationStartTime

关系开始时间

remark

String remark

关系备注

shareCount

Integer shareCount

分享数量

source

String source

关系来源（如：推荐、搜索、分享等）

status

String status

关系状态

subjectUserUid

String subjectUserUid

关系主体用户ID（发起关系的用户）

subtype

String subtype

关系子类型（如：互相关注、单向关注等）

tagList

List<String> tagList

关系标签列表

type

String type

viewCount

Integer viewCount

浏览数量

weight

Integer weight

关系强度/权重（0-100，用于算法推荐）

Package com.bytedesk.core.relation.event

Class com.bytedesk.core.relation.event.AbstractRelationEvent

class AbstractRelationEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

relation

RelationEntity relation

Class com.bytedesk.core.relation.event.RelationCreateEvent

class RelationCreateEvent extends AbstractRelationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.relation.event.RelationDeleteEvent

class RelationDeleteEvent extends AbstractRelationEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.relation.event.RelationUpdateEvent

class RelationUpdateEvent extends AbstractRelationEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.schedule

Class com.bytedesk.core.schedule.ScheduleEntity

class ScheduleEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the schedule display

description

String description

Description of the schedule

name

String name

Name of the schedule

order

Integer order

Display order of the schedule

type

String type

Type of schedule (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.schedule.ScheduleRequest

class ScheduleRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.schedule.ScheduleResponse

class ScheduleResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.schedule.event

Class com.bytedesk.core.schedule.event.AbstractScheduleEvent

class AbstractScheduleEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

schedule

ScheduleEntity schedule

Class com.bytedesk.core.schedule.event.ScheduleCreateEvent

class ScheduleCreateEvent extends AbstractScheduleEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.schedule.event.ScheduleDeleteEvent

class ScheduleDeleteEvent extends AbstractScheduleEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.schedule.event.ScheduleUpdateEvent

class ScheduleUpdateEvent extends AbstractScheduleEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.server

Class com.bytedesk.core.server.ServerEntity

class ServerEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

appVersion

String appVersion

Application version

cpuAlertThreshold

Double cpuAlertThreshold

Alert threshold for CPU usage

cpuUsage

Double cpuUsage

CPU usage percentage (0-100)

description

String description

Server description

diskAlertThreshold

Double diskAlertThreshold

Alert threshold for disk usage

diskUsage

Double diskUsage

Disk usage percentage (0-100)

environment

String environment

Environment (DEV, TEST, PROD, etc.)

javaVersion

String javaVersion

Java version (if applicable)

lastHeartbeat

ZonedDateTime lastHeartbeat

Last heartbeat time

location

String location

Server location or data center

memoryAlertThreshold

Double memoryAlertThreshold

Alert threshold for memory usage

memoryUsage

Double memoryUsage

Memory usage percentage (0-100)

monitoringEnabled

Boolean monitoringEnabled

Monitoring enabled flag

osInfo

String osInfo

Operating system information

serverIp

String serverIp

Server IP address

serverName

String serverName

Server hostname or identifier

serverPort

Integer serverPort

Server port (if applicable)

startTime

ZonedDateTime startTime

Server start time

status

String status

Server status (ONLINE, OFFLINE, MAINTENANCE, etc.)

totalDiskGb

Long totalDiskGb

Total disk space in GB

totalMemoryMb

Long totalMemoryMb

Total memory in MB

type

String type

Server type (APPLICATION, DATABASE, CACHE, etc.)

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds

usedDiskGb

Long usedDiskGb

Used disk space in GB

usedMemoryMb

Long usedMemoryMb

Used memory in MB

Class com.bytedesk.core.server.ServerRequest

class ServerRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

appVersion

String appVersion

Application version

cpuAlertThreshold

Double cpuAlertThreshold

Alert threshold for CPU usage

cpuUsage

Double cpuUsage

CPU usage percentage (0-100)

description

String description

Server description

diskAlertThreshold

Double diskAlertThreshold

Alert threshold for disk usage

diskUsage

Double diskUsage

Disk usage percentage (0-100)

environment

String environment

Environment (DEV, TEST, PROD, etc.)

environmentFilter

String environmentFilter

heartbeatThresholdMinutes

Integer heartbeatThresholdMinutes

highUsageFilter

Boolean highUsageFilter

javaVersion

String javaVersion

Java version (if applicable)

lastHeartbeat

ZonedDateTime lastHeartbeat

Last heartbeat time

location

String location

Server location or data center

locationFilter

String locationFilter

memoryAlertThreshold

Double memoryAlertThreshold

Alert threshold for memory usage

memoryUsage

Double memoryUsage

Memory usage percentage (0-100)

monitoringEnabled

Boolean monitoringEnabled

Monitoring enabled flag

offlineFilter

Boolean offlineFilter

osInfo

String osInfo

Operating system information

serverIp

String serverIp

Server IP address

serverName

String serverName

Server hostname or identifier

serverPort

Integer serverPort

Server port (if applicable)

serverStatus

String serverStatus

Server status (ONLINE, OFFLINE, MAINTENANCE, etc.)

serverStatusFilter

String serverStatusFilter

serverType

String serverType

Server type (APPLICATION, DATABASE, CACHE, etc.)

serverTypeFilter

String serverTypeFilter

Search filters

startTime

ZonedDateTime startTime

Server start time

totalDiskGb

Long totalDiskGb

Total disk space in GB

totalMemoryMb

Long totalMemoryMb

Total memory in MB

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds

usedDiskGb

Long usedDiskGb

Used disk space in GB

usedMemoryMb

Long usedMemoryMb

Used memory in MB

Class com.bytedesk.core.server.ServerResponse

class ServerResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

appVersion

String appVersion

Application version

cpuAlertThreshold

Double cpuAlertThreshold

Alert threshold for CPU usage

cpuUsage

Double cpuUsage

CPU usage percentage (0-100)

description

String description

Server description

diskAlertThreshold

Double diskAlertThreshold

Alert threshold for disk usage

diskUsage

Double diskUsage

Disk usage percentage (0-100)

environment

String environment

Environment (DEV, TEST, PROD, etc.)

hasHighCpuUsage

Boolean hasHighCpuUsage

hasHighDiskUsage

Boolean hasHighDiskUsage

hasHighMemoryUsage

Boolean hasHighMemoryUsage

hasRecentHeartbeat

Boolean hasRecentHeartbeat

isHealthy

Boolean isHealthy

Health status indicators

isOperational

Boolean isOperational

javaVersion

String javaVersion

Java version (if applicable)

lastHeartbeat

ZonedDateTime lastHeartbeat

Last heartbeat time

location

String location

Server location or data center

memoryAlertThreshold

Double memoryAlertThreshold

Alert threshold for memory usage

memoryUsage

Double memoryUsage

Memory usage percentage (0-100)

monitoringEnabled

Boolean monitoringEnabled

Monitoring enabled flag

osInfo

String osInfo

Operating system information

serverIp

String serverIp

Server IP address

serverName

String serverName

Server hostname or identifier

serverPort

Integer serverPort

Server port (if applicable)

serverStatus

String serverStatus

Server status (ONLINE, OFFLINE, MAINTENANCE, etc.)

serverType

String serverType

Server type (APPLICATION, DATABASE, CACHE, etc.)

startTime

ZonedDateTime startTime

Server start time

totalDiskGb

Long totalDiskGb

Total disk space in GB

totalMemoryMb

Long totalMemoryMb

Total memory in MB

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds

usedDiskGb

Long usedDiskGb

Used disk space in GB

usedMemoryMb

Long usedMemoryMb

Used memory in MB

Package com.bytedesk.core.server_metrics

Class com.bytedesk.core.server_metrics.ServerMetricsEntity

class ServerMetricsEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionInterval

Integer collectionInterval

Collection interval in minutes (e.g., 5 for 5-minute intervals)

cpuUsage

Double cpuUsage

CPU usage percentage (0-100) - 主要变化曲线数据

diskUsage

Double diskUsage

Disk usage percentage (0-100) - 主要变化曲线数据

memoryUsage

Double memoryUsage

Memory usage percentage (0-100) - 主要变化曲线数据

serverUid

String serverUid

Reference to the server entity

timestamp

ZonedDateTime timestamp

Timestamp when metrics were recorded

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds - 用于监控服务器运行状态

usedDiskGb

Long usedDiskGb

Used disk space in GB - 用于计算磁盘使用量变化

usedMemoryMb

Long usedMemoryMb

Used memory in MB - 用于计算内存使用量变化

Class com.bytedesk.core.server_metrics.ServerMetricsRequest

class ServerMetricsRequest extends BaseRequestNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionInterval

Integer collectionInterval

Collection interval in minutes

cpuUsage

Double cpuUsage

CPU usage percentage (0-100)

diskUsage

Double diskUsage

Disk usage percentage (0-100)

memoryUsage

Double memoryUsage

Memory usage percentage (0-100)

serverUid

String serverUid

Server UID reference

timestamp

ZonedDateTime timestamp

Timestamp when metrics were recorded

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds

usedDiskGb

Long usedDiskGb

Used disk space in GB

usedMemoryMb

Long usedMemoryMb

Used memory in MB

Class com.bytedesk.core.server_metrics.ServerMetricsResponse

class ServerMetricsResponse extends BaseResponseNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionInterval

Integer collectionInterval

Collection interval in minutes

cpuUsage

Double cpuUsage

CPU usage percentage (0-100)

diskUsage

Double diskUsage

Disk usage percentage (0-100)

hasHighCpuUsage

Boolean hasHighCpuUsage

Health status indicators

hasHighDiskUsage

Boolean hasHighDiskUsage

hasHighMemoryUsage

Boolean hasHighMemoryUsage

isHealthy

Boolean isHealthy

memoryUsage

Double memoryUsage

Memory usage percentage (0-100)

serverName

String serverName

Server name (for display purposes)

serverUid

String serverUid

Server UID reference

timestamp

ZonedDateTime timestamp

Timestamp when metrics were recorded

uptimeSeconds

Long uptimeSeconds

Server uptime in seconds

usedDiskGb

Long usedDiskGb

Used disk space in GB

usedMemoryMb

Long usedMemoryMb

Used memory in MB

Package com.bytedesk.core.server.event

Class com.bytedesk.core.server.event.AbstractServerEvent

class AbstractServerEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

server

ServerEntity server

Class com.bytedesk.core.server.event.ServerCreateEvent

class ServerCreateEvent extends AbstractServerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.server.event.ServerDeleteEvent

class ServerDeleteEvent extends AbstractServerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.server.event.ServerUpdateEvent

class ServerUpdateEvent extends AbstractServerEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.settings

Class com.bytedesk.core.settings.SettingsEntity

class SettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the settings

email

EmailEntity email

关联的邮箱实体 当 type = EMAIL 时使用，关联 EmailEntity 避免在 Settings 中重复存储邮箱配置字段

emailEnabled

Boolean emailEnabled

邮件配置是否启用 当 type = EMAIL 时使用

name

String name

Name of the settings

smsEnabled

Boolean smsEnabled

短信配置是否启用 当 type = SMS 时使用

smsProvider

SmsProviderEntity smsProvider

关联的短信服务商实体 当 type = SMS 时使用，关联 SmsProviderEntity 避免在 Settings 中重复存储短信配置字段

ticketCenterEnabled

Boolean ticketCenterEnabled

工单中心配置是否启用 当 type = TICKET_CENTER 时使用

type

String type

Type of settings (EMAIL, SMS, TICKET_CENTER, etc.)

workgroup

WorkgroupEntity workgroup

工单中心使用的工作组 当 type = TICKET_CENTER 且 level = PLATFORM 时使用 指向 DEFAULT_ORGANIZATION_UID 组织下的工作组 其他工单配置（如分类、自动分配、优先级等）在工作组的 TicketSettings 中配置

Class com.bytedesk.core.settings.SettingsRequest

class SettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

emailEnabled

Boolean emailEnabled

邮件配置是否启用

emailUid

String emailUid

关联的邮箱实体UID 当 type = EMAIL 时使用，关联 EmailEntity

name

String name

smsEnabled

Boolean smsEnabled

短信配置是否启用

smsProviderUid

String smsProviderUid

关联的短信服务商实体UID 当 type = SMS 时使用，关联 SmsProviderEntity

ticketCenterEnabled

Boolean ticketCenterEnabled

工单中心配置是否启用

type

String type

设置类型: CUSTOMER, TICKET, EMAIL, SMS, TICKET_CENTER 等

workgroupUid

String workgroupUid

工单中心使用的工作组UID 其他工单配置（如分类、自动分配、优先级等）在工作组的 TicketSettings 中配置

Class com.bytedesk.core.settings.SettingsResponse

class SettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

emailAddress

String emailAddress

关联的邮箱地址（展示用）

emailEnabled

Boolean emailEnabled

邮件配置是否启用

emailUid

String emailUid

关联的邮箱实体UID

name

String name

smsEnabled

Boolean smsEnabled

短信配置是否启用

smsProviderName

String smsProviderName

短信服务商名称（展示用）

smsProviderUid

String smsProviderUid

关联的短信服务商实体UID

ticketCenterEnabled

Boolean ticketCenterEnabled

工单中心配置是否启用

type

String type

workgroupName

String workgroupName

工作组名称（展示用）

workgroupUid

String workgroupUid

工单中心使用的工作组UID

Package com.bytedesk.core.settings.event

Class com.bytedesk.core.settings.event.SettingsCreateEvent

class SettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

settings

SettingsEntity settings

Class com.bytedesk.core.settings.event.SettingsDeleteEvent

class SettingsDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

settings

SettingsEntity settings

Class com.bytedesk.core.settings.event.SettingsUpdateEvent

class SettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

settings

SettingsEntity settings

Package com.bytedesk.core.sms

Class com.bytedesk.core.sms.SmsEntity

class SmsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the sms

name

String name

Name of the sms

type

String type

Type of sms (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.sms.SmsRequest

class SmsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.sms.SmsResponse

class SmsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.sms_provider

Class com.bytedesk.core.sms_provider.SmsProviderEntity

class SmsProviderEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessKeyId

String accessKeyId

短信服务访问密钥ID

accessKeySecret

String accessKeySecret

短信服务访问密钥Secret

description

String description

Description of the sms_provider

enabled

Boolean enabled

配置是否启用

endpoint

String endpoint

短信服务端点/Endpoint

name

String name

Name of the sms_provider

providerType

String providerType

短信服务商类型 (ALIYUN, TENCENT, HUAWEI等)

region

String region

短信服务区域/Region

signName

String signName

短信签名

templateCode

String templateCode

验证码短信模板ID

type

String type

Type of sms_provider (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.sms_provider.SmsProviderRequest

class SmsProviderRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessKeyId

String accessKeyId

短信服务访问密钥ID

accessKeySecret

String accessKeySecret

短信服务访问密钥Secret

color

String color

description

String description

enabled

Boolean enabled

配置是否启用

endpoint

String endpoint

短信服务端点/Endpoint

name

String name

order

Integer order

providerType

String providerType

短信服务商类型 (ALIYUN, TENCENT, HUAWEI等)

region

String region

短信服务区域/Region

signName

String signName

短信签名

templateCode

String templateCode

验证码短信模板ID

Class com.bytedesk.core.sms_provider.SmsProviderResponse

class SmsProviderResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessKeyId

String accessKeyId

短信服务访问密钥ID

accessKeySecret

String accessKeySecret

短信服务访问密钥Secret 注意：响应中返回掩码处理后的值

color

String color

description

String description

enabled

Boolean enabled

配置是否启用

endpoint

String endpoint

短信服务端点/Endpoint

name

String name

order

Integer order

providerType

String providerType

短信服务商类型 (ALIYUN, TENCENT, HUAWEI等)

region

String region

短信服务区域/Region

signName

String signName

短信签名

templateCode

String templateCode

验证码短信模板ID

type

String type

Package com.bytedesk.core.sms_provider.event

Class com.bytedesk.core.sms_provider.event.SmsProviderCreateEvent

class SmsProviderCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_provider

SmsProviderEntity sms_provider

Class com.bytedesk.core.sms_provider.event.SmsProviderDeleteEvent

class SmsProviderDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_provider

SmsProviderEntity sms_provider

Class com.bytedesk.core.sms_provider.event.SmsProviderUpdateEvent

class SmsProviderUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_provider

SmsProviderEntity sms_provider

Package com.bytedesk.core.sms_template

Class com.bytedesk.core.sms_template.SmsTemplateEntity

class SmsTemplateEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the sms_template

name

String name

Name of the sms_template

type

String type

Type of sms_template (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.sms_template.SmsTemplateRequest

class SmsTemplateRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.sms_template.SmsTemplateResponse

class SmsTemplateResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.sms_template.event

Class com.bytedesk.core.sms_template.event.SmsTemplateCreateEvent

class SmsTemplateCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_template

SmsTemplateEntity sms_template

Class com.bytedesk.core.sms_template.event.SmsTemplateDeleteEvent

class SmsTemplateDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_template

SmsTemplateEntity sms_template

Class com.bytedesk.core.sms_template.event.SmsTemplateUpdateEvent

class SmsTemplateUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms_template

SmsTemplateEntity sms_template

Package com.bytedesk.core.sms.event

Class com.bytedesk.core.sms.event.SmsCreateEvent

class SmsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms

SmsEntity sms

Class com.bytedesk.core.sms.event.SmsDeleteEvent

class SmsDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms

SmsEntity sms

Class com.bytedesk.core.sms.event.SmsUpdateEvent

class SmsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

sms

SmsEntity sms

Package com.bytedesk.core.socket.connection

Class com.bytedesk.core.socket.connection.ConnectionEntity

class ConnectionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

渠道：如 WEB_VISITOR / WEB / APP 等（与系统 channel 对齐）

clientId

String clientId

客户端唯一标识（如 MQTT clientId、WS sessionId 等）

connectedAt

Long connectedAt

首次连接毫秒时间戳

deviceUid

String deviceUid

设备 UID（可选，来自 clientId 或 SDK）

disconnectedAt

Long disconnectedAt

断开连接毫秒时间戳

ip

String ip

客户端 IP

lastHeartbeatAt

Long lastHeartbeatAt

最近心跳/活跃毫秒时间戳

protocol

String protocol

协议：MQTT / WS / SSE / OTHER

status

String status

连接状态：CONNECTED / DISCONNECTED

ttlSeconds

Integer ttlSeconds

心跳存活 TTL（秒），用于判定是否在线（lastHeartbeatAt 未过期）

userAgent

String userAgent

User-Agent（可选，长度较长）

Class com.bytedesk.core.socket.connection.ConnectionRequest

class ConnectionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

deviceUid

String deviceUid

ip

String ip

protocol

String protocol

ttlSeconds

Integer ttlSeconds

userAgent

String userAgent

Class com.bytedesk.core.socket.connection.ConnectionResponse

class ConnectionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

clientId

String clientId

connectedAt

Long connectedAt

deviceUid

String deviceUid

disconnectedAt

Long disconnectedAt

ip

String ip

lastHeartbeatAt

Long lastHeartbeatAt

protocol

String protocol

status

String status

ttlSeconds

Integer ttlSeconds

userAgent

String userAgent

Package com.bytedesk.core.socket.connection.event

Class com.bytedesk.core.socket.connection.event.AbstractConnectionEvent

class AbstractConnectionEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

connection

ConnectionEntity connection

Class com.bytedesk.core.socket.connection.event.ConnectionCreateEvent

class ConnectionCreateEvent extends AbstractConnectionEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.socket.connection.event.ConnectionDeleteEvent

class ConnectionDeleteEvent extends AbstractConnectionEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.socket.connection.event.ConnectionUpdateEvent

class ConnectionUpdateEvent extends AbstractConnectionEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.socket.mqtt

Class com.bytedesk.core.socket.mqtt.MqttSession

class MqttSession extends Object implements Serializable

serialVersionUID:

5331399138373076213L

Serialized Fields

channel

io.netty.channel.Channel channel

cleanSession

Boolean cleanSession

clientId

String clientId

willMessage

io.netty.handler.codec.mqtt.MqttPublishMessage willMessage

Package com.bytedesk.core.socket.mqtt.event

Class com.bytedesk.core.socket.mqtt.event.MqttConnectedEvent

class MqttConnectedEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

Class com.bytedesk.core.socket.mqtt.event.MqttDisconnectedEvent

class MqttDisconnectedEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

Class com.bytedesk.core.socket.mqtt.event.MqttSubscribeEvent

class MqttSubscribeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

topic

String topic

Class com.bytedesk.core.socket.mqtt.event.MqttUnsubscribeEvent

class MqttUnsubscribeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

topic

String topic

Package com.bytedesk.core.socket.protobuf.model

Class com.bytedesk.core.socket.protobuf.model.MessageProto.Message

class Message extends com.google.protobuf.GeneratedMessage implements Serializable

serialVersionUID:

0L

Serialized Fields

bitField0_

int bitField0_

channel_

Object channel_

content_

Object content_

createdAt_

Object createdAt_

extra_

Object extra_

memoizedIsInitialized

byte memoizedIsInitialized

status_

Object status_

thread_

ThreadProto.Thread thread_

type_

Object type_

uid_

Object uid_

user_

UserProto.User user_

Class com.bytedesk.core.socket.protobuf.model.ThreadProto.Thread

class Thread extends com.google.protobuf.GeneratedMessage implements Serializable

serialVersionUID:

0L

Serialized Fields

bitField0_

int bitField0_

channel_

Object channel_

extra_

Object extra_

memoizedIsInitialized

byte memoizedIsInitialized

state_

Object state_

topic_

Object topic_

type_

Object type_

uid_

Object uid_

user_

UserProto.User user_

Class com.bytedesk.core.socket.protobuf.model.UserProto.User

class User extends com.google.protobuf.GeneratedMessage implements Serializable

serialVersionUID:

0L

Serialized Fields

avatar_

Object avatar_

extra_

Object extra_

memoizedIsInitialized

byte memoizedIsInitialized

nickname_

Object nickname_

type_

Object type_

uid_

Object uid_

Package com.bytedesk.core.socket.stomp.event

Class com.bytedesk.core.socket.stomp.event.StompConnectedEvent

class StompConnectedEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

Class com.bytedesk.core.socket.stomp.event.StompDisconnectedEvent

class StompDisconnectedEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

Class com.bytedesk.core.socket.stomp.event.StompSubscribeEvent

class StompSubscribeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

topic

String topic

Class com.bytedesk.core.socket.stomp.event.StompUnsubscribeEvent

class StompUnsubscribeEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

clientId

String clientId

topic

String topic

Package com.bytedesk.core.subscription

Class com.bytedesk.core.subscription.SubscriptionEntity

class SubscriptionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the subscription

name

String name

Name of the subscription

type

String type

Type of subscription (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.subscription.SubscriptionRequest

class SubscriptionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.core.subscription.SubscriptionResponse

class SubscriptionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.core.subscription.event

Class com.bytedesk.core.subscription.event.SubscriptionCreateEvent

class SubscriptionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

subscription

SubscriptionEntity subscription

Class com.bytedesk.core.subscription.event.SubscriptionDeleteEvent

class SubscriptionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

subscription

SubscriptionEntity subscription

Class com.bytedesk.core.subscription.event.SubscriptionUpdateEvent

class SubscriptionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

subscription

SubscriptionEntity subscription

Package com.bytedesk.core.tag

Class com.bytedesk.core.tag.TagEntity

class TagEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the tag display

description

String description

Description of the tag

name

String name

Name of the tag

order

Integer order

Display order of the tag

type

String type

Type of tag (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.tag.TagRequest

class TagRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.tag.TagResponse

class TagResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.tag.event

Class com.bytedesk.core.tag.event.AbstractTagEvent

class AbstractTagEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

TagEntity tag

Class com.bytedesk.core.tag.event.TagCreateEvent

class TagCreateEvent extends AbstractTagEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.tag.event.TagDeleteEvent

class TagDeleteEvent extends AbstractTagEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.tag.event.TagUpdateEvent

class TagUpdateEvent extends AbstractTagEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.task

Class com.bytedesk.core.task.TaskEntity

class TaskEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the task display

commentCount

Integer commentCount

Comment count for this task

completedAt

ZonedDateTime completedAt

Completion time

description

String description

Description of the task

dueAt

ZonedDateTime dueAt

Optional due time

favoriteCount

Integer favoriteCount

Favorite/collect count for this task

images

List<String> images

Task images (URLs)

likeCount

Integer likeCount

Like count for this task

name

String name

Name of the task

order

Integer order

Display order within the list

priority

String priority

Priority (LOW, MEDIUM, HIGH, URGENT)

startAt

ZonedDateTime startAt

Optional planned start time

status

String status

Status

taskListUid

String taskListUid

Task list uid that this task belongs to (optional)

type

String type

Type of task (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.task.TaskRequest

class TaskRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

completedAt

ZonedDateTime completedAt

description

String description

dueAt

ZonedDateTime dueAt

images

List<String> images

Task images (URLs)

name

String name

order

Integer order

priority

String priority

startAt

ZonedDateTime startAt

status

String status

taskListUid

String taskListUid

Class com.bytedesk.core.task.TaskResponse

class TaskResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

commentCount

Integer commentCount

Comment count

completedAt

ZonedDateTime completedAt

description

String description

dueAt

ZonedDateTime dueAt

favoriteCount

Integer favoriteCount

Favorite/collect count

favorited

Boolean favorited

Whether current user favorited/collected this task

images

List<String> images

Task images (URLs)

likeCount

Integer likeCount

Like count

liked

Boolean liked

Whether current user liked this task

name

String name

order

Integer order

priority

String priority

startAt

ZonedDateTime startAt

status

String status

taskListUid

String taskListUid

type

String type

Package com.bytedesk.core.task_comment

Class com.bytedesk.core.task_comment.TaskCommentEntity

class TaskCommentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

Comment content

images

List<String> images

Optional images for this comment

taskUid

String taskUid

Task uid that this comment belongs to

Class com.bytedesk.core.task_comment.TaskCommentRequest

class TaskCommentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

Comment content

images

List<String> images

Optional images

taskUid

String taskUid

Class com.bytedesk.core.task_comment.TaskCommentResponse

class TaskCommentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

images

List<String> images

taskUid

String taskUid

Package com.bytedesk.core.task_comment.event

Class com.bytedesk.core.task_comment.event.AbstractTaskCommentEvent

class AbstractTaskCommentEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

task_comment

TaskCommentEntity task_comment

Class com.bytedesk.core.task_comment.event.TaskCommentCreateEvent

class TaskCommentCreateEvent extends AbstractTaskCommentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task_comment.event.TaskCommentDeleteEvent

class TaskCommentDeleteEvent extends AbstractTaskCommentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task_comment.event.TaskCommentUpdateEvent

class TaskCommentUpdateEvent extends AbstractTaskCommentEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.task_list

Class com.bytedesk.core.task_list.TaskListEntity

class TaskListEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

archived

Boolean archived

Whether this list is archived (hidden from default views)

color

String color

Color theme for the task list display

description

String description

Description of the task_list

name

String name

Name of the task_list

order

Integer order

Display order

type

String type

Type of task_list (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.core.task_list.TaskListRequest

class TaskListRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

archived

Boolean archived

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.core.task_list.TaskListResponse

class TaskListResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

archived

Boolean archived

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.core.task_list.event

Class com.bytedesk.core.task_list.event.AbstractTaskListEvent

class AbstractTaskListEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taskList

TaskListEntity taskList

Class com.bytedesk.core.task_list.event.TaskListCreateEvent

class TaskListCreateEvent extends AbstractTaskListEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task_list.event.TaskListDeleteEvent

class TaskListDeleteEvent extends AbstractTaskListEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task_list.event.TaskListUpdateEvent

class TaskListUpdateEvent extends AbstractTaskListEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.task.event

Class com.bytedesk.core.task.event.AbstractTaskEvent

class AbstractTaskEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

task

TaskEntity task

Class com.bytedesk.core.task.event.TaskCreateEvent

class TaskCreateEvent extends AbstractTaskEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task.event.TaskDeleteEvent

class TaskDeleteEvent extends AbstractTaskEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.task.event.TaskUpdateEvent

class TaskUpdateEvent extends AbstractTaskEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.thread

Class com.bytedesk.core.thread.AbstractThreadEntity

class AbstractThreadEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

一对一客服对话中，存储客服信息

assistants

List<String> assistants

channel

String channel

closeType

String closeType

content

String content

extra

String extra

fold

Boolean fold

hide

Boolean hide

invites

List<String> invites

monitors

List<String> monitors

mute

Boolean mute

note

String note

owner

UserEntity owner

processEntityUid

String processEntityUid

processInstanceId

String processInstanceId

robot

String robot

star

Integer star

status

String status

tagList

List<String> tagList

ticketors

List<String> ticketors

top

Boolean top

topic

@NotBlank String topic

transfer

String transfer

transferStatus

String transferStatus

type

String type

unread

Boolean unread

user

String user

在客服会话中，存储访客信息 在同事会话中，存储同事信息 在用户私聊中，存储对方用户信息 机器人会话中，存储访客信息 群组会话中，存储群组信息 注意：h2 db 不能使用 user, 所以重定义为 thread_user

workflow

String workflow

workgroup

String workgroup

Class com.bytedesk.core.thread.ActiveThreadCache

class ActiveThreadCache extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

extra

String extra

会话 extra（包含 ServiceSettings 配置）

orgUid

String orgUid

组织 UID

status

String status

会话状态

topic

String topic

会话 Topic

type

String type

会话类型: AGENT, WORKGROUP, ROBOT

uid

String uid

会话 UID

updatedAtMillis

Long updatedAtMillis

最后更新时间戳（毫秒）

Class com.bytedesk.core.thread.ThreadEntity

class ThreadEntity extends AbstractThreadEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

messages

List<MessageEntity> messages

Messages associated with this conversation thread One-to-many relationship: one thread can have multiple messages

Class com.bytedesk.core.thread.ThreadExcel

class ThreadExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

agentNickname

String agentNickname

channel

String channel

createdAt

ZonedDateTime createdAt

robotNickname

String robotNickname

status

String status

visitorNickname

String visitorNickname

workgroupNickname

String workgroupNickname

Class com.bytedesk.core.thread.ThreadExtra

class ThreadExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.ThreadProtobuf

class ThreadProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

ChannelEnum channel

extra

String extra

status

ThreadProcessStatusEnum status

topic

String topic

type

ThreadTypeEnum type

uid

String uid

user

UserProtobuf user

Class com.bytedesk.core.thread.ThreadRequest

class ThreadRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

agentNickname

String agentNickname

assistantUids

List<String> assistantUids

closeType

String closeType

componentType

String componentType

fold

Boolean fold

forceNew

Boolean forceNew

hide

Boolean hide

inviteStatus

String inviteStatus

inviteUids

List<String> inviteUids

memberUids

List<String> memberUids

mergeByTopic

Boolean mergeByTopic

monitorUids

List<String> monitorUids

mute

Boolean mute

note

String note

offline

Boolean offline

ownerNickname

String ownerNickname

ownerUid

String ownerUid

processEntityUid

String processEntityUid

processInstanceId

String processInstanceId

robot

String robot

robotNickname

String robotNickname

star

Integer star

status

String status

tagList

List<String> tagList

ticketorUids

List<String> ticketorUids

top

Boolean top

topic

String topic

topicList

List<String> topicList

transfer

String transfer

transferStatus

String transferStatus

unread

Boolean unread

unsubscribe

Boolean unsubscribe

user

UserProtobuf user

userNickname

String userNickname

workgroup

String workgroup

workgroupNickname

String workgroupNickname

Class com.bytedesk.core.thread.ThreadResponse

class ThreadResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

agentMessageCount

Integer agentMessageCount

allMessageCount

Integer allMessageCount

assistants

List<UserProtobuf> assistants

channel

String channel

closeType

String closeType

content

String content

extra

String extra

fold

Boolean fold

hide

Boolean hide

invites

List<UserProtobuf> invites

inviteStatus

String inviteStatus

monitors

List<UserProtobuf> monitors

mute

Boolean mute

note

String note

offline

Boolean offline

owner

UserProtobuf owner

processEntityUid

String processEntityUid

processInstanceId

String processInstanceId

robot

String robot

robotMessageCount

Integer robotMessageCount

robotToAgent

Boolean robotToAgent

star

Integer star

status

String status

systemMessageCount

Integer systemMessageCount

tagList

List<String> tagList

ticketors

List<UserProtobuf> ticketors

top

Boolean top

topic

String topic

transfer

UserProtobuf transfer

transferStatus

String transferStatus

type

String type

unread

Boolean unread

unreadCount

Integer unreadCount

user

UserProtobuf user

valid

Boolean valid

visitorMessageCount

Integer visitorMessageCount

visitorUnreadCount

Integer visitorUnreadCount

workgroup

String workgroup

Class com.bytedesk.core.thread.ThreadResponseSimple

class ThreadResponseSimple extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

channel

String channel

closeType

String closeType

content

String content

extra

String extra

fold

Boolean fold

hide

Boolean hide

mute

Boolean mute

note

String note

owner

UserProtobuf owner

star

Integer star

status

String status

top

Boolean top

topic

String topic

type

String type

unread

Boolean unread

user

UserProtobuf user

workgroup

String workgroup

Package com.bytedesk.core.thread.event

Class com.bytedesk.core.thread.event.AbstractThreadEvent

class AbstractThreadEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

thread

ThreadEntity thread

Class com.bytedesk.core.thread.event.ThreadAcceptEvent

class ThreadAcceptEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadAddTopicEvent

class ThreadAddTopicEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadAgentOfflineEvent

class ThreadAgentOfflineEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadCloseEvent

class ThreadCloseEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadCreateEvent

class ThreadCreateEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadProcessCreateEvent

class ThreadProcessCreateEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadRemoveTopicEvent

class ThreadRemoveTopicEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadTransferToAgentEvent

class ThreadTransferToAgentEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.thread.event.ThreadUpdateEvent

class ThreadUpdateEvent extends AbstractThreadEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.topic

Class com.bytedesk.core.topic.TopicEntity

class TopicEntity extends BaseEntityNoOrg implements Serializable

serialVersionUID:

1L

Serialized Fields

clientIds

Set<String> clientIds

current online clientIds 用户clientId格式: uid/client/deviceUid

topics

Set<String> topics

为防止后添加的记录，clientIds缺失，所以用数组代替，这样每个用户在topic中只有一条记录，clientIds可共用

Class com.bytedesk.core.topic.TopicRequest

class TopicRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

clientIds

Set<String> clientIds

topic

String topic

topics

Set<String> topics

Class com.bytedesk.core.topic.TopicResponse

class TopicResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

clientIds

Set<String> clientIds

topics

Set<String> topics

Package com.bytedesk.core.topic.event

Class com.bytedesk.core.topic.event.TopicCreateEvent

class TopicCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

topic

String topic

userUid

String userUid

Class com.bytedesk.core.topic.event.TopicUpdateEvent

class TopicUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

topic

String topic

userUid

String userUid

Package com.bytedesk.core.translate

Class com.bytedesk.core.translate.TranslateEntity

class TranslateEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

fromLanguage

String fromLanguage

msgUid

String msgUid

originalText

String originalText

provider

String provider

toLanguage

String toLanguage

translatedText

String translatedText

Class com.bytedesk.core.translate.TranslateRequest

class TranslateRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

fromLanguage

String fromLanguage

msgUid

String msgUid

originalText

String originalText

provider

String provider

toLanguage

String toLanguage

translatedText

String translatedText

Class com.bytedesk.core.translate.TranslateResponse

class TranslateResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

detectedLanguage

String detectedLanguage

fromLanguage

String fromLanguage

msgUid

String msgUid

originalText

String originalText

provider

String provider

toLanguage

String toLanguage

translatedText

String translatedText

Package com.bytedesk.core.translate.event

Class com.bytedesk.core.translate.event.TranslateCreateEvent

class TranslateCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

translate

TranslateEntity translate

Package com.bytedesk.core.uid

Class com.bytedesk.core.uid.UidGeneratorEntity

class UidGeneratorEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

host

String host

Type of CONTAINER: HostName, ACTUAL : IP.

launchDate

Date launchDate

Worker launch date, default now

port

String port

Type of CONTAINER: Port, ACTUAL : Timestamp + Random(0-10000)

type

Integer type

type of WorkerNodeType

Package com.bytedesk.core.uid.exception

Exception com.bytedesk.core.uid.exception.UidGenerateException

class UidGenerateException extends RuntimeException implements Serializable

serialVersionUID:

-27048199131316992L

Package com.bytedesk.core.uid.utils

Class com.bytedesk.core.uid.utils.PaddedAtomicLong

class PaddedAtomicLong extends AtomicLong implements Serializable

serialVersionUID:

-3415778863941386253L

Serialized Fields

p1

long p1

Padded 6 long (48 bytes)

p2

long p2

Padded 6 long (48 bytes)

p3

long p3

Padded 6 long (48 bytes)

p4

long p4

Padded 6 long (48 bytes)

p5

long p5

Padded 6 long (48 bytes)

p6

long p6

Padded 6 long (48 bytes)

Package com.bytedesk.core.upload

Class com.bytedesk.core.upload.UploadEntity

class UploadEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

Associated category UID for file organization

channel

String channel

Client platform from which the file was uploaded (WEB, MOBILE, etc.)

extra

String extra

Additional upload information stored as JSON format

fileName

String fileName

Original filename of the uploaded file

fileSize

String fileSize

Size of the uploaded file in bytes or human-readable format

fileType

String fileType

MIME type or file extension of the uploaded file

fileUrl

String fileUrl

URL or path to access the uploaded file

kbUid

String kbUid

Associated knowledge base UID if file is part of a knowledge base

status

String status

Current status of the upload (UPLOADED, PROCESSING, FAILED, etc.)

type

String type

Type of upload (LLM, IMAGE, DOCUMENT, etc.)

user

String user

User information who uploaded the file stored as JSON string

Class com.bytedesk.core.upload.UploadExcel

class UploadExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

channel

String channel

createdAt

String createdAt

extra

String extra

fileName

String fileName

fileSize

String fileSize

fileType

String fileType

fileUrl

String fileUrl

kbUid

String kbUid

status

String status

type

String type

user

String user

Class com.bytedesk.core.upload.UploadRequest

class UploadRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

addWatermark

Boolean addWatermark

categoryUid

String categoryUid

extra

String extra

fileName

String fileName

fileSize

String fileSize

fileType

String fileType

fileUrl

String fileUrl

isAvatar

Boolean isAvatar

kbType

String kbType

kbUid

String kbUid

nickname

String nickname

status

UploadStatusEnum status

user

String user

visitorAvatar

String visitorAvatar

visitorNickname

String visitorNickname

visitorUid

String visitorUid

watermarkColor

String watermarkColor

watermarkFontSize

Integer watermarkFontSize

watermarkPosition

String watermarkPosition

watermarkText

String watermarkText

Class com.bytedesk.core.upload.UploadResponse

class UploadResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

channel

ChannelEnum channel

docIdList

List<String> docIdList

extra

String extra

fileName

String fileName

fileSize

String fileSize

fileType

String fileType

fileUrl

String fileUrl

kbUid

String kbUid

status

UploadStatusEnum status

type

UploadTypeEnum type

user

String user

Package com.bytedesk.core.upload.event

Class com.bytedesk.core.upload.event.AbstractUploadEvent

class AbstractUploadEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

upload

UploadEntity upload

Class com.bytedesk.core.upload.event.UploadCreateEvent

class UploadCreateEvent extends AbstractUploadEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.upload.event.UploadUpdateEvent

class UploadUpdateEvent extends AbstractUploadEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.upload.storage

Exception com.bytedesk.core.upload.storage.UploadStorageException

class UploadStorageException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

应用层错误码（用于 JsonResult.code），不等同于 HTTP 状态码。 约定： - 400 参数/请求错误 - 404 资源不存在（如本地文件不存在） - 413 文件过大 - 415 不支持的媒体类型 - 422 内容校验失败（如伪造图片） - 503 存储服务不可用 - 500 服务端内部错误

Exception com.bytedesk.core.upload.storage.UploadStorageFileNotFoundException

class UploadStorageFileNotFoundException extends UploadStorageException implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.url

Class com.bytedesk.core.url.UrlEntity

class UrlEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

shortUrl

String shortUrl

url

String url

Class com.bytedesk.core.url.UrlRequest

class UrlRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

url

String url

Class com.bytedesk.core.url.UrlResponse

class UrlResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

qrcodeUrl

String qrcodeUrl

shortUrl

String shortUrl

url

String url

userUid

String userUid

Package com.bytedesk.core.utils

Class com.bytedesk.core.utils.JsonResult

class JsonResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

data

T data

message

String message

Class com.bytedesk.core.utils.JwtSubject

class JwtSubject extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

platform

String platform

username

String username

Package com.bytedesk.core.webhook

Class com.bytedesk.core.webhook.WebhookEntity

class WebhookEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

messageTypes

List<String> messageTypes

name

String name

secret

String secret

type

String type

url

String url

Class com.bytedesk.core.webhook.WebhookRequest

class WebhookRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

messageTypes

List<String> messageTypes

name

String name

secret

String secret

url

String url

Class com.bytedesk.core.webhook.WebhookResponse

class WebhookResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

messageTypes

List<String> messageTypes

name

String name

secret

String secret

type

String type

url

String url

Package com.bytedesk.core.webhook_message

Class com.bytedesk.core.webhook_message.WebhookMessageEntity

class WebhookMessageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

errorMessage

String errorMessage

messageType

String messageType

messageUid

String messageUid

receiverName

String receiverName

receiverUid

String receiverUid

responseCode

Integer responseCode

responseMessage

String responseMessage

retryCount

Integer retryCount

senderName

String senderName

senderUid

String senderUid

success

Boolean success

threadUid

String threadUid

type

WebhookMessageTypeEnum type

url

String url

webhook

WebhookEntity webhook

webhookName

String webhookName

webhookType

String webhookType

webhookUid

String webhookUid

Class com.bytedesk.core.webhook_message.WebhookMessageRequest

class WebhookMessageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

secret

String secret

url

String url

Class com.bytedesk.core.webhook_message.WebhookMessageResponse

class WebhookMessageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

secret

String secret

type

String type

url

String url

Package com.bytedesk.core.webhook_message.event

Class com.bytedesk.core.webhook_message.event.WebhookMessageCreateEvent

class WebhookMessageCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookMessageEntity webhook

Class com.bytedesk.core.webhook_message.event.WebhookmessageeleteEvent

class WebhookmessageeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookMessageEntity webhook

Class com.bytedesk.core.webhook_message.event.WebhookMessageUpdateEvent

class WebhookMessageUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookMessageEntity webhook

Package com.bytedesk.core.webhook.event

Class com.bytedesk.core.webhook.event.WebhookCreateEvent

class WebhookCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookEntity webhook

Class com.bytedesk.core.webhook.event.WebhookDeleteEvent

class WebhookDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookEntity webhook

Class com.bytedesk.core.webhook.event.WebhookUpdateEvent

class WebhookUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webhook

WebhookEntity webhook

Package com.bytedesk.core.workflow

Class com.bytedesk.core.workflow.WorkflowEntity

class WorkflowEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

categoryUid

String categoryUid

currentNodeId

String currentNodeId

description

String description

edges

List<WorkflowEdgeEntity> edges

nickname

String nickname

nodes

List<WorkflowNodeEntity> nodes

schema

String schema

status

String status

type

String type

Class com.bytedesk.core.workflow.WorkflowRequest

class WorkflowRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

categoryUid

String categoryUid

currentNode

String currentNode

description

String description

edgeUids

List<String> edgeUids

nickname

String nickname

nodeUids

List<String> nodeUids

schema

String schema

status

String status

Class com.bytedesk.core.workflow.WorkflowResponse

class WorkflowResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

categoryUid

String categoryUid

currentNode

String currentNode

description

String description

edges

List<WorkflowEdgeResponse> edges

nickname

String nickname

nodes

List<WorkflowNodeResponse> nodes

schema

String schema

status

String status

type

String type

Class com.bytedesk.core.workflow.WorkflowSchema

class WorkflowSchema extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

edges

List<WorkflowEdge> edges

边列表

nodes

List<WorkflowBaseNode> nodes

节点列表

Package com.bytedesk.core.workflow_edge

Class com.bytedesk.core.workflow_edge.WorkflowEdgeEntity

class WorkflowEdgeEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

conditionExpression

String conditionExpression

条件表达式（用于条件边）

defaultBranch

Boolean defaultBranch

是否为默认分支（用于 Exclusive/Inclusive 网关的 default 出边）

description

String description

边描述

edgeData

String edgeData

边完整配置数据（JSON格式存储WorkflowEdge的完整数据） 包含：data(EdgeData), 自定义属性等

enabled

Boolean enabled

是否启用该边

executionCount

Long executionCount

边执行次数

executionResult

String executionResult

边执行结果数据（JSON格式）

lastExecutionTime

ZonedDateTime lastExecutionTime

边最后执行时间

name

String name

边名称

sourceNodeId

String sourceNodeId

源节点ID

sourcePortId

String sourcePortId

源端口ID（可选，用于多端口节点）

styleConfig

String styleConfig

边的样式配置（JSON格式，包含颜色、线型等）

targetNodeId

String targetNodeId

目标节点ID

targetPortId

String targetPortId

目标端口ID（可选，用于多端口节点）

type

String type

边类型 (DEFAULT, CONDITION, LOOP, DATA, CONTROL, ERROR, etc.)

weight

Integer weight

边的权重或优先级

workflow

WorkflowEntity workflow

关联的工作流

Class com.bytedesk.core.workflow_edge.WorkflowEdgeRequest

class WorkflowEdgeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

conditionExpression

String conditionExpression

条件表达式（用于条件边）

description

String description

边描述

edgeData

String edgeData

边完整配置数据（JSON格式）

edgeType

String edgeType

边类型 (DEFAULT, CONDITION, LOOP, DATA, CONTROL, ERROR, etc.)

enabled

Boolean enabled

是否启用该边

executionResult

String executionResult

边执行结果数据（JSON格式）

name

String name

边名称

sourceNodeId

String sourceNodeId

源节点ID

sourcePortId

String sourcePortId

源端口ID（可选，用于多端口节点）

styleConfig

String styleConfig

边的样式配置（JSON格式）

targetNodeId

String targetNodeId

目标节点ID

targetPortId

String targetPortId

目标端口ID（可选，用于多端口节点）

weight

Integer weight

边的权重或优先级

workflowUid

String workflowUid

关联的工作流UID

Class com.bytedesk.core.workflow_edge.WorkflowEdgeResponse

class WorkflowEdgeResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

conditionExpression

String conditionExpression

条件表达式（用于条件边）

description

String description

边描述

edgeData

String edgeData

边完整配置数据（JSON格式）

edgeType

String edgeType

边类型 (DEFAULT, CONDITION, LOOP, DATA, CONTROL, ERROR, etc.)

enabled

Boolean enabled

是否启用该边

executionCount

Long executionCount

边执行次数

executionResult

String executionResult

边执行结果数据（JSON格式）

isConditionalEdge

Boolean isConditionalEdge

是否为条件边

isControlEdge

Boolean isControlEdge

是否为控制边

isDataEdge

Boolean isDataEdge

是否为数据边

lastExecutionTime

ZonedDateTime lastExecutionTime

边最后执行时间

name

String name

边名称

sourceNodeId

String sourceNodeId

源节点ID

sourcePortId

String sourcePortId

源端口ID（可选，用于多端口节点）

styleConfig

String styleConfig

边的样式配置（JSON格式）

targetNodeId

String targetNodeId

目标节点ID

targetPortId

String targetPortId

目标端口ID（可选，用于多端口节点）

weight

Integer weight

边的权重或优先级

workflowUid

String workflowUid

关联的工作流UID

Package com.bytedesk.core.workflow_edge.event

Class com.bytedesk.core.workflow_edge.event.WorkflowEdgeCreateEvent

class WorkflowEdgeCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_edge

WorkflowEdgeEntity workflow_edge

Class com.bytedesk.core.workflow_edge.event.WorkflowEdgeDeleteEvent

class WorkflowEdgeDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_edge

WorkflowEdgeEntity workflow_edge

Class com.bytedesk.core.workflow_edge.event.WorkflowEdgeUpdateEvent

class WorkflowEdgeUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_edge

WorkflowEdgeEntity workflow_edge

Package com.bytedesk.core.workflow_log

Class com.bytedesk.core.workflow_log.WorkflowLogEntity

class WorkflowLogEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

durationMs

Long durationMs

errorMessage

String errorMessage

errorStacktrace

String errorStacktrace

executionUid

String executionUid

inputPayload

String inputPayload

name

String name

nodeName

String nodeName

nodeStatus

String nodeStatus

nodeType

String nodeType

nodeUid

String nodeUid

outputPayload

String outputPayload

sequence

Integer sequence

type

String type

workflowUid

String workflowUid

Class com.bytedesk.core.workflow_log.WorkflowLogRequest

class WorkflowLogRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

executionUid

String executionUid

name

String name

nodeName

String nodeName

nodeStatus

String nodeStatus

nodeType

String nodeType

nodeUid

String nodeUid

sequence

Integer sequence

workflowUid

String workflowUid

Class com.bytedesk.core.workflow_log.WorkflowLogResponse

class WorkflowLogResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

durationMs

Long durationMs

errorMessage

String errorMessage

errorStacktrace

String errorStacktrace

executionUid

String executionUid

inputPayload

String inputPayload

name

String name

nodeName

String nodeName

nodeStatus

String nodeStatus

nodeType

String nodeType

nodeUid

String nodeUid

outputPayload

String outputPayload

sequence

Integer sequence

type

String type

workflowUid

String workflowUid

Package com.bytedesk.core.workflow_log.event

Class com.bytedesk.core.workflow_log.event.WorkflowLogCreateEvent

class WorkflowLogCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

WorkflowLogEntity tag

Class com.bytedesk.core.workflow_log.event.WorkflowLogDeleteEvent

class WorkflowLogDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

WorkflowLogEntity tag

Class com.bytedesk.core.workflow_log.event.WorkflowLogUpdateEvent

class WorkflowLogUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

WorkflowLogEntity tag

Package com.bytedesk.core.workflow_node

Class com.bytedesk.core.workflow_node.WorkflowNodeEntity

class WorkflowNodeEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

节点描述

enabled

Boolean enabled

是否启用该节点

errorMessage

String errorMessage

节点执行错误信息

executionEndTime

ZonedDateTime executionEndTime

节点执行结束时间

executionResult

String executionResult

节点执行结果数据（JSON格式）

executionStartTime

ZonedDateTime executionStartTime

节点执行开始时间

name

String name

节点名称

nodeData

String nodeData

节点完整配置数据（JSON格式存储WorkflowBaseNode及其子类的完整数据） 包含：data(NodeData), meta(WorkflowNodeMeta), 特定节点类型字段等

parentNodeUid

String parentNodeUid

父节点UID（用于组织节点层次结构）

sortOrder

Integer sortOrder

节点在工作流中的执行顺序

status

String status

节点状态 (IDLE, RUNNING, SUCCESS, FAILED, WAITING)

type

String type

节点类型 (START, END, CONDITION, LOOP, LLM, TEXT, COMMENT, GROUP)

workflow

WorkflowEntity workflow

关联的工作流

Class com.bytedesk.core.workflow_node.WorkflowNodeRequest

class WorkflowNodeRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

节点描述

enabled

Boolean enabled

是否启用该节点

errorMessage

String errorMessage

节点执行错误信息

executionResult

String executionResult

节点执行结果数据（JSON格式）

name

String name

节点名称

nodeData

String nodeData

节点完整配置数据（JSON格式存储WorkflowBaseNode及其子类的完整数据）

nodeStatus

String nodeStatus

节点状态 (IDLE, RUNNING, SUCCESS, FAILED, WAITING)

nodeType

String nodeType

节点类型 (START, END, CONDITION, LOOP, LLM, TEXT, COMMENT, GROUP)

parentNodeUid

String parentNodeUid

父节点UID（用于组织节点层次结构）

sortOrder

Integer sortOrder

节点在工作流中的执行顺序

workflowUid

String workflowUid

关联的工作流UID

Class com.bytedesk.core.workflow_node.WorkflowNodeResponse

class WorkflowNodeResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

节点描述

enabled

Boolean enabled

是否启用该节点

errorMessage

String errorMessage

节点执行错误信息

executionDurationMillis

Long executionDurationMillis

执行耗时（毫秒）

executionDurationSeconds

Double executionDurationSeconds

执行耗时（秒）

executionEndTime

ZonedDateTime executionEndTime

节点执行结束时间

executionResult

String executionResult

节点执行结果数据（JSON格式）

executionStartTime

ZonedDateTime executionStartTime

节点执行开始时间

isContainerNode

Boolean isContainerNode

是否为容器节点（GROUP, LOOP）

isControlNode

Boolean isControlNode

是否为控制节点（START, END, CONDITION）

isProcessingNode

Boolean isProcessingNode

是否为处理节点（LLM, TEXT）

name

String name

节点名称

nodeData

String nodeData

节点完整配置数据（JSON格式存储WorkflowBaseNode及其子类的完整数据）

nodeStatus

String nodeStatus

节点状态 (IDLE, RUNNING, SUCCESS, FAILED, WAITING)

nodeType

String nodeType

节点类型 (START, END, CONDITION, LOOP, LLM, TEXT, COMMENT, GROUP)

parentNodeUid

String parentNodeUid

父节点UID（用于组织节点层次结构）

sortOrder

Integer sortOrder

节点在工作流中的执行顺序

workflowUid

String workflowUid

关联的工作流UID

Package com.bytedesk.core.workflow_node.event

Class com.bytedesk.core.workflow_node.event.WorkflowNodeCreateEvent

class WorkflowNodeCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_node

WorkflowNodeEntity workflow_node

Class com.bytedesk.core.workflow_node.event.WorkflowNodeDeleteEvent

class WorkflowNodeDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_node

WorkflowNodeEntity workflow_node

Class com.bytedesk.core.workflow_node.event.WorkflowNodeUpdateEvent

class WorkflowNodeUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow_node

WorkflowNodeEntity workflow_node

Package com.bytedesk.core.workflow_variable

Class com.bytedesk.core.workflow_variable.WorkflowVariableEntity

class WorkflowVariableEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

变量描述

name

String name

变量名称

nodeUid

String nodeUid

所属节点UID

scope

String scope

变量作用域 - GLOBAL: 全局变量，在整个工作流中可见 - LOCAL: 局部变量，仅在当前节点可见 - SESSION: 会话变量，在整个会话过程中可见

system

Boolean system

是否为系统变量

type

String type

变量类型

value

String value

变量值（JSON格式）

workflowUid

String workflowUid

所属工作流实例UID

Class com.bytedesk.core.workflow_variable.WorkflowVariableRequest

class WorkflowVariableRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

变量描述

name

String name

变量名称

nodeUid

String nodeUid

节点UID

scope

String scope

变量作用域

value

String value

变量值（JSON格式）

workflowUid

String workflowUid

工作流UID

Class com.bytedesk.core.workflow_variable.WorkflowVariableResponse

class WorkflowVariableResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

变量描述

name

String name

变量名称

nodeUid

String nodeUid

节点UID

scope

String scope

变量作用域

value

Object value

变量值

workflowUid

String workflowUid

工作流UID

Package com.bytedesk.core.workflow.edge

Class com.bytedesk.core.workflow.edge.WorkflowEdge

class WorkflowEdge extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

conditionExpression

String conditionExpression

条件表达式（用于条件边）

data

WorkflowEdge.EdgeData data

边的数据部分

description

String description

边的描述（可选）

id

String id

边的唯一标识符

label

String label

边的标签（可选）

name

String name

边的名称

sourceNodeID

String sourceNodeID

源节点ID

sourcePortID

String sourcePortID

源端口ID（可选，用于多端口节点）

style

WorkflowEdge.EdgeStyle style

边的样式配置

targetNodeID

String targetNodeID

目标节点ID

targetPortID

String targetPortID

目标端口ID（可选，用于多端口节点）

type

String type

边的类型（可选）

weight

Integer weight

边的权重或优先级（可选）

Class com.bytedesk.core.workflow.edge.WorkflowEdge.EdgeData

class EdgeData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,String> attributes

自定义属性

config

Map<String,Object> config

边的配置数据

properties

Map<String,Object> properties

可以存储任意边相关的数据

Class com.bytedesk.core.workflow.edge.WorkflowEdge.EdgeStyle

class EdgeStyle extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

animated

Boolean animated

是否动画显示

arrowSize

Integer arrowSize

箭头大小

color

String color

边的颜色

opacity

Double opacity

边的透明度 (0.0 - 1.0)

showArrow

Boolean showArrow

是否显示箭头

strokeType

String strokeType

边的线型（solid, dashed, dotted）

strokeWidth

Integer strokeWidth

边的线宽

Package com.bytedesk.core.workflow.event

Class com.bytedesk.core.workflow.event.AbstractWorkflowEvent

class AbstractWorkflowEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workflow

WorkflowEntity workflow

Class com.bytedesk.core.workflow.event.WorkflowCreateEvent

class WorkflowCreateEvent extends AbstractWorkflowEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.workflow.event.WorkflowDeleteEvent

class WorkflowDeleteEvent extends AbstractWorkflowEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.workflow.event.WorkflowUpdateEvent

class WorkflowUpdateEvent extends AbstractWorkflowEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.core.workflow.node

Class com.bytedesk.core.workflow.node.DecisionDmnOptions

class DecisionDmnOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

decisionKey

String decisionKey

decisionVersion

String decisionVersion

hitPolicy

String hitPolicy

inputMapping

Map<String,String> inputMapping

outputMapping

Map<String,String> outputMapping

Class com.bytedesk.core.workflow.node.EventOptions

class EventOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

messageName

String messageName

signalName

String signalName

timerDefinition

String timerDefinition

timerDefinitionType

String timerDefinitionType

Class com.bytedesk.core.workflow.node.MultiInstanceOptions

class MultiInstanceOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

collectionExpression

String collectionExpression

completionCondition

String completionCondition

elementVariable

String elementVariable

parallel

Boolean parallel

Class com.bytedesk.core.workflow.node.ServiceTaskOptions

class ServiceTaskOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

async

Boolean async

backoffMillis

Long backoffMillis

delegateBeanName

String delegateBeanName

retry

Integer retry

timeoutMillis

Long timeoutMillis

Class com.bytedesk.core.workflow.node.UserTaskOptions

class UserTaskOptions extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

assignee

String assignee

candidateGroups

List<String> candidateGroups

candidateUsers

List<String> candidateUsers

dueDate

String dueDate

formKey

String formKey

Class com.bytedesk.core.workflow.node.WorkflowBaseNode

class WorkflowBaseNode extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

blocks

List<WorkflowBaseNode> blocks

子节点列表（用于group和loop节点）

data

WorkflowBaseNode.NodeData data

节点数据（表单数据）

description

String description

节点描述

edges

List<WorkflowEdge> edges

子节点间连线（用于group和loop节点）

id

String id

节点唯一标识

inEdges

List<WorkflowEdge> inEdges

入边列表

meta

WorkflowNodeMeta meta

节点元数据（UI相关配置）

name

String name

节点名称

outEdges

List<WorkflowEdge> outEdges

出边列表

status

String status

节点状态

type

String type

节点类型

Class com.bytedesk.core.workflow.node.WorkflowBaseNode.NodeData

class NodeData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

animation

String animation

用于group节点的动画

backgroundAttachment

String backgroundAttachment

用于group节点的背景附件

backgroundBlendMode

String backgroundBlendMode

用于group节点的背景混合模式

backgroundClip

String backgroundClip

用于group节点的背景裁剪

backgroundColor

String backgroundColor

用于group节点的背景色

backgroundImage

String backgroundImage

用于group节点的背景图片

backgroundOrigin

String backgroundOrigin

用于group节点的背景原点

backgroundPosition

String backgroundPosition

用于group节点的背景位置

backgroundRepeat

String backgroundRepeat

用于group节点的背景重复

backgroundSize

String backgroundSize

用于group节点的背景尺寸

borderColor

String borderColor

用于group节点的边框色

borderRadius

Integer borderRadius

用于group节点的圆角半径

borderWidth

Integer borderWidth

用于group节点的边框宽度

color

String color

用于group节点的颜色

content

String content

节点内容

cursor

String cursor

用于group节点的光标样式

display

String display

用于group节点的显示方式

filter

String filter

用于group节点的过滤器

fontColor

String fontColor

用于group节点的字体颜色

fontSize

Integer fontSize

用于group节点的字体大小

fontStyle

String fontStyle

用于group节点的字体样式

fontWeight

String fontWeight

用于group节点的字体粗细

height

Integer height

用于group节点的高度

inputs

Map<String,Object> inputs

输入配置

inputsValues

Map<String,Object> inputsValues

输入值映射

margin

String margin

用于group节点的外边距

maxHeight

Integer maxHeight

用于group节点的最大高度

maxWidth

Integer maxWidth

用于group节点的最大宽度

minHeight

Integer minHeight

用于group节点的最小高度

minWidth

Integer minWidth

用于group节点的最小宽度

mixBlendMode

String mixBlendMode

用于group节点的混合模式

note

String note

用于comment节点的注释内容

opacity

Double opacity

用于group节点的透明度

outputs

Map<String,Object> outputs

输出配置

overflow

String overflow

用于group节点的溢出处理

padding

String padding

用于group节点的内边距

pointerEvents

String pointerEvents

用于group节点的指针事件

position

String position

用于group节点的定位方式

properties

Map<String,Object> properties

扩展属性

shadow

String shadow

用于group节点的阴影

size

Map<String,Object> size

用于comment节点的尺寸信息

textAlign

String textAlign

用于group节点的文本对齐方式

title

String title

节点标题

transform

String transform

用于group节点的变换

transition

String transition

用于group节点的过渡效果

userSelect

String userSelect

用于group节点的用户选择

verticalAlign

String verticalAlign

用于group节点的垂直对齐方式

width

Integer width

用于group节点的宽度

zIndex

Integer zIndex

用于group节点的Z轴层级

Class com.bytedesk.core.workflow.node.WorkflowCommentNode

class WorkflowCommentNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

note

String note

size

Map<String,Object> size

Class com.bytedesk.core.workflow.node.WorkflowConditionNode

class WorkflowConditionNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

conditions

List<WorkflowConditionNode.ConditionItem> conditions

Class com.bytedesk.core.workflow.node.WorkflowEndNode

class WorkflowEndNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.workflow.node.WorkflowFormNode

class WorkflowFormNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultValue

String defaultValue

默认值

formType

String formType

表单类型: label, text, digit, date, select, checkbox, radio

label

String label

表单字段标签

options

List<WorkflowFormNode.FormOption> options

选项列表（用于select, checkbox, radio类型）

placeholder

String placeholder

表单字段占位符

required

Boolean required

是否必填

validations

List<WorkflowFormNode.FormValidation> validations

验证规则

Class com.bytedesk.core.workflow.node.WorkflowGroupNode

class WorkflowGroupNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Class com.bytedesk.core.workflow.node.WorkflowLLMNode

class WorkflowLLMNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

modelType

String modelType

prompt

String prompt

systemPrompt

String systemPrompt

temperature

Double temperature

Class com.bytedesk.core.workflow.node.WorkflowLoopNode

class WorkflowLoopNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

loopTimes

Integer loopTimes

Class com.bytedesk.core.workflow.node.WorkflowNodeMeta

class WorkflowNodeMeta extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

addable

Boolean addable

是否可添加

addDisable

Boolean addDisable

是否禁用添加

autoResizeDisable

Boolean autoResizeDisable

是否禁用自动调整大小

canvasPosition

WorkflowNodeMeta.Position canvasPosition

子画布位置

copyDisable

Boolean copyDisable

是否禁用复制

defaultCollapsed

Boolean defaultCollapsed

默认是否折叠

defaultExpanded

Boolean defaultExpanded

默认是否展开

defaultPorts

Map<String,Object> defaultPorts

默认点位

deleteDisable

Boolean deleteDisable

是否禁用删除

draggable

Boolean draggable

是否可拖拽

expandable

Boolean expandable

是否可展开

extra

Map<String,Object> extra

扩展属性

hidden

Boolean hidden

是否隐藏

inlineSpacingAfter

Integer inlineSpacingAfter

行内块后置间距

inlineSpacingPre

Integer inlineSpacingPre

行内块前置间距

inputDisable

Boolean inputDisable

是否禁用输入点

isContainer

Boolean isContainer

是否为容器节点

isInlineBlocks

Boolean isInlineBlocks

是否为行内块

isNodeEnd

Boolean isNodeEnd

是否为节点结束

isStart

Boolean isStart

是否为开始节点

minInlineBlockSpacing

Integer minInlineBlockSpacing

最小行内块间距

outputDisable

Boolean outputDisable

是否禁用输出点

padding

WorkflowNodeMeta.Padding padding

内边距

position

WorkflowNodeMeta.Position position

节点位置信息

renderKey

String renderKey

渲染键

selectable

Boolean selectable

是否可选择

size

WorkflowNodeMeta.Size size

节点尺寸

spacing

Integer spacing

间距

subCanvas

Map<String,Object> subCanvas

子画布配置

useDynamicPort

Boolean useDynamicPort

使用动态点位

Class com.bytedesk.core.workflow.node.WorkflowNodeMeta.Padding

class Padding extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bottom

Integer bottom

下边距

left

Integer left

左边距

right

Integer right

右边距

top

Integer top

上边距

Class com.bytedesk.core.workflow.node.WorkflowNodeMeta.Position

class Position extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

x

Double x

X坐标

y

Double y

Y坐标

Class com.bytedesk.core.workflow.node.WorkflowNodeMeta.Size

class Size extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

height

Double height

高度

width

Double width

宽度

Class com.bytedesk.core.workflow.node.WorkflowParentNode

class WorkflowParentNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

children

List<WorkflowBaseNode> children

子节点列表

description

String description

容器描述

expandable

Boolean expandable

是否可展开

expanded

Boolean expanded

是否展开状态

title

String title

容器标题

Class com.bytedesk.core.workflow.node.WorkflowStartNode

class WorkflowStartNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Class com.bytedesk.core.workflow.node.WorkflowTextNode

class WorkflowTextNode extends WorkflowBaseNode implements Serializable

serialVersionUID:

1L

Serialized Fields

text

String text

Package com.bytedesk.douyin.app

Class com.bytedesk.douyin.app.DouyinAppEntity

class DouyinAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

Douyin access token for API authentication Valid for 2 hours, requires periodic refresh

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

Expiration timestamp for the access token

appId

String appId

Douyin application ID (app_id)

appSecret

String appSecret

Douyin application secret key

debug

Boolean debug

description

String description

Description of the Douyin application

enabled

Boolean enabled

Whether the Douyin application is enabled

encodingAesKey

String encodingAesKey

Douyin application encoding AES key for message encryption

name

String name

Name of the Douyin application

token

String token

Douyin application token for webhook verification

type

String type

Type of Douyin application (MP, MINI, WORK)

url

String url

Douyin application URL for webhook configuration

workgroupUid

String workgroupUid

Associated workgroup UID for customer service routing

Class com.bytedesk.douyin.app.DouyinAppRequest

class DouyinAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.douyin.app.DouyinAppResponse

class DouyinAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

debug

Boolean debug

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.douyin.app.event

Class com.bytedesk.douyin.app.event.AbstractDouyinAppEvent

class AbstractDouyinAppEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

DouyinAppEntity app

Class com.bytedesk.douyin.app.event.DouyinAppCreateEvent

class DouyinAppCreateEvent extends AbstractDouyinAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.douyin.app.event.DouyinAppDeleteEvent

class DouyinAppDeleteEvent extends AbstractDouyinAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.douyin.app.event.DouyinAppUpdateEvent

class DouyinAppUpdateEvent extends AbstractDouyinAppEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.douyin.comment

Class com.bytedesk.douyin.comment.DouyinCommentEntity

class DouyinCommentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.comment.DouyinCommentRequest

class DouyinCommentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.comment.DouyinCommentResponse

class DouyinCommentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.douyin.dian

Class com.bytedesk.douyin.dian.DouyinDianEntity

class DouyinDianEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.dian.DouyinDianRequest

class DouyinDianRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.dian.DouyinDianResponse

class DouyinDianResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.douyin.mini

Class com.bytedesk.douyin.mini.DouyinMiniEntity

class DouyinMiniEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.mini.DouyinMiniRequest

class DouyinMiniRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.mini.DouyinMiniResponse

class DouyinMiniResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.douyin.mini.DouyinWebhookVerification

class DouyinWebhookVerification extends Object implements Serializable

Serialized Fields

clientKey

String clientKey

content

DouyinWebhookVerification.Content content

event

String event

Package com.bytedesk.forum.exception

Exception com.bytedesk.forum.exception.ForumException

class ForumException extends RuntimeException implements Serializable

Package com.bytedesk.forum.post

Class com.bytedesk.forum.post.PostEntity

class PostEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

category

CategoryEntity category

Category that the post belongs to

commentCount

Integer commentCount

Number of comments on the post

content

String content

Main content of the forum post

likeCount

Integer likeCount

Number of likes received on the post

status

String status

Current status of the post (draft, published, deleted)

title

String title

Title of the forum post

userId

Long userId

ID of the user who created the post

viewCount

Integer viewCount

Number of times the post has been viewed

Package com.bytedesk.kanban.module

Class com.bytedesk.kanban.module.ModuleEntity

class ModuleEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

isPublic

boolean isPublic

members

List<MemberEntity> members

name

String name

order

int order

projectUid

String projectUid

todoLists

List<TodoListEntity> todoLists

type

String type

Class com.bytedesk.kanban.module.ModuleRequest

class ModuleRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

isPublic

Boolean isPublic

memberUids

List<String> memberUids

name

String name

order

Integer order

projectUid

String projectUid

todoListUids

List<String> todoListUids

Class com.bytedesk.kanban.module.ModuleResponse

class ModuleResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

isPublic

Boolean isPublic

members

List<MemberProtobuf> members

name

String name

order

Integer order

projectUid

String projectUid

todoLists

List<TodoListResponse> todoLists

type

String type

userUid

String userUid

Package com.bytedesk.kanban.module.event

Class com.bytedesk.kanban.module.event.ModuleCreateEvent

class ModuleCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ModuleEntity report

Class com.bytedesk.kanban.module.event.ModuleDeleteEvent

class ModuleDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ModuleEntity report

Class com.bytedesk.kanban.module.event.ModuleUpdateEvent

class ModuleUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ModuleEntity report

Package com.bytedesk.kanban.project

Class com.bytedesk.kanban.project.ProjectEntity

class ProjectEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

isPublic

boolean isPublic

members

List<MemberEntity> members

modules

List<ModuleEntity> modules

name

String name

order

int order

type

String type

Class com.bytedesk.kanban.project.ProjectRequest

class ProjectRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

isPublic

Boolean isPublic

memberUids

List<String> memberUids

modulesUids

List<String> modulesUids

name

String name

order

Integer order

Class com.bytedesk.kanban.project.ProjectResponse

class ProjectResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

isPublic

Boolean isPublic

members

List<MemberProtobuf> members

modules

List<ModuleResponse> modules

name

String name

order

Integer order

type

String type

Package com.bytedesk.kanban.project_invite

Class com.bytedesk.kanban.project_invite.ProjectInviteEntity

class ProjectInviteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

int order

type

String type

Class com.bytedesk.kanban.project_invite.ProjectInviteRequest

class ProjectInviteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.kanban.project_invite.ProjectInviteResponse

class ProjectInviteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.kanban.project_invite.event

Class com.bytedesk.kanban.project_invite.event.ProjectInviteCreateEvent

class ProjectInviteCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

project_invite

ProjectInviteEntity project_invite

Class com.bytedesk.kanban.project_invite.event.ProjectInviteDeleteEvent

class ProjectInviteDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

project_invite

ProjectInviteEntity project_invite

Class com.bytedesk.kanban.project_invite.event.ProjectInviteUpdateEvent

class ProjectInviteUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

project_invite

ProjectInviteEntity project_invite

Package com.bytedesk.kanban.project.event

Class com.bytedesk.kanban.project.event.ProjectCreateEvent

class ProjectCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ProjectEntity report

Class com.bytedesk.kanban.project.event.ProjectDeleteEvent

class ProjectDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ProjectEntity report

Class com.bytedesk.kanban.project.event.ProjectUpdateEvent

class ProjectUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ProjectEntity report

Package com.bytedesk.kanban.report

Class com.bytedesk.kanban.report.ReportEntity

class ReportEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

type

String type

Class com.bytedesk.kanban.report.ReportRequest

class ReportRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

Class com.bytedesk.kanban.report.ReportResponse

class ReportResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

type

String type

Package com.bytedesk.kanban.report.event

Class com.bytedesk.kanban.report.event.ReportCreateEvent

class ReportCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ReportEntity report

Class com.bytedesk.kanban.report.event.ReportDeleteEvent

class ReportDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ReportEntity report

Class com.bytedesk.kanban.report.event.ReportUpdateEvent

class ReportUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

report

ReportEntity report

Package com.bytedesk.kanban.todo_list

Class com.bytedesk.kanban.todo_list.TodoListEntity

class TodoListEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the todo list display

description

String description

Description of the todo list

moduleUid

String moduleUid

Associated module UID for module-specific todo lists

name

String name

Name of the todo list

order

int order

Display order of the todo list in the Kanban board

projectUid

String projectUid

Associated project UID for project-specific todo lists

tasks

List<TaskEntity> tasks

Tasks associated with this todo list

type

String type

Type of todo list (CUSTOMER, PROJECT, etc.)

Class com.bytedesk.kanban.todo_list.TodoListRequest

class TodoListRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

moduleUid

String moduleUid

name

String name

order

Integer order

projectUid

String projectUid

taskUids

List<String> taskUids

Class com.bytedesk.kanban.todo_list.TodoListResponse

class TodoListResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

moduleUid

String moduleUid

name

String name

order

Integer order

projectUid

String projectUid

tasks

List<TaskResponse> tasks

type

String type

Package com.bytedesk.kanban.todo_list.event

Class com.bytedesk.kanban.todo_list.event.TodoListCreateEvent

class TodoListCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

todo

TodoListEntity todo

Class com.bytedesk.kanban.todo_list.event.TodoListDeleteEvent

class TodoListDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

todo

TodoListEntity todo

Class com.bytedesk.kanban.todo_list.event.TodoListUpdateEvent

class TodoListUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

todo

TodoListEntity todo

Package com.bytedesk.kbase.article

Class com.bytedesk.kbase.article.AbstractArticleEntity

class AbstractArticleEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

auditOpinion

String auditOpinion

auditStatus

String auditStatus

auditUser

String auditUser

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

docIdList

List<String> docIdList

editor

String editor

elasticStatus

String elasticStatus

endDate

ZonedDateTime endDate

isPasswordProtected

Boolean isPasswordProtected

kbase

KbaseEntity kbase

likeCount

Integer likeCount

needAudit

Boolean needAudit

password

String password

published

Boolean published

readCount

Integer readCount

startDate

ZonedDateTime startDate

summary

String summary

tagList

List<String> tagList

title

String title

top

Boolean top

type

String type

user

String user

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.article.ArticleEntity

class ArticleEntity extends AbstractArticleEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.article.ArticleRequest

class ArticleRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

auditOpinion

String auditOpinion

auditStatus

String auditStatus

auditUser

String auditUser

categoryUid

String categoryUid

componentType

String componentType

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

editor

String editor

elasticStatus

String elasticStatus

endDate

ZonedDateTime endDate

kbUid

String kbUid

likeCount

Integer likeCount

needAudit

Boolean needAudit

published

Boolean published

readCount

Integer readCount

startDate

ZonedDateTime startDate

summary

String summary

tagList

List<String> tagList

title

String title

top

Boolean top

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.article.ArticleResponse

class ArticleResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

auditOpinion

String auditOpinion

auditStatus

String auditStatus

auditUser

String auditUser

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

editor

String editor

elasticStatus

String elasticStatus

endDate

ZonedDateTime endDate

kbUid

String kbUid

likeCount

Integer likeCount

needAudit

Boolean needAudit

published

Boolean published

readCount

Integer readCount

startDate

ZonedDateTime startDate

summary

String summary

tagList

List<String> tagList

title

String title

top

Boolean top

type

String type

user

UserProtobuf user

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.article_archive

Class com.bytedesk.kbase.article_archive.ArticleArchiveEntity

class ArticleArchiveEntity extends AbstractArticleEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.article_archive.ArticleArchiveRequest

class ArticleArchiveRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

auditOpinion

String auditOpinion

auditStatus

String auditStatus

auditUser

String auditUser

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

editor

String editor

endDate

ZonedDateTime endDate

kbUid

String kbUid

likeCount

Integer likeCount

needAudit

Boolean needAudit

published

Boolean published

readCount

Integer readCount

startDate

ZonedDateTime startDate

status

String status

summary

String summary

tagList

List<String> tagList

title

String title

top

Boolean top

Class com.bytedesk.kbase.article_archive.ArticleArchiveResponse

class ArticleArchiveResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

auditOpinion

String auditOpinion

auditStatus

String auditStatus

auditUser

String auditUser

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

editor

String editor

endDate

ZonedDateTime endDate

kbUid

String kbUid

likeCount

Integer likeCount

needAudit

Boolean needAudit

published

Boolean published

readCount

Integer readCount

startDate

ZonedDateTime startDate

status

String status

summary

String summary

tagList

List<String> tagList

title

String title

top

Boolean top

type

KbaseTypeEnum type

user

UserProtobuf user

Package com.bytedesk.kbase.article_archive.event

Class com.bytedesk.kbase.article_archive.event.ArticleArchiveCreateEvent

class ArticleArchiveCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

article_archive

ArticleArchiveEntity article_archive

Class com.bytedesk.kbase.article_archive.event.ArticleArchiveUpdateEvent

class ArticleArchiveUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

article_archive

ArticleArchiveEntity article_archive

Package com.bytedesk.kbase.article.elastic

Class com.bytedesk.kbase.article.elastic.ArticleElasticSearchResult

class ArticleElasticSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

articleElastic

ArticleElastic articleElastic

highlightedContent

String highlightedContent

highlightedSummary

String highlightedSummary

highlightedTitle

String highlightedTitle

score

float score

Package com.bytedesk.kbase.article.event

Class com.bytedesk.kbase.article.event.AbstractArticleEvent

class AbstractArticleEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

article

ArticleEntity article

Class com.bytedesk.kbase.article.event.ArticleCreateEvent

class ArticleCreateEvent extends AbstractArticleEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.article.event.ArticleDeleteEvent

class ArticleDeleteEvent extends AbstractArticleEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.article.event.ArticleUpdateEvent

class ArticleUpdateEvent extends AbstractArticleEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.article.mq

Class com.bytedesk.kbase.article.mq.ArticleIndexMessage

class ArticleIndexMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

articleUid

String articleUid

文章唯一标识

operationType

String operationType

操作类型：create, update, delete

updateElasticIndex

Boolean updateElasticIndex

是否需要更新全文索引

updateVectorIndex

Boolean updateVectorIndex

是否需要更新向量索引

Package com.bytedesk.kbase.article.vector

Class com.bytedesk.kbase.article.vector.ArticleVectorSearchResult

class ArticleVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

articleVector

ArticleVector articleVector

distance

float distance

highlightedTitle

String highlightedTitle

score

float score

Package com.bytedesk.kbase.auto_reply

Class com.bytedesk.kbase.auto_reply.AutoReplyMessageExtra

class AutoReplyMessageExtra extends MessageExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyType

String autoReplyType

isAutoReply

Boolean isAutoReply

replyMessageContent

String replyMessageContent

replyMessageUid

String replyMessageUid

Package com.bytedesk.kbase.auto_reply.fixed

Class com.bytedesk.kbase.auto_reply.fixed.AutoReplyFixedEntity

class AutoReplyFixedEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

name

String name

replyCount

Integer replyCount

startDate

ZonedDateTime startDate

tagList

List<String> tagList

type

String type

Class com.bytedesk.kbase.auto_reply.fixed.AutoReplyFixedMessageExtra

class AutoReplyFixedMessageExtra extends MessageExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

Class com.bytedesk.kbase.auto_reply.fixed.AutoReplyFixedRequest

class AutoReplyFixedRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

replyCount

Integer replyCount

startDate

ZonedDateTime startDate

tagList

List<String> tagList

Class com.bytedesk.kbase.auto_reply.fixed.AutoReplyFixedResponse

class AutoReplyFixedResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

replyCount

Integer replyCount

startDate

ZonedDateTime startDate

tagList

List<String> tagList

type

String type

Package com.bytedesk.kbase.auto_reply.keyword

Class com.bytedesk.kbase.auto_reply.keyword.AutoReplyKeywordEntity

class AutoReplyKeywordEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentType

String contentType

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

keywordList

List<String> keywordList

matchType

String matchType

replyCount

Integer replyCount

replyList

List<String> replyList

startDate

ZonedDateTime startDate

tagList

List<String> tagList

transfer

Boolean transfer

Class com.bytedesk.kbase.auto_reply.keyword.AutoReplyKeywordMessageExtra

class AutoReplyKeywordMessageExtra extends MessageExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

Class com.bytedesk.kbase.auto_reply.keyword.AutoReplyKeywordRequest

class AutoReplyKeywordRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentType

String contentType

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

keywordList

List<String> keywordList

matchType

String matchType

replyCount

Integer replyCount

replyList

List<String> replyList

startDate

ZonedDateTime startDate

tagList

List<String> tagList

transfer

Boolean transfer

Class com.bytedesk.kbase.auto_reply.keyword.AutoReplyKeywordResponse

class AutoReplyKeywordResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentType

MessageTypeEnum contentType

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

keywordList

List<String> keywordList

matchType

AutoReplyKeywordMatchEnum matchType

replyCount

Integer replyCount

replyList

List<String> replyList

startDate

ZonedDateTime startDate

tagList

List<String> tagList

transfer

Boolean transfer

Package com.bytedesk.kbase.auto_reply.settings

Class com.bytedesk.kbase.auto_reply.settings.AutoReplySettingsEntity

class AutoReplySettingsEntity extends BaseEntity implements Serializable

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyContentType

String autoReplyContentType

autoReplyEnabled

Boolean autoReplyEnabled

autoReplyType

String autoReplyType

autoReplyUid

String autoReplyUid

kbUid

String kbUid

robotUid

String robotUid

takeoverEnabled

Boolean takeoverEnabled

Class com.bytedesk.kbase.auto_reply.settings.AutoReplySettingsRequest

class AutoReplySettingsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyContentType

String autoReplyContentType

autoReplyEnabled

Boolean autoReplyEnabled

autoReplyType

String autoReplyType

autoReplyUid

String autoReplyUid

kbUid

String kbUid

robotUid

String robotUid

takeoverEnabled

Boolean takeoverEnabled

Class com.bytedesk.kbase.auto_reply.settings.AutoReplySettingsResponse

class AutoReplySettingsResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

autoReplyContent

String autoReplyContent

autoReplyContentType

String autoReplyContentType

autoReplyEnabled

Boolean autoReplyEnabled

autoReplyType

String autoReplyType

autoReplyUid

String autoReplyUid

kbUid

String kbUid

robotUid

String robotUid

takeoverEnabled

Boolean takeoverEnabled

Package com.bytedesk.kbase.blog

Class com.bytedesk.kbase.blog.BlogEntity

class BlogEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

description

String description

摘要/描述

editor

String editor

kbUid

String kbUid

likeCount

Integer likeCount

name

String name

标题

published

Boolean published

readCount

Integer readCount

tagList

List<String> tagList

top

Boolean top

type

String type

内容类型（TEXT/MARKDOWN/HTML...），默认 TEXT

Class com.bytedesk.kbase.blog.BlogRequest

class BlogRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

description

String description

editor

String editor

kbUid

String kbUid

likeCount

Integer likeCount

name

String name

published

Boolean published

readCount

Integer readCount

tagList

List<String> tagList

top

Boolean top

type

String type

Class com.bytedesk.kbase.blog.BlogResponse

class BlogResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

contentHtml

String contentHtml

contentMarkdown

String contentMarkdown

coverImageUrl

String coverImageUrl

description

String description

editor

String editor

kbUid

String kbUid

likeCount

Integer likeCount

name

String name

published

Boolean published

readCount

Integer readCount

tagList

List<String> tagList

top

Boolean top

type

String type

Package com.bytedesk.kbase.blog.event

Class com.bytedesk.kbase.blog.event.AbstractBlogEvent

class AbstractBlogEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

blog

BlogEntity blog

Class com.bytedesk.kbase.blog.event.BlogCreateEvent

class BlogCreateEvent extends AbstractBlogEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.blog.event.BlogDeleteEvent

class BlogDeleteEvent extends AbstractBlogEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.blog.event.BlogUpdateEvent

class BlogUpdateEvent extends AbstractBlogEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.comment

Class com.bytedesk.kbase.comment.KbaseCommentEntity

class KbaseCommentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

articleUid

String articleUid

content

String content

replyToContent

String replyToContent

replyToUid

String replyToUid

replyToUser

String replyToUser

tagList

List<String> tagList

type

String type

user

String user

Class com.bytedesk.kbase.comment.KbaseCommentRequest

class KbaseCommentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

articleUid

String articleUid

endDate

ZonedDateTime endDate

replyToContent

String replyToContent

replyToUid

String replyToUid

replyToUser

String replyToUser

startDate

ZonedDateTime startDate

tagList

List<String> tagList

user

String user

Class com.bytedesk.kbase.comment.KbaseCommentResponse

class KbaseCommentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

articleUid

String articleUid

content

String content

level

String level

platform

String platform

replyToContent

String replyToContent

replyToUid

String replyToUid

replyToUser

String replyToUser

type

String type

user

String user

Package com.bytedesk.kbase.comment.event

Class com.bytedesk.kbase.comment.event.KbaseCommentCreateEvent

class KbaseCommentCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

KbaseCommentEntity comment

Class com.bytedesk.kbase.comment.event.KbaseCommentDeleteEvent

class KbaseCommentDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

KbaseCommentEntity comment

Class com.bytedesk.kbase.comment.event.KbaseCommentUpdateEvent

class KbaseCommentUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

KbaseCommentEntity comment

Package com.bytedesk.kbase.kbase

Class com.bytedesk.kbase.kbase.KbaseEntity

class KbaseEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

Associated agent UID for agent-specific knowledge base

articleCount

Integer articleCount

Number of articles in the knowledge base

backgroundImageUrl

String backgroundImageUrl

URL of the custom background image for the knowledge base

coverImageUrl

String coverImageUrl

URL of the custom cover image for the knowledge base

css

String css

Custom CSS/Less code for styling the knowledge base

description

String description

Description of the knowledge base

descriptionHtml

String descriptionHtml

HTML description for SEO purposes (meta description tag)

embeddingModel

String embeddingModel

LLM embedding model for vector search functionality

embeddingProvider

String embeddingProvider

LLM embedding provider for vector search functionality

endDate

ZonedDateTime endDate

End date when the knowledge base expires

faviconUrl

String faviconUrl

URL of the knowledge base favicon

favorite

Boolean favorite

Whether the knowledge base is marked as favorite

footerHtml

String footerHtml

Custom HTML footer code displayed at the bottom of the knowledge base

headerHtml

String headerHtml

Custom HTML header code displayed at the top of the knowledge base

headline

String headline

Main headline or title displayed on the knowledge base

isPublic

Boolean isPublic

Whether the knowledge base is publicly accessible

language

String language

Language setting for the knowledge base

logoUrl

String logoUrl

URL of the knowledge base logo image

memberCount

Integer memberCount

Number of members in the knowledge base

members

List<MemberEntity> members

Members who have access to this knowledge base

name

String name

Name of the knowledge base

primaryColor

String primaryColor

Primary color theme for the knowledge base

published

Boolean published

Whether the knowledge base is published and accessible

showChat

Boolean showChat

Whether to show chat functionality in the knowledge base

startDate

ZonedDateTime startDate

Start date when the knowledge base becomes active

subHeadline

String subHeadline

Subtitle or secondary headline for the knowledge base

tagList

List<String> tagList

Tags for knowledge base categorization and search

theme

String theme

Theme name for the knowledge base appearance

type

String type

Type of knowledge base (HELPCENTER, DOCUMENTATION, FAQ, etc.)

url

String url

Custom URL for the knowledge base

Class com.bytedesk.kbase.kbase.KbaseRequest

class KbaseRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

articleCount

Integer articleCount

backgroundImageUrl

String backgroundImageUrl

coverImageUrl

String coverImageUrl

css

String css

description

String description

descriptionHtml

String descriptionHtml

知识库描述 输入一两句话简单介绍您的论坛。这将会显示为 <meta name="description"> 描述标签，一般为 160 字的文本，用于介绍网页的内容。平常多被搜索引擎截取网页简介用。

embeddingModel

String embeddingModel

embeddingProvider

String embeddingProvider

endDate

ZonedDateTime endDate

faviconUrl

String faviconUrl

favorite

Boolean favorite

footerHtml

String footerHtml

headerHtml

String headerHtml

headline

String headline

isPublic

Boolean isPublic

language

String language

logoUrl

String logoUrl

memberCount

Integer memberCount

memberUids

@NotEmpty(message="memberUids must not be empty") List<String> memberUids

name

String name

primaryColor

String primaryColor

published

Boolean published

queryNotebase

Boolean queryNotebase

showChat

Boolean showChat

startDate

ZonedDateTime startDate

subHeadline

String subHeadline

tagList

List<String> tagList

theme

String theme

url

String url

Class com.bytedesk.kbase.kbase.KbaseResponse

class KbaseResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

articleCount

Integer articleCount

backgroundImageUrl

String backgroundImageUrl

coverImageUrl

String coverImageUrl

css

String css

description

String description

descriptionHtml

String descriptionHtml

知识库描述 输入一两句话简单介绍您的论坛。这将会显示为 <meta name="description"> 描述标签，一般为 160 字的文本，用于介绍网页的内容。平常多被搜索引擎截取网页简介用。

embeddingModel

String embeddingModel

embeddingProvider

String embeddingProvider

endDate

ZonedDateTime endDate

faviconUrl

String faviconUrl

favorite

Boolean favorite

footerHtml

String footerHtml

headerHtml

String headerHtml

headline

String headline

isPublic

Boolean isPublic

language

String language

logoUrl

String logoUrl

memberCount

Integer memberCount

members

List<UserProtobuf> members

name

String name

primaryColor

String primaryColor

published

Boolean published

showChat

Boolean showChat

startDate

ZonedDateTime startDate

subHeadline

String subHeadline

tagList

List<String> tagList

theme

String theme

type

String type

url

String url

Package com.bytedesk.kbase.kbase_invite

Class com.bytedesk.kbase.kbase_invite.KbaseInviteEntity

class KbaseInviteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the invitation display

description

String description

Description of the invitation

name

String name

Name of the invitation

order

Integer order

Display order of the invitation

type

String type

Type of invitation (CUSTOMER, MEMBER, etc.)

Class com.bytedesk.kbase.kbase_invite.KbaseInviteRequest

class KbaseInviteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.kbase.kbase_invite.KbaseInviteResponse

class KbaseInviteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.kbase.kbase_invite.event

Class com.bytedesk.kbase.kbase_invite.event.AbstractKbaseInviteEvent

class AbstractKbaseInviteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

kbaseInvite

KbaseInviteEntity kbaseInvite

Class com.bytedesk.kbase.kbase_invite.event.KbaseInviteCreateEvent

class KbaseInviteCreateEvent extends AbstractKbaseInviteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.kbase_invite.event.KbaseInviteDeleteEvent

class KbaseInviteDeleteEvent extends AbstractKbaseInviteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.kbase_invite.event.KbaseInviteUpdateEvent

class KbaseInviteUpdateEvent extends AbstractKbaseInviteEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.kbase.event

Class com.bytedesk.kbase.kbase.event.AbstractKbaseEvent

class AbstractKbaseEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

kbase

KbaseEntity kbase

Class com.bytedesk.kbase.kbase.event.KbaseCreateEvent

class KbaseCreateEvent extends AbstractKbaseEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.kbase.event.KbaseUpdateEvent

class KbaseUpdateEvent extends AbstractKbaseEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_chunk

Class com.bytedesk.kbase.llm_chunk.ChunkEntity

class ChunkEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

docId

String docId

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

file

FileEntity file

kbase

KbaseEntity kbase

name

String name

startDate

ZonedDateTime startDate

tagList

List<String> tagList

type

String type

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_chunk.ChunkProtobuf

class ChunkProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

name

String name

relatedChunks

List<ChunkProtobuf> relatedChunks

uid

String uid

Class com.bytedesk.kbase.llm_chunk.ChunkRequest

class ChunkRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

docId

String docId

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

fileUid

String fileUid

kbUid

String kbUid

name

String name

startDate

ZonedDateTime startDate

tagList

List<String> tagList

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_chunk.ChunkResponse

class ChunkResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

docId

String docId

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

fileUid

String fileUid

kbUid

String kbUid

name

String name

startDate

ZonedDateTime startDate

tagList

List<String> tagList

type

String type

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.llm_chunk.elastic

Class com.bytedesk.kbase.llm_chunk.elastic.ChunkElasticSearchResult

class ChunkElasticSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

chunkElastic

ChunkElastic chunkElastic

highlightedContent

String highlightedContent

highlightedName

String highlightedName

score

float score

Package com.bytedesk.kbase.llm_chunk.event

Class com.bytedesk.kbase.llm_chunk.event.AbstractChunkEvent

class AbstractChunkEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

chunk

ChunkEntity chunk

Class com.bytedesk.kbase.llm_chunk.event.ChunkCreateEvent

class ChunkCreateEvent extends AbstractChunkEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_chunk.event.ChunkDeleteEvent

class ChunkDeleteEvent extends AbstractChunkEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_chunk.event.ChunkUpdateDocEvent

class ChunkUpdateDocEvent extends AbstractChunkEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_chunk.event.ChunkUpdateEvent

class ChunkUpdateEvent extends AbstractChunkEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_chunk.mq

Class com.bytedesk.kbase.llm_chunk.mq.ChunkCompleteMessage

class ChunkCompleteMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

chunkUid

String chunkUid

Chunk唯一标识

errorMessage

String errorMessage

错误信息（如果处理失败）

fileUid

String fileUid

文件UID

processType

String processType

处理类型：elastic, vector

status

String status

处理状态：success, error

Class com.bytedesk.kbase.llm_chunk.mq.ChunkIndexMessage

class ChunkIndexMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

batchId

String batchId

批处理ID（用于跟踪批处理状态）

batchIndex

Integer batchIndex

在批处理中的索引

batchSize

Integer batchSize

批处理大小

chunkUid

String chunkUid

Chunk唯一标识

fileUid

String fileUid

文件UID（用于批处理时的分组）

operationType

String operationType

操作类型：create, update, delete

updateElasticIndex

Boolean updateElasticIndex

是否需要更新全文索引

updateVectorIndex

Boolean updateVectorIndex

是否需要更新向量索引

Package com.bytedesk.kbase.llm_chunk.vector

Class com.bytedesk.kbase.llm_chunk.vector.ChunkVectorSearchResult

class ChunkVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

chunkVector

ChunkVector chunkVector

distance

float distance

highlightedContent

String highlightedContent

highlightedName

String highlightedName

score

double score

Package com.bytedesk.kbase.llm_faq

Class com.bytedesk.kbase.llm_faq.FaqAnswer

class FaqAnswer extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

description

String description

vipLevel

String vipLevel

Class com.bytedesk.kbase.llm_faq.FaqEntity

class FaqEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

answerHtml

String answerHtml

answerList

List<FaqAnswer> answerList

answerMarkdown

String answerMarkdown

attachments

List<String> attachments

categoryUid

String categoryUid

clickCount

Integer clickCount

docIdList

List<String> docIdList

downCount

Integer downCount

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

feedbackCount

Integer feedbackCount

fileUid

String fileUid

images

List<String> images

kbase

KbaseEntity kbase

question

String question

relatedFaqs

List<FaqEntity> relatedFaqs

similarQuestions

List<String> similarQuestions

startDate

ZonedDateTime startDate

tagList

List<String> tagList

标签列表

transferCount

Integer transferCount

type

String type

upCount

Integer upCount

vectorStatus

String vectorStatus

viewCount

Integer viewCount

Class com.bytedesk.kbase.llm_faq.FaqMessageExtra

class FaqMessageExtra extends MessageExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

answerList

List<FaqAnswer> answerList

attachments

List<String> attachments

faqUid

String faqUid

images

List<String> images

relatedFaqs

List<FaqResponseSimple> relatedFaqs

Class com.bytedesk.kbase.llm_faq.FaqProtobuf

class FaqProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

question

String question

relatedFaqs

List<FaqProtobuf> relatedFaqs

type

String type

uid

String uid

Class com.bytedesk.kbase.llm_faq.FaqRequest

class FaqRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

answerHtml

String answerHtml

answerList

List<FaqAnswer> answerList

answerMarkdown

String answerMarkdown

attachments

List<String> attachments

categoryUid

String categoryUid

clickCount

Integer clickCount

componentType

String componentType

docIdList

List<String> docIdList

downCount

Integer downCount

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

feedbackCount

Integer feedbackCount

fileUid

String fileUid

images

List<String> images

kbUid

String kbUid

messageUid

String messageUid

onlyLoadValid

Boolean onlyLoadValid

question

String question

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

relatedFaqUids

List<String> relatedFaqUids

similarQuestions

List<String> similarQuestions

startDate

ZonedDateTime startDate

tagList

List<String> tagList

threadUid

String threadUid

transferCount

Integer transferCount

upCount

Integer upCount

user

String user

vectorStatus

String vectorStatus

viewCount

Integer viewCount

vipLevel

Integer vipLevel

Class com.bytedesk.kbase.llm_faq.FaqResponse

class FaqResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

answerHtml

String answerHtml

answerList

List<FaqAnswer> answerList

answerMarkdown

String answerMarkdown

answerMessage

MessageResponse answerMessage

attachments

List<String> attachments

categoryUid

String categoryUid

clickCount

Integer clickCount

docIdList

List<String> docIdList

downCount

Integer downCount

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

feedbackCount

Integer feedbackCount

fileUid

String fileUid

images

List<String> images

kbUid

String kbUid

question

String question

questionMessage

MessageResponse questionMessage

relatedFaqs

List<FaqResponseSimple> relatedFaqs

similarQuestions

List<String> similarQuestions

startDate

ZonedDateTime startDate

tagList

List<String> tagList

transferCount

Integer transferCount

type

String type

upCount

Integer upCount

vectorStatus

String vectorStatus

viewCount

Integer viewCount

Class com.bytedesk.kbase.llm_faq.FaqResponseSimple

class FaqResponseSimple extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

question

String question

uid

String uid

Class com.bytedesk.kbase.llm_faq.FaqResponseVisitor

class FaqResponseVisitor extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

attachments

List<String> attachments

categoryUid

String categoryUid

images

List<String> images

orgUid

String orgUid

question

String question

type

String type

uid

String uid

Package com.bytedesk.kbase.llm_faq.elastic

Class com.bytedesk.kbase.llm_faq.elastic.FaqElasticSearchResult

class FaqElasticSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

faqElastic

FaqElastic faqElastic

highlightedQuestion

String highlightedQuestion

score

float score

Package com.bytedesk.kbase.llm_faq.event

Class com.bytedesk.kbase.llm_faq.event.AbstractFaqEvent

class AbstractFaqEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

faq

FaqEntity faq

Class com.bytedesk.kbase.llm_faq.event.FaqCreateEvent

class FaqCreateEvent extends AbstractFaqEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_faq.event.FaqDeleteEvent

class FaqDeleteEvent extends AbstractFaqEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_faq.event.FaqUpdateDocEvent

class FaqUpdateDocEvent extends AbstractFaqEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_faq.event.FaqUpdateEvent

class FaqUpdateEvent extends AbstractFaqEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_faq.mq

Class com.bytedesk.kbase.llm_faq.mq.FaqIndexMessage

class FaqIndexMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

faqUid

String faqUid

FAQ唯一标识

operationType

String operationType

操作类型：create, update, delete

updateElasticIndex

Boolean updateElasticIndex

是否需要更新全文索引

updateVectorIndex

Boolean updateVectorIndex

是否需要更新向量索引

Package com.bytedesk.kbase.llm_faq.vector

Class com.bytedesk.kbase.llm_faq.vector.FaqVectorSearchResult

class FaqVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

distance

float distance

faqVector

FaqVector faqVector

highlightedQuestion

String highlightedQuestion

score

float score

Package com.bytedesk.kbase.llm_file

Class com.bytedesk.kbase.llm_file.FileEntity

class FileEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

fileName

String fileName

fileType

String fileType

fileUrl

String fileUrl

kbase

KbaseEntity kbase

startDate

ZonedDateTime startDate

tagList

List<String> tagList

upload

UploadEntity upload

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_file.FileRequest

class FileRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

fileName

String fileName

fileType

String fileType

fileUrl

String fileUrl

kbUid

String kbUid

startDate

ZonedDateTime startDate

tagList

List<String> tagList

uploadUid

String uploadUid

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_file.FileResponse

class FileResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

fileName

String fileName

fileType

String fileType

fileUrl

String fileUrl

kbase

KbaseResponse kbase

startDate

ZonedDateTime startDate

tagList

List<String> tagList

upload

UploadResponse upload

userUid

String userUid

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_file.FileUploadExtra

class FileUploadExtra extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

autoGenerateLlmQa

String autoGenerateLlmQa

autoLlmChunk

String autoLlmChunk

Package com.bytedesk.kbase.llm_file.event

Class com.bytedesk.kbase.llm_file.event.AbstractFileEvent

class AbstractFileEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

file

FileEntity file

Class com.bytedesk.kbase.llm_file.event.FileChunkEvent

class FileChunkEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

documents

List<org.springframework.ai.document.Document> documents

fileResponse

FileResponse fileResponse

Class com.bytedesk.kbase.llm_file.event.FileCreateEvent

class FileCreateEvent extends AbstractFileEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_file.event.FileDeleteEvent

class FileDeleteEvent extends AbstractFileEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_file.event.FileUpdateEvent

class FileUpdateEvent extends AbstractFileEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_text

Class com.bytedesk.kbase.llm_text.TextEntity

class TextEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbase

KbaseEntity kbase

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

type

String type

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_text.TextProtobuf

class TextProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

relatedTexts

List<TextProtobuf> relatedTexts

title

String title

uid

String uid

Class com.bytedesk.kbase.llm_text.TextRequest

class TextRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_text.TextResponse

class TextResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

docId

String docId

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.llm_text.elastic

Class com.bytedesk.kbase.llm_text.elastic.TextElasticSearchResult

class TextElasticSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

highlightedContent

String highlightedContent

highlightedName

String highlightedName

score

float score

textElastic

TextElastic textElastic

Package com.bytedesk.kbase.llm_text.event

Class com.bytedesk.kbase.llm_text.event.AbstractTextEvent

class AbstractTextEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

text

TextEntity text

Class com.bytedesk.kbase.llm_text.event.TextCreateEvent

class TextCreateEvent extends AbstractTextEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_text.event.TextDeleteEvent

class TextDeleteEvent extends AbstractTextEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_text.event.TextUpdateDocEvent

class TextUpdateDocEvent extends AbstractTextEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_text.event.TextUpdateEvent

class TextUpdateEvent extends AbstractTextEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_text.vector

Class com.bytedesk.kbase.llm_text.vector.TextVectorSearchResult

class TextVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

distance

float distance

highlightedContent

String highlightedContent

highlightedTitle

String highlightedTitle

score

float score

textVector

TextVector textVector

Package com.bytedesk.kbase.llm_webpage

Class com.bytedesk.kbase.llm_webpage.WebpageEntity

class WebpageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

clickCount

Integer clickCount

content

String content

description

String description

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbase

KbaseEntity kbase

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

url

String url

vectorStatus

String vectorStatus

viewCount

Integer viewCount

Class com.bytedesk.kbase.llm_webpage.WebpageRequest

class WebpageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

description

String description

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

url

String url

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_webpage.WebpageResponse

class WebpageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

description

String description

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

url

String url

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.llm_webpage.elastic

Class com.bytedesk.kbase.llm_webpage.elastic.WebpageElasticSearchResult

class WebpageElasticSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

highlightedContent

String highlightedContent

highlightedDescription

String highlightedDescription

highlightedTitle

String highlightedTitle

score

float score

webpageElastic

WebpageElastic webpageElastic

Package com.bytedesk.kbase.llm_webpage.event

Class com.bytedesk.kbase.llm_webpage.event.AbstractWebpageEvent

class AbstractWebpageEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

webpage

WebpageEntity webpage

Class com.bytedesk.kbase.llm_webpage.event.WebpageCreateEvent

class WebpageCreateEvent extends AbstractWebpageEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_webpage.event.WebpageDeleteEvent

class WebpageDeleteEvent extends AbstractWebpageEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_webpage.event.WebpageUpdateDocEvent

class WebpageUpdateDocEvent extends AbstractWebpageEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_webpage.event.WebpageUpdateEvent

class WebpageUpdateEvent extends AbstractWebpageEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.llm_webpage.mq

Class com.bytedesk.kbase.llm_webpage.mq.WebpageIndexMessage

class WebpageIndexMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

operationType

String operationType

操作类型：create, update, delete

updateElasticIndex

Boolean updateElasticIndex

是否需要更新全文索引

updateVectorIndex

Boolean updateVectorIndex

是否需要更新向量索引

webpageUid

String webpageUid

网页唯一标识

Package com.bytedesk.kbase.llm_webpage.vector

Class com.bytedesk.kbase.llm_webpage.vector.WebpageVectorSearchResult

class WebpageVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

distance

float distance

highlightedContent

String highlightedContent

highlightedTitle

String highlightedTitle

score

float score

webpageVector

WebpageVector webpageVector

Package com.bytedesk.kbase.llm_website

Class com.bytedesk.kbase.llm_website.WebsiteEntity

class WebsiteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

autoRecrawl

Boolean autoRecrawl

categoryUid

String categoryUid

content

String content

crawlConfigJson

String crawlConfigJson

crawlStatus

String crawlStatus

currentCrawlTaskId

String currentCrawlTaskId

description

String description

docIdList

List<String> docIdList

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

failedPages

Integer failedPages

kbase

KbaseEntity kbase

lastCrawlTime

ZonedDateTime lastCrawlTime

name

String name

recrawlInterval

Integer recrawlInterval

startDate

ZonedDateTime startDate

successPages

Integer successPages

tagList

List<String> tagList

totalPages

Integer totalPages

type

String type

url

String url

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_website.WebsiteRequest

class WebsiteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

description

String description

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

name

String name

startDate

ZonedDateTime startDate

tagList

List<String> tagList

url

String url

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.llm_website.WebsiteResponse

class WebsiteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

description

String description

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

name

String name

startDate

ZonedDateTime startDate

tagList

List<String> tagList

type

String type

url

String url

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.llm_website.crawl

Class com.bytedesk.kbase.llm_website.crawl.WebsiteCrawlTask

class WebsiteCrawlTask extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

configJson

String configJson

抓取配置（JSON格式存储）

endTime

Long endTime

结束时间

errorMessage

String errorMessage

错误信息

failedPages

Integer failedPages

失败页面数

lastUpdateTime

ZonedDateTime lastUpdateTime

最后更新时间

processedPages

Integer processedPages

已处理页面数

resultJson

String resultJson

抓取结果（JSON格式存储）

startTime

Long startTime

开始时间

status

WebsiteCrawlStatus status

任务状态

successPages

Integer successPages

成功页面数

taskId

String taskId

任务ID

totalPages

Integer totalPages

总页面数

websiteUid

String websiteUid

网站UID

websiteUrl

String websiteUrl

网站URL

Package com.bytedesk.kbase.llm_website.event

Class com.bytedesk.kbase.llm_website.event.AbstractWebsiteEvent

class AbstractWebsiteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

website

WebsiteEntity website

Class com.bytedesk.kbase.llm_website.event.WebsiteCreateEvent

class WebsiteCreateEvent extends AbstractWebsiteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_website.event.WebsiteDeleteEvent

class WebsiteDeleteEvent extends AbstractWebsiteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_website.event.WebsiteUpdateDocEvent

class WebsiteUpdateDocEvent extends AbstractWebsiteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.llm_website.event.WebsiteUpdateEvent

class WebsiteUpdateEvent extends AbstractWebsiteEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.material

Class com.bytedesk.kbase.material.MaterialEntity

class MaterialEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

upload

UploadEntity upload

Class com.bytedesk.kbase.material.MaterialRequest

class MaterialRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.kbase.material.MaterialResponse

class MaterialResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.kbase.material.event

Class com.bytedesk.kbase.material.event.AbstractMaterialEvent

class AbstractMaterialEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

material

MaterialEntity material

Class com.bytedesk.kbase.material.event.MaterialCreateEvent

class MaterialCreateEvent extends AbstractMaterialEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.material.event.MaterialDeleteEvent

class MaterialDeleteEvent extends AbstractMaterialEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.material.event.MaterialUpdateEvent

class MaterialUpdateEvent extends AbstractMaterialEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.note

Class com.bytedesk.kbase.note.NoteEntity

class NoteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the note

name

String name

Name of the note

type

String type

Type of note (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.kbase.note.NoteRequest

class NoteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.kbase.note.NoteResponse

class NoteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Package com.bytedesk.kbase.note.event

Class com.bytedesk.kbase.note.event.AbstractNoteEvent

class AbstractNoteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

note

NoteEntity note

Class com.bytedesk.kbase.note.event.NoteCreateEvent

class NoteCreateEvent extends AbstractNoteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.note.event.NoteDeleteEvent

class NoteDeleteEvent extends AbstractNoteEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.note.event.NoteUpdateEvent

class NoteUpdateEvent extends AbstractNoteEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.kbase.quick_button

Class com.bytedesk.kbase.quick_button.QuickButtonEntity

class QuickButtonEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

badge

String badge

code

String code

color

String color

content

String content

description

String description

enabled

Boolean enabled

highlight

Boolean highlight

icon

String icon

imageUrl

String imageUrl

kbUid

String kbUid

orderIndex

Integer orderIndex

payload

QuickButtonPayload payload

subtitle

String subtitle

title

@NotBlank String title

type

String type

Class com.bytedesk.kbase.quick_button.QuickButtonPayload

class QuickButtonPayload extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

customCode

String customCode

Custom code for client side extensions

emailAddress

String emailAddress

Email address when type = EMAIL

emailBody

String emailBody

Email body template

emailSubject

String emailSubject

Email subject template

faqAnswer

String faqAnswer

FAQ fallback answer snippet

faqQuestion

String faqQuestion

Snapshot of the FAQ question to simplify client rendering

faqUid

String faqUid

FAQ reference uid when type = FAQ

formSchema

String formSchema

Serialized schema when type = FORM

goodsUid

String goodsUid

Goods reference uid when type = GOODS (optional)

imageUrl

String imageUrl

Asset url when type = IMAGE

orderUid

String orderUid

Order reference uid when type = ORDER (optional)

phoneNumber

String phoneNumber

Phone number when type = PHONE

url

String url

External link when type = URL

urlTarget

String urlTarget

Optional target hint: _blank/_self

Class com.bytedesk.kbase.quick_button.QuickButtonRequest

class QuickButtonRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

badge

String badge

code

String code

color

String color

description

String description

enabled

Boolean enabled

highlight

Boolean highlight

icon

String icon

imageUrl

String imageUrl

kbUid

String kbUid

orderIndex

Integer orderIndex

payload

QuickButtonPayload payload

Structured payload for action type specific data

subtitle

String subtitle

title

String title

Class com.bytedesk.kbase.quick_button.QuickButtonResponse

class QuickButtonResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

badge

String badge

code

String code

color

String color

content

String content

description

String description

enabled

Boolean enabled

highlight

Boolean highlight

icon

String icon

imageUrl

String imageUrl

kbUid

String kbUid

orderIndex

Integer orderIndex

payload

QuickButtonPayload payload

subtitle

String subtitle

title

String title

type

String type

Class com.bytedesk.kbase.quick_button.QuickButtonResponseVisitor

class QuickButtonResponseVisitor extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

badge

String badge

code

String code

color

String color

content

String content

description

String description

enabled

Boolean enabled

highlight

Boolean highlight

icon

String icon

imageUrl

String imageUrl

kbUid

String kbUid

orderIndex

Integer orderIndex

payload

QuickButtonPayload payload

subtitle

String subtitle

title

String title

type

String type

uid

String uid

Package com.bytedesk.kbase.quick_reply

Class com.bytedesk.kbase.quick_reply.QuickReplyEntity

class QuickReplyEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

clickCount

Integer clickCount

content

String content

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

shortCut

String shortCut

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

type

String type

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.quick_reply.QuickReplyRequest

class QuickReplyRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

clickCount

Integer clickCount

componentType

String componentType

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

shortCut

String shortCut

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

vectorStatus

String vectorStatus

Class com.bytedesk.kbase.quick_reply.QuickReplyResponse

class QuickReplyResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

clickCount

Integer clickCount

content

String content

elasticStatus

String elasticStatus

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

shortCut

String shortCut

startDate

ZonedDateTime startDate

tagList

List<String> tagList

title

String title

type

String type

vectorStatus

String vectorStatus

Package com.bytedesk.kbase.quick_reply.elastic

Class com.bytedesk.kbase.quick_reply.elastic.QuickReplyElastic

class QuickReplyElastic extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

clickCount

Integer clickCount

content

String content

enabled

Boolean enabled

endDate

String endDate

kbUid

String kbUid

shortCut

String shortCut

startDate

String startDate

tagList

List<String> tagList

title

String title

type

String type

Package com.bytedesk.kbase.quick_reply.mq

Class com.bytedesk.kbase.quick_reply.mq.QuickReplyIndexMessage

class QuickReplyIndexMessage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

operationType

String operationType

操作类型：create, update, delete

quickReplyUid

String quickReplyUid

快捷回复唯一标识

updateElasticIndex

Boolean updateElasticIndex

是否需要更新全文索引

updateVectorIndex

Boolean updateVectorIndex

是否需要更新向量索引

Package com.bytedesk.kbase.quick_reply.vector

Class com.bytedesk.kbase.quick_reply.vector.QuickReplyVector

class QuickReplyVector extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

clickCount

Integer clickCount

content

String content

embedding

float[] embedding

enabled

Boolean enabled

endDate

String endDate

kbUid

String kbUid

shortCut

String shortCut

startDate

String startDate

tagList

List<String> tagList

title

String title

type

String type

Class com.bytedesk.kbase.quick_reply.vector.QuickReplyVectorSearchResult

class QuickReplyVectorSearchResult extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

categoryUid

String categoryUid

content

String content

kbUid

String kbUid

score

Float score

title

String title

type

String type

uid

String uid

Package com.bytedesk.kbase.settings

Class com.bytedesk.kbase.settings.BaseSettingsEntity

class BaseSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Settings description

draftEmotionSettings

EmotionSettingEntity draftEmotionSettings

Draft emotion recognition settings (admin editing/testing only)

draftIntentionSettings

IntentionSettingsEntity draftIntentionSettings

Draft intention recognition settings (admin editing/testing only)

draftInviteSettings

InviteSettingsEntity draftInviteSettings

Draft invitation settings (admin editing/testing only)

draftServiceSettings

ServiceSettingsEntity draftServiceSettings

Draft service settings (used in admin editing/testing, not affecting online runtime until published)

draftSummarySettings

SummarySettingsEntity draftSummarySettings

Draft conversation summary settings (admin editing/testing only)

draftTriggerSettings

TriggerSettingsEntity draftTriggerSettings

Draft trigger settings (admin editing/testing only)

emotionSettings

EmotionSettingEntity emotionSettings

Emotion recognition settings

enabled

Boolean enabled

Whether the settings is enabled

hasUnpublishedChanges

Boolean hasUnpublishedChanges

Whether there are unpublished changes in draft

intentionSettings

IntentionSettingsEntity intentionSettings

Intention recognition settings

inviteSettings

InviteSettingsEntity inviteSettings

Invitation settings

isDefault

Boolean isDefault

Whether this is a default settings template for new entities Only one settings per organization should have isDefault=true

name

@NotBlank String name

Settings name (required)

publishedAt

ZonedDateTime publishedAt

Last published time

serviceSettings

ServiceSettingsEntity serviceSettings

Service settings (published)

summarySettings

SummarySettingsEntity summarySettings

Conversation summary settings

triggerSettings

TriggerSettingsEntity triggerSettings

Trigger settings (published)

Class com.bytedesk.kbase.settings.BaseSettingsRequest

class BaseSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Settings description

emotionSettings

EmotionSettingRequest emotionSettings

Emotion recognition settings (common to all settings)

enabled

Boolean enabled

Whether the settings is enabled

intentionSettings

IntentionSettingsRequest intentionSettings

Intention recognition settings (common to all settings)

inviteSettings

InviteSettingsRequest inviteSettings

Invitation settings (common to all settings)

isDefault

Boolean isDefault

Whether this is a default settings template for new entities Only one settings per organization should have isDefault=true

name

String name

Settings name (required)

serviceSettings

ServiceSettingsRequest serviceSettings

Service settings (common to all settings)

summarySettings

SummarySettingsRequest summarySettings

Conversation summary settings (common to all settings)

triggerSettings

TriggerSettingsRequest triggerSettings

Trigger settings (common to all settings)

Class com.bytedesk.kbase.settings.BaseSettingsResponse

class BaseSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Settings description

draftEmotionSettings

EmotionSettingResponse draftEmotionSettings

Draft emotion recognition settings (admin editing/testing only)

draftIntentionSettings

IntentionSettingsResponse draftIntentionSettings

Draft intention recognition settings (admin editing/testing only)

draftInviteSettings

InviteSettingsResponse draftInviteSettings

Draft invitation settings (admin editing/testing only)

draftServiceSettings

ServiceSettingsResponse draftServiceSettings

Draft service settings (admin editing/testing only)

draftSummarySettings

SummarySettingsResponse draftSummarySettings

Draft conversation summary settings (admin editing/testing only)

draftTriggerSettings

TriggerSettingsResponse draftTriggerSettings

Draft trigger settings (admin editing/testing only)

emotionSettings

EmotionSettingResponse emotionSettings

Emotion recognition settings (common to all settings)

enabled

Boolean enabled

Whether the settings is enabled

hasUnpublishedChanges

Boolean hasUnpublishedChanges

Whether there are unpublished changes in draft

intentionSettings

IntentionSettingsResponse intentionSettings

Intention recognition settings (common to all settings)

inviteSettings

InviteSettingsResponse inviteSettings

Invitation settings (common to all settings)

isDefault

Boolean isDefault

Whether this is a default settings template for new entities

name

String name

Settings name

publishedAt

ZonedDateTime publishedAt

Last published time

serviceSettings

ServiceSettingsResponse serviceSettings

Service settings (common to all settings)

summarySettings

SummarySettingsResponse summarySettings

Conversation summary settings (common to all settings)

triggerSettings

TriggerSettingsResponse triggerSettings

Trigger settings (common to all settings)

Class com.bytedesk.kbase.settings.ToolbarSettings

class ToolbarSettings extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

audio

Boolean audio

file

Boolean file

image

Boolean image

leavemsg

Boolean leavemsg

order

List<String> order

orderSelector

Boolean orderSelector

rate

Boolean rate

smile

Boolean smile

tel

Boolean tel

ticket

Boolean ticket

upload

Boolean upload

video

Boolean video

Package com.bytedesk.kbase.settings_emotion

Class com.bytedesk.kbase.settings_emotion.EmotionSettingEntity

class EmotionSettingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

confidenceThreshold

Double confidenceThreshold

情绪信心度阈值，低于该阈值的情绪分析结果将被认为是不确定的 范围：0-1，例如0.75表示75%的置信度

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

emotionHandlers

String emotionHandlers

情绪对应的处理策略 格式：{"情绪1": "处理策略1", "情绪2": "处理策略2"} 例如：{"满意": "normal", "不满意": "escalate"}

emotionList

List<String> emotionList

情绪分类选项

emotionSwitchThreshold

Double emotionSwitchThreshold

情绪转换阈值，当新情绪的置信度超过此阈值时才会转换当前情绪

emotionTags

String emotionTags

情绪标签，用于对情绪进行分组和归类 格式：{"情绪1": ["标签1", "标签2"], "情绪2": ["标签3", "标签4"]}

emotionTriggers

String emotionTriggers

情绪分析触发条件 格式：{"触发条件1": "值1", "触发条件2": "值2"} 例如：{"message_length": "10", "keyword_match": "true"}

emotionWeights

String emotionWeights

情绪权重配置，用于计算综合情绪分数 格式：{"情绪1": 1.0, "情绪2": 0.8, "情绪3": 0.6}

enabled

Boolean enabled

是否启用情绪分析

enableEmotionTracking

Boolean enableEmotionTracking

是否启用情绪跟踪，跟踪用户情绪的变化趋势

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

设置名称，用于区分不同的情绪分析设置模板

negativeEmotionHandling

String negativeEmotionHandling

负面情绪的处理方式 TRANSFER_HUMAN: 转人工 ESCALATE: 升级处理 OFFER_HELP: 主动提供帮助

negativeEmotionTip

String negativeEmotionTip

负面情绪检测到时的提示消息

robotUid

String robotUid

关联robot entity uid，用于调用LLM大模型进行情绪分析

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）：上次触发后，冷却未结束则跳过

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次 - 1 表示每条消息都触发

triggerScope

String triggerScope

触发范围 - VISITOR_ONLY: 仅访客消息 - AGENT_ONLY: 仅客服消息 - ALL: 所有非系统消息

Class com.bytedesk.kbase.settings_emotion.EmotionSettingRequest

class EmotionSettingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用情绪分析

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于情绪分析的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围 - VISITOR_ONLY: 仅访客消息 - AGENT_ONLY: 仅客服消息 - ALL: 所有非系统消息

Class com.bytedesk.kbase.settings_emotion.EmotionSettingResponse

class EmotionSettingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用情绪分析

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于情绪分析的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围

type

String type

Package com.bytedesk.kbase.settings_intention

Class com.bytedesk.kbase.settings_intention.IntentionSettingsEntity

class IntentionSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

confidenceThreshold

Double confidenceThreshold

意图信心度阈值，低于该阈值的意图将被认为是不确定的 范围：0-1，例如0.75表示75%的置信度

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

enabled

Boolean enabled

是否启用意图识别

enableIntentionTracking

Boolean enableIntentionTracking

是否启用意图跟踪，跟踪用户意图的变化

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

intentionList

List<String> intentionList

意图分类选项

intentionPriorities

String intentionPriorities

意图优先级配置，数字越小优先级越高 格式：{"意图1": 1, "意图2": 2, "意图3": 3}

intentionResponses

String intentionResponses

意图预设回复，针对不同意图提供默认回复模板 格式：{"意图1": "预设回复1", "意图2": "预设回复2"}

intentionSwitchThreshold

Double intentionSwitchThreshold

意图转换阈值，当新意图的置信度超过此阈值时才会转换当前意图

intentionTags

String intentionTags

意图标签，用于对意图进行分组和归类 格式：{"意图1": ["标签1", "标签2"], "意图2": ["标签3", "标签4"]}

name

String name

设置名称，用于区分不同的邀请设置模板

robotUid

String robotUid

关联robot entity uid

subIntentionMapping

String subIntentionMapping

子意图分类映射，支持多级意图分类结构 格式：{"主意图1": ["子意图1", "子意图2"], "主意图2": ["子意图3", "子意图4"]}

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）：上次触发后，冷却未结束则跳过

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次 - 1 表示每条消息都触发

triggerScope

String triggerScope

触发范围 - VISITOR_ONLY: 仅访客消息 - AGENT_ONLY: 仅客服消息 - ALL: 所有非系统消息

unknownIntentionHandling

String unknownIntentionHandling

未识别意图的处理方式 TRANSFER_HUMAN: 转人工 DEFAULT_ANSWER: 使用默认回复 CLARIFY: 请求用户澄清

unknownIntentionResponse

String unknownIntentionResponse

未识别意图的默认回复

Class com.bytedesk.kbase.settings_intention.IntentionSettingsRequest

class IntentionSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用意图识别

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于意图识别的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围 - VISITOR_ONLY: 仅访客消息 - AGENT_ONLY: 仅客服消息 - ALL: 所有非系统消息

Class com.bytedesk.kbase.settings_intention.IntentionSettingsResponse

class IntentionSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用意图识别

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于意图识别的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围

type

String type

Package com.bytedesk.kbase.settings_intention.event

Class com.bytedesk.kbase.settings_intention.event.IntentionSettingsCreateEvent

class IntentionSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intentionSettings

IntentionSettingsEntity intentionSettings

Class com.bytedesk.kbase.settings_intention.event.IntentionSettingsDeleteEvent

class IntentionSettingsDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intentionSettings

IntentionSettingsEntity intentionSettings

Class com.bytedesk.kbase.settings_intention.event.IntentionSettingsUpdateEvent

class IntentionSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

intentionSettings

IntentionSettingsEntity intentionSettings

Package com.bytedesk.kbase.settings_invite

Class com.bytedesk.kbase.settings_invite.InviteSettingsEntity

class InviteSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

abTesting

Boolean abTesting

A/B测试功能 是否启用A/B测试不同邀请方式的效果

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

delay

Long delay

邀请延迟时间,单位:毫秒

description

String description

设置描述

deviceTypes

List<String> deviceTypes

访客设备类型触发 - 针对特定设备类型启用邀请 可选值: desktop, mobile, tablet

exitIntentTrigger

Boolean exitIntentTrigger

退出意图触发 当检测到访客可能离开页面时触发邀请

icon

String icon

邀请图标

inviteAnimation

String inviteAnimation

邀请动画效果 可选值: fade, slide, bounce, none

inviteStyle

String inviteStyle

邀请样式设置 可选值: bubble, card, modal, banner

loop

Boolean loop

是否循环

loopCount

Integer loopCount

循环次数

loopDelay

Long loopDelay

循环延迟时间,单位:毫秒

messageList

List<String> messageList

邀请消息列表 多条自动消息气泡消息内容

name

String name

设置名称，用于区分不同的邀请设置模板

newVisitorMessage

String newVisitorMessage

新访客专属邀请消息

pageStayTriggerSeconds

Integer pageStayTriggerSeconds

页面停留时间触发，单位:秒 访客在页面停留超过指定时间后触发邀请

referrerPatterns

List<String> referrerPatterns

来源URL匹配模式，如搜索引擎、社交媒体等

referrerTrigger

Boolean referrerTrigger

访客来源触发 - 基于访客来源启用邀请

returningVisitorMessage

String returningVisitorMessage

回访访客专属邀请消息

scrollTrigger

Boolean scrollTrigger

页面滚动触发 访客页面滚动超过一定比例后触发邀请

scrollTriggerPerceninviteSettinge

Integer scrollTriggerPerceninviteSettinge

页面滚动触发百分比 (0-100)

show

Boolean show

是否显示邀请

smartTrigger

Boolean smartTrigger

智能触发邀请 - 基于用户行为

targetedInvite

Boolean targetedInvite

定向邀请设置 - 针对特定页面启用邀请

targetedInviteUrls

List<String> targetedInviteUrls

定向邀请页面URL匹配模式 支持精确匹配和通配符模式，如: /products/*, /checkout

text

String text

邀请文本

vipVisitorMessage

String vipVisitorMessage

VIP访客专属邀请消息

visitorSegmentation

Boolean visitorSegmentation

是否启用访客分段邀请 可基于访客特征或行为设置不同邀请消息

Class com.bytedesk.kbase.settings_invite.InviteSettingsRequest

class InviteSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

abTesting

Boolean abTesting

是否启用A/B测试

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

delay

Long delay

邀请延迟时间,单位:毫秒

description

String description

deviceTypes

List<String> deviceTypes

访客设备类型触发 - 可选: desktop, mobile, tablet

exitIntentTrigger

Boolean exitIntentTrigger

退出意图触发

icon

String icon

邀请图标

inviteAnimation

String inviteAnimation

邀请动画效果: fade, slide, bounce, none

inviteStyle

String inviteStyle

邀请样式设置: bubble, card, modal, banner

loop

Boolean loop

是否循环

loopCount

Integer loopCount

循环次数

loopDelay

Long loopDelay

循环延迟时间,单位:毫秒

messageList

List<String> messageList

邀请消息列表

name

String name

newVisitorMessage

String newVisitorMessage

新访客专属邀请消息

pageStayTriggerSeconds

Integer pageStayTriggerSeconds

页面停留时间触发，单位:秒

referrerPatterns

List<String> referrerPatterns

来源URL匹配模式

referrerTrigger

Boolean referrerTrigger

访客来源触发

returningVisitorMessage

String returningVisitorMessage

回访访客专属邀请消息

scrollTrigger

Boolean scrollTrigger

页面滚动触发

scrollTriggerPerceninviteSettinge

Integer scrollTriggerPerceninviteSettinge

页面滚动触发百分比 (0-100) 注意：与后端实体字段保持一致命名

show

Boolean show

是否显示邀请

smartTrigger

Boolean smartTrigger

智能触发邀请 - 基于用户行为

targetedInvite

Boolean targetedInvite

定向邀请设置 - 针对特定页面启用邀请

targetedInviteUrls

List<String> targetedInviteUrls

定向邀请页面URL匹配模式

text

String text

邀请文本

vipVisitorMessage

String vipVisitorMessage

VIP访客专属邀请消息

visitorSegmentation

Boolean visitorSegmentation

是否启用访客分段邀请

Class com.bytedesk.kbase.settings_invite.InviteSettingsResponse

class InviteSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

abTesting

Boolean abTesting

是否启用A/B测试

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

delay

Long delay

邀请延迟时间,单位:毫秒

description

String description

deviceTypes

List<String> deviceTypes

访客设备类型触发 - 可选: desktop, mobile, tablet

exitIntentTrigger

Boolean exitIntentTrigger

退出意图触发

icon

String icon

邀请图标

inviteAnimation

String inviteAnimation

邀请动画效果: fade, slide, bounce, none

inviteStyle

String inviteStyle

邀请样式设置: bubble, card, modal, banner

loop

Boolean loop

是否循环

loopCount

Integer loopCount

循环次数

loopDelay

Long loopDelay

循环延迟时间,单位:毫秒

messageList

List<String> messageList

邀请消息列表

name

String name

newVisitorMessage

String newVisitorMessage

新访客专属邀请消息

pageStayTriggerSeconds

Integer pageStayTriggerSeconds

页面停留时间触发，单位:秒

referrerPatterns

List<String> referrerPatterns

来源URL匹配模式

referrerTrigger

Boolean referrerTrigger

访客来源触发

returningVisitorMessage

String returningVisitorMessage

回访访客专属邀请消息

scrollTrigger

Boolean scrollTrigger

页面滚动触发

scrollTriggerPerceninviteSettinge

Integer scrollTriggerPerceninviteSettinge

页面滚动触发百分比 (0-100) 注意：与后端实体字段保持一致命名

show

Boolean show

是否显示邀请

smartTrigger

Boolean smartTrigger

智能触发邀请 - 基于用户行为

targetedInvite

Boolean targetedInvite

定向邀请设置 - 针对特定页面启用邀请

targetedInviteUrls

List<String> targetedInviteUrls

定向邀请页面URL匹配模式

text

String text

邀请文本

vipVisitorMessage

String vipVisitorMessage

VIP访客专属邀请消息

visitorSegmentation

Boolean visitorSegmentation

是否启用访客分段邀请

Package com.bytedesk.kbase.settings_invite.event

Class com.bytedesk.kbase.settings_invite.event.InviteSettingsCreateEvent

class InviteSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

inviteSetting

InviteSettingsEntity inviteSetting

Class com.bytedesk.kbase.settings_invite.event.InviteSettingsDeleteEvent

class InviteSettingsDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

inviteSetting

InviteSettingsEntity inviteSetting

Class com.bytedesk.kbase.settings_invite.event.InviteSettingsUpdateEvent

class InviteSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

inviteSetting

InviteSettingsEntity inviteSetting

Package com.bytedesk.kbase.settings_ratedown

Class com.bytedesk.kbase.settings_ratedown.RatedownSettingsEntity

class RatedownSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

allowCustomFeedback

Boolean allowCustomFeedback

是否允许用户输入自定义文本反馈

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

enabled

Boolean enabled

是否启用点踩功能

markForQualityInspection

Boolean markForQualityInspection

是否记录点踩的会话到质检系统

maxFeedbackLength

Integer maxFeedbackLength

自定义文本反馈的最大字符限制

maxTagSelection

Integer maxTagSelection

每次点踩允许选择的最大标签数量

name

String name

设置名称，用于区分不同的邀请设置模板

offerHumanAgent

Boolean offerHumanAgent

点踩后是否尝试转人工客服

rateDownTagList

List<String> rateDownTagList

点踩选项

requireFollowup

Boolean requireFollowup

是否需要客服后续跟进点踩反馈

showThankYouMessage

Boolean showThankYouMessage

点踩后是否显示感谢消息

thankYouMessage

String thankYouMessage

感谢消息内容

triggerSatisfactionSurvey

Boolean triggerSatisfactionSurvey

点踩后是否自动触发满意度调查

Class com.bytedesk.kbase.settings_ratedown.RatedownSettingsRequest

class RatedownSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

allowCustomFeedback

Boolean allowCustomFeedback

是否允许用户输入自定义文本反馈

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

enabled

Boolean enabled

是否启用点踩功能

markForQualityInspection

Boolean markForQualityInspection

是否记录点踩的会话到质检系统

maxFeedbackLength

Integer maxFeedbackLength

自定义文本反馈的最大字符限制

maxTagSelection

Integer maxTagSelection

每次点踩允许选择的最大标签数量

name

String name

设置名称，用于区分不同的邀请设置模板

offerHumanAgent

Boolean offerHumanAgent

点踩后是否尝试转人工客服

rateDownTagList

List<String> rateDownTagList

点踩选项

requireFollowup

Boolean requireFollowup

是否需要客服后续跟进点踩反馈

showThankYouMessage

Boolean showThankYouMessage

点踩后是否显示感谢消息

thankYouMessage

String thankYouMessage

感谢消息内容

triggerSatisfactionSurvey

Boolean triggerSatisfactionSurvey

点踩后是否自动触发满意度调查

Class com.bytedesk.kbase.settings_ratedown.RatedownSettingsResponse

class RatedownSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

allowCustomFeedback

Boolean allowCustomFeedback

是否允许用户输入自定义文本反馈

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

enabled

Boolean enabled

是否启用点踩功能

markForQualityInspection

Boolean markForQualityInspection

是否记录点踩的会话到质检系统

maxFeedbackLength

Integer maxFeedbackLength

自定义文本反馈的最大字符限制

maxTagSelection

Integer maxTagSelection

每次点踩允许选择的最大标签数量

name

String name

设置名称，用于区分不同的邀请设置模板

offerHumanAgent

Boolean offerHumanAgent

点踩后是否尝试转人工客服

rateDownTagList

List<String> rateDownTagList

点踩选项

requireFollowup

Boolean requireFollowup

是否需要客服后续跟进点踩反馈

showThankYouMessage

Boolean showThankYouMessage

点踩后是否显示感谢消息

thankYouMessage

String thankYouMessage

感谢消息内容

triggerSatisfactionSurvey

Boolean triggerSatisfactionSurvey

点踩后是否自动触发满意度调查

Package com.bytedesk.kbase.settings_ratedown.event

Class com.bytedesk.kbase.settings_ratedown.event.RatedownSettingsCreateEvent

class RatedownSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ratedownSetting

RatedownSettingsEntity ratedownSetting

Class com.bytedesk.kbase.settings_ratedown.event.RatedownSettingsDeleteEvent

class RatedownSettingsDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ratedownSetting

RatedownSettingsEntity ratedownSetting

Class com.bytedesk.kbase.settings_ratedown.event.RatedownSettingsUpdateEvent

class RatedownSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ratedownSetting

RatedownSettingsEntity ratedownSetting

Package com.bytedesk.kbase.settings_service

Class com.bytedesk.kbase.settings_service.ServiceSettingsEntity

class ServiceSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentCloseTip

String agentCloseTip

autoCloseMin

@NotNull Double autoCloseMin

auto close time in minutes

autoCloseTip

String autoCloseTip

autoInviteRate

@NotNull Boolean autoInviteRate

autoPopup

@NotNull Boolean autoPopup

faqKbUid

String faqKbUid

faqs

List<FaqEntity> faqs

inputAssociationEnabled

Boolean inputAssociationEnabled

inputAssociationKbUid

String inputAssociationKbUid

inputPreviewEnabled

Boolean inputPreviewEnabled

inviteRateTip

String inviteRateTip

language

@NotBlank String language

preFormRequired

@NotNull Boolean preFormRequired

preFormSchema

String preFormSchema

quickButtons

List<QuickButtonEntity> quickButtons

rateMsgCount

@NotNull Integer rateMsgCount

requireLogin

@NotNull Boolean requireLogin

访客发起咨询是否需要登录（未登录则应先登录再创建会话）

rightIframeUrl

String rightIframeUrl

showCaptcha

@NotNull Boolean showCaptcha

showFaqs

Boolean showFaqs

showHistory

@NotNull Boolean showHistory

showLogo

@NotNull Boolean showLogo

showPreForm

@NotNull Boolean showPreForm

showQuickButtons

Boolean showQuickButtons

showRateBtn

@NotNull Boolean showRateBtn

showRightIframe

Boolean showRightIframe

showTopTip

@NotNull Boolean showTopTip

toolbar

ToolbarSettings toolbar

topTip

@NotBlank String topTip

topTipEnd

ZonedDateTime topTipEnd

topTipStart

ZonedDateTime topTipStart

validateUntil

Date validateUntil

welcomeFaqs

List<FaqEntity> welcomeFaqs

welcomeKbUid

String welcomeKbUid

welcomeTip

@NotBlank String welcomeTip

Class com.bytedesk.kbase.settings_service.ServiceSettingsRequest

class ServiceSettingsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

agentCloseTip

String agentCloseTip

autoCloseMin

Double autoCloseMin

auto close time in min - 默认自动关闭时间，单位分钟

autoCloseTip

String autoCloseTip

autoInviteRate

Boolean autoInviteRate

autoPopup

Boolean autoPopup

enableWorkflow

Boolean enableWorkflow

faqKbUid

String faqKbUid

faqUids

List<String> faqUids

inputAssociationEnabled

Boolean inputAssociationEnabled

inputAssociationKbUid

String inputAssociationKbUid

inputPreviewEnabled

Boolean inputPreviewEnabled

inviteRateTip

String inviteRateTip

language

LanguageEnum language

leavemsgTip

String leavemsgTip

preForm

String preForm

preFormRequired

Boolean preFormRequired

queueTip

String queueTip

quickButtonUids

List<String> quickButtonUids

rateMsgCount

Integer rateMsgCount

relatedQuestionGuide

String relatedQuestionGuide

requireLogin

Boolean requireLogin

访客发起咨询是否需要登录（未登录则应先登录再创建会话）

rightIframeUrl

String rightIframeUrl

showCaptcha

Boolean showCaptcha

showFaqs

Boolean showFaqs

showHistory

Boolean showHistory

showLogo

Boolean showLogo

showPreForm

Boolean showPreForm

showQuickButtons

Boolean showQuickButtons

showRateBtn

Boolean showRateBtn

showRightIframe

Boolean showRightIframe

showTopTip

Boolean showTopTip

toolbar

ToolbarSettings toolbar

topTip

String topTip

topTipEnd

ZonedDateTime topTipEnd

topTipStart

ZonedDateTime topTipStart

validateUntil

Date validateUntil

welcomeFaqUids

List<String> welcomeFaqUids

welcomeKbUid

String welcomeKbUid

welcomeTip

String welcomeTip

workflowUid

String workflowUid

Class com.bytedesk.kbase.settings_service.ServiceSettingsResponse

class ServiceSettingsResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

agentCloseTip

String agentCloseTip

autoCloseMin

Double autoCloseMin

auto close time in min - 默认自动关闭时间，单位分钟

autoCloseTip

String autoCloseTip

autoInviteRate

Boolean autoInviteRate

autoPopup

Boolean autoPopup

enableWorkflow

Boolean enableWorkflow

faqKbUid

String faqKbUid

faqs

List<FaqResponse> faqs

inputAssociationEnabled

Boolean inputAssociationEnabled

inputAssociationKbUid

String inputAssociationKbUid

inputPreviewEnabled

Boolean inputPreviewEnabled

inviteRateTip

String inviteRateTip

language

LanguageEnum language

leavemsgTip

String leavemsgTip

preForm

String preForm

preFormRequired

Boolean preFormRequired

queueTip

String queueTip

quickButtons

List<QuickButtonResponse> quickButtons

rateMsgCount

Integer rateMsgCount

requireLogin

Boolean requireLogin

访客发起咨询是否需要登录

rightIframeUrl

String rightIframeUrl

showCaptcha

Boolean showCaptcha

showFaqs

Boolean showFaqs

showHistory

Boolean showHistory

showLogo

Boolean showLogo

showPreForm

Boolean showPreForm

showQuickButtons

Boolean showQuickButtons

showRateBtn

Boolean showRateBtn

showRightIframe

Boolean showRightIframe

showTopTip

Boolean showTopTip

toolbar

ToolbarSettings toolbar

topTip

String topTip

topTipEnd

ZonedDateTime topTipEnd

topTipStart

ZonedDateTime topTipStart

validateUntil

Date validateUntil

welcomeFaqs

List<FaqResponse> welcomeFaqs

welcomeKbUid

String welcomeKbUid

welcomeTip

String welcomeTip

workflowUid

String workflowUid

Class com.bytedesk.kbase.settings_service.ServiceSettingsResponseVisitor

class ServiceSettingsResponseVisitor extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowVisitorManualTransfer

Boolean allowVisitorManualTransfer

autoCloseMin

Double autoCloseMin

auto close time in min - 默认自动关闭时间，单位分钟

autoInviteRate

Boolean autoInviteRate

autoPopup

Boolean autoPopup

faqKbUid

String faqKbUid

faqs

List<FaqResponseVisitor> faqs

inputAssociationEnabled

Boolean inputAssociationEnabled

inputAssociationKbUid

String inputAssociationKbUid

inputPreviewEnabled

Boolean inputPreviewEnabled

inviteRateTip

String inviteRateTip

language

LanguageEnum language

manualTransferLabel

String manualTransferLabel

preForm

String preForm

preFormRequired

Boolean preFormRequired

quickButtons

List<QuickButtonResponseVisitor> quickButtons

rateMsgCount

Integer rateMsgCount

requireLogin

Boolean requireLogin

访客发起咨询是否需要登录

rightIframeUrl

String rightIframeUrl

showCaptcha

Boolean showCaptcha

showFaqs

Boolean showFaqs

showHistory

Boolean showHistory

showLogo

Boolean showLogo

showPreForm

Boolean showPreForm

showQuickButtons

Boolean showQuickButtons

showRateBtn

Boolean showRateBtn

showRightIframe

Boolean showRightIframe

showTopTip

Boolean showTopTip

toolbar

ToolbarSettings toolbar

topTip

String topTip

welcomeFaqs

List<FaqResponseVisitor> welcomeFaqs

welcomeKbUid

String welcomeKbUid

Package com.bytedesk.kbase.settings_summary

Class com.bytedesk.kbase.settings_summary.SummarySettingsEntity

class SummarySettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultTemplate

Boolean defaultTemplate

是否为默认设置模板

description

String description

设置描述

enabled

Boolean enabled

是否启用会话小结

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

设置名称，用于区分不同的会话小结设置模板

robotUid

String robotUid

关联 robot entity uid，用于调用 LLM 进行会话小结

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）（当 executionTiming=ON_MESSAGE 时生效）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率（当 executionTiming=ON_MESSAGE 时生效）：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围（当 executionTiming=ON_MESSAGE 时生效） - VISITOR_ONLY: 仅访客消息 - AGENT_ONLY: 仅客服消息 - ALL: 所有非系统消息

Class com.bytedesk.kbase.settings_summary.SummarySettingsRequest

class SummarySettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用会话小结

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于会话小结的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）（当 executionTiming=ON_MESSAGE 时生效）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率（当 executionTiming=ON_MESSAGE 时生效）：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围（当 executionTiming=ON_MESSAGE 时生效）

Class com.bytedesk.kbase.settings_summary.SummarySettingsResponse

class SummarySettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用会话小结

executionTiming

String executionTiming

执行时机 - ON_MESSAGE: 收到新消息时 - THREAD_END: 会话结束时

name

String name

robotUid

String robotUid

绑定用于会话小结的机器人（RobotEntity.uid）

triggerCooldownOnly

Boolean triggerCooldownOnly

是否仅按时间冷却触发（忽略 triggerEveryNMessages）

triggerCooldownSeconds

Integer triggerCooldownSeconds

触发冷却时间（秒）

triggerEveryNMessages

Integer triggerEveryNMessages

触发频率：每隔 N 条消息触发一次

triggerScope

String triggerScope

触发范围

type

String type

Package com.bytedesk.kbase.settings_trigger

Class com.bytedesk.kbase.settings_trigger.TriggerSettingsEntity

class TriggerSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

triggers

List<TriggerEntity> triggers

触发器列表：仅存放 TriggerEntity 引用。 具体参数与配置存放在 TriggerEntity.config 中。

Class com.bytedesk.kbase.settings_trigger.TriggerSettingsRequest

class TriggerSettingsRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

triggers

List<TriggerRequestSimple> triggers

Trigger entity list to be associated with this settings. - null: do not change existing associations - [] : clear existing associations

Class com.bytedesk.kbase.settings_trigger.TriggerSettingsResponse

class TriggerSettingsResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

triggers

List<TriggerResponseSimple> triggers

Package com.bytedesk.kbase.statistic

Class com.bytedesk.kbase.statistic.KbaseStatisticEntity

class KbaseStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the statistic display

description

String description

Description of the statistic

name

String name

Name of the statistic

order

Integer order

Display order of the statistic

type

String type

Type of statistic (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.kbase.statistic.KbaseStatisticRequest

class KbaseStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.kbase.statistic.KbaseStatisticResponse

class KbaseStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.kbase.statistic.event

Class com.bytedesk.kbase.statistic.event.KbaseStatisticCreateEvent

class KbaseStatisticCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

KbaseStatisticEntity statistic

Class com.bytedesk.kbase.statistic.event.KbaseStatisticDeleteEvent

class KbaseStatisticDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

KbaseStatisticEntity statistic

Class com.bytedesk.kbase.statistic.event.KbaseStatisticUpdateEvent

class KbaseStatisticUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

statistic

KbaseStatisticEntity statistic

Package com.bytedesk.kbase.taboo

Class com.bytedesk.kbase.taboo.TabooEntity

class TabooEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

matchCount

Integer matchCount

reply

String reply

startDate

ZonedDateTime startDate

synonymList

List<String> synonymList

tagList

List<String> tagList

type

String type

Class com.bytedesk.kbase.taboo.TabooRequest

class TabooRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

matchCount

Integer matchCount

reply

String reply

startDate

ZonedDateTime startDate

synonymList

List<String> synonymList

tagList

List<String> tagList

Class com.bytedesk.kbase.taboo.TabooResponse

class TabooResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

enabled

Boolean enabled

endDate

ZonedDateTime endDate

kbUid

String kbUid

matchCount

Integer matchCount

reply

String reply

startDate

ZonedDateTime startDate

synonymList

List<String> synonymList

tagList

List<String> tagList

type

String type

Package com.bytedesk.kbase.taboo_message

Class com.bytedesk.kbase.taboo_message.TabooMessageEntity

class TabooMessageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

messageUid

String messageUid

replacedContent

String replacedContent

tabooWordList

List<String> tabooWordList

threadUid

String threadUid

Class com.bytedesk.kbase.taboo_message.TabooMessageRequest

class TabooMessageRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

messageUid

String messageUid

replacedContent

String replacedContent

tabooWordList

List<String> tabooWordList

threadUid

String threadUid

Class com.bytedesk.kbase.taboo_message.TabooMessageResponse

class TabooMessageResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

content

String content

messageUid

String messageUid

replacedContent

String replacedContent

tabooWordList

List<String> tabooWordList

threadUid

String threadUid

Package com.bytedesk.kbase.taboo_message.event

Class com.bytedesk.kbase.taboo_message.event.TabooMessageCreateEvent

class TabooMessageCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo_message

TabooMessageEntity taboo_message

Class com.bytedesk.kbase.taboo_message.event.TabooMessageDeleteEvent

class TabooMessageDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo_message

TabooMessageEntity taboo_message

Class com.bytedesk.kbase.taboo_message.event.TabooMessageUpdateEvent

class TabooMessageUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo_message

TabooMessageEntity taboo_message

Package com.bytedesk.kbase.taboo.event

Class com.bytedesk.kbase.taboo.event.TabooCreateEvent

class TabooCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo

TabooEntity taboo

Class com.bytedesk.kbase.taboo.event.TabooDeleteEvent

class TabooDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo

TabooEntity taboo

Class com.bytedesk.kbase.taboo.event.TabooUpdateEvent

class TabooUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

taboo

TabooEntity taboo

Package com.bytedesk.kbase.trigger

Class com.bytedesk.kbase.trigger.TriggerEntity

class TriggerEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

config

String config

Trigger config as JSON string. Concrete schema depends on triggerKey.

description

String description

Description of the trigger

enabled

Boolean enabled

Whether this trigger is enabled

name

String name

Name of the trigger

triggerKey

String triggerKey

Trigger behavior key (stable identifier used by runtime).

type

String type

Type of trigger (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.kbase.trigger.TriggerRequest

class TriggerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

Class com.bytedesk.kbase.trigger.TriggerRequestSimple

class TriggerRequestSimple extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

config

String config

JSON config string

description

String description

Display description

enabled

Boolean enabled

Whether enabled

name

String name

Display name

triggerKey

String triggerKey

Stable runtime key identifying trigger behavior

type

String type

Trigger type (THREAD/CUSTOMER/TICKET etc.)

uid

String uid

Existing trigger uid (optional). If present, backend updates the trigger.

Class com.bytedesk.kbase.trigger.TriggerResponse

class TriggerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

config

String config

description

String description

enabled

Boolean enabled

name

String name

triggerKey

String triggerKey

type

String type

Class com.bytedesk.kbase.trigger.TriggerResponseSimple

class TriggerResponseSimple extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

config

String config

description

String description

enabled

Boolean enabled

name

String name

triggerKey

String triggerKey

type

String type

uid

String uid

Package com.bytedesk.kbase.trigger.event

Class com.bytedesk.kbase.trigger.event.AbstractTriggerEvent

class AbstractTriggerEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

trigger

TriggerEntity trigger

Class com.bytedesk.kbase.trigger.event.TriggerCreateEvent

class TriggerCreateEvent extends AbstractTriggerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.trigger.event.TriggerDeleteEvent

class TriggerDeleteEvent extends AbstractTriggerEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.kbase.trigger.event.TriggerUpdateEvent

class TriggerUpdateEvent extends AbstractTriggerEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.agent

Class com.bytedesk.service.agent.AgentEntity

class AgentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentNo

String agentNo

客服工号（对外展示用）

avatar

String avatar

description

String description

email

@Email(message="\u90ae\u7bb1\u683c\u5f0f\u9519\u8bef") String email

enabled

Boolean enabled

extra

String extra

存储当前接待数量等

member

MemberEntity member

mobile

String mobile

nickname

String nickname

settings

AgentSettingsEntity settings

Configuration settings reference All settings are managed through the settings entity

status

String status

Class com.bytedesk.service.agent.AgentProtobuf

class AgentProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

extra

String extra

nickname

String nickname

status

String status

type

String type

uid

String uid

Class com.bytedesk.service.agent.AgentRequest

class AgentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentNo

String agentNo

客服工号（对外展示用）

avatar

String avatar

componentType

String componentType

connected

Boolean connected

description

String description

email

@NotBlank @Email(message="email format error") String email

enabled

Boolean enabled

memberUid

@NotBlank String memberUid

mobile

@NotBlank String mobile

nickname

@NotBlank String nickname

settingsUid

String settingsUid

Agent settings reference UID If not provided, will use the default settings

status

String status

Class com.bytedesk.service.agent.AgentResponse

class AgentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentNo

String agentNo

客服工号（对外展示用）

avatar

String avatar

connected

Boolean connected

description

String description

email

String email

enabled

Boolean enabled

member

MemberProtobuf member

mobile

String mobile

nickname

String nickname

queueStats

AgentQueueStatsResponse queueStats

Agent queue statistics (loaded from queue service)

settings

AgentSettingsResponse settings

Agent settings (loaded from settings entity)

status

String status

userUid

String userUid

Package com.bytedesk.service.agent_message

Class com.bytedesk.service.agent_message.AgentMessageEntity

class AgentMessageEntity extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.agent_settings

Class com.bytedesk.service.agent_settings.AgentRightPanelTab

class AgentRightPanelTab extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

title

String title

Tab title shown in desktop RightPanel

url

String url

Third-party business system URL to be embedded in iframe

Class com.bytedesk.service.agent_settings.AgentSettingsEntity

class AgentSettingsEntity extends BaseSettingsEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentStatusSettings

AgentStatusSettingEntity agentStatusSettings

Agent status settings

autoReplySettings

AutoReplySettingsEntity autoReplySettings

Auto-reply settings

draftAgentStatusSettings

AgentStatusSettingEntity draftAgentStatusSettings

Draft agent status settings

draftAutoReplySettings

AutoReplySettingsEntity draftAutoReplySettings

Draft Auto-reply settings

draftMessageLeaveSettings

MessageLeaveSettingsEntity draftMessageLeaveSettings

Draft Message leave settings

draftQueueSettings

QueueSettingsEntity draftQueueSettings

Draft Queue settings

draftRateDownSettings

RatedownSettingsEntity draftRateDownSettings

Draft Rating down settings

draftRightPanelTabs

List<AgentRightPanelTab> draftRightPanelTabs

Desktop right panel dynamic tabs (draft)

draftWorktimeSettings

WorktimeSettingEntity draftWorktimeSettings

Draft worktime settings reference

maxThreadCount

Integer maxThreadCount

Maximum concurrent threads the agent can handle Moved from AgentEntity to centralize configuration

messageLeaveSettings

MessageLeaveSettingsEntity messageLeaveSettings

Message leave settings

queueSettings

QueueSettingsEntity queueSettings

Queue settings

rateDownSettings

RatedownSettingsEntity rateDownSettings

Rating down settings

rightPanelTabs

List<AgentRightPanelTab> rightPanelTabs

Desktop right panel dynamic tabs (published)

timeoutRemindEnabled

Boolean timeoutRemindEnabled

Whether timeout reminder is enabled for agent

timeoutRemindTime

Integer timeoutRemindTime

Timeout reminder time in minutes

timeoutRemindTip

String timeoutRemindTip

Timeout reminder tip message

worktimeSettings

WorktimeSettingEntity worktimeSettings

Worktime settings reference (shared template)

Class com.bytedesk.service.agent_settings.AgentSettingsRequest

class AgentSettingsRequest extends BaseSettingsRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentStatusSettings

AgentStatusSettingRequest agentStatusSettings

Agent status settings (Agent-specific)

autoReplySettings

AutoReplySettingsRequest autoReplySettings

Auto-reply settings (Agent-specific)

maxThreadCount

Integer maxThreadCount

Maximum concurrent threads the agent can handle

messageLeaveSettings

MessageLeaveSettingsRequest messageLeaveSettings

Message leave settings (Agent-specific)

queueSettings

QueueSettingsRequest queueSettings

Queue settings (Agent-specific)

rateDownSettings

RatedownSettingsRequest rateDownSettings

Rating down settings (Agent-specific)

rightPanelTabs

List<AgentRightPanelTab> rightPanelTabs

Desktop right panel dynamic tabs (draft updates)

timeoutRemindEnabled

Boolean timeoutRemindEnabled

Whether timeout reminder is enabled for agent

timeoutRemindTime

Integer timeoutRemindTime

Timeout reminder time in minutes

timeoutRemindTip

String timeoutRemindTip

Timeout reminder tip message

worktimeSettings

WorktimeSettingRequest worktimeSettings

Worktime settings (Agent-specific)

Class com.bytedesk.service.agent_settings.AgentSettingsResponse

class AgentSettingsResponse extends BaseSettingsResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentStatusSettings

AgentStatusSettingResponse agentStatusSettings

Agent status settings (Agent-specific)

autoReplySettings

AutoReplySettingsResponse autoReplySettings

Auto-reply settings (Agent-specific)

draftAgentStatusSettings

AgentStatusSettingResponse draftAgentStatusSettings

Draft agent status settings (Agent-specific)

draftAutoReplySettings

AutoReplySettingsResponse draftAutoReplySettings

Draft auto-reply settings (Agent-specific)

draftMessageLeaveSettings

MessageLeaveSettingsResponse draftMessageLeaveSettings

Draft message leave settings (Agent-specific)

draftQueueSettings

QueueSettingsResponse draftQueueSettings

Draft queue settings (Agent-specific)

draftRateDownSettings

RatedownSettingsResponse draftRateDownSettings

Draft rating down settings (Agent-specific)

draftRightPanelTabs

List<AgentRightPanelTab> draftRightPanelTabs

Desktop right panel dynamic tabs (draft)

draftWorktimeSettings

WorktimeSettingResponse draftWorktimeSettings

Draft worktime settings reference (Agent-specific)

maxThreadCount

Integer maxThreadCount

Maximum concurrent threads the agent can handle

messageLeaveSettings

MessageLeaveSettingsResponse messageLeaveSettings

Message leave settings (Agent-specific)

queueSettings

QueueSettingsResponse queueSettings

Queue settings (Agent-specific)

rateDownSettings

RatedownSettingsResponse rateDownSettings

Rating down settings (Agent-specific)

rightPanelTabs

List<AgentRightPanelTab> rightPanelTabs

Desktop right panel dynamic tabs (published)

timeoutRemindEnabled

Boolean timeoutRemindEnabled

Whether timeout reminder is enabled for agent

timeoutRemindTime

Integer timeoutRemindTime

Timeout reminder time in minutes

timeoutRemindTip

String timeoutRemindTip

Timeout reminder tip message

worktimeSettings

WorktimeSettingResponse worktimeSettings

Worktime settings reference (Agent-specific)

Package com.bytedesk.service.agent_settings.event

Class com.bytedesk.service.agent_settings.event.AgentSettingsCreateEvent

class AgentSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

agentSettings

AgentSettingsEntity agentSettings

Class com.bytedesk.service.agent_settings.event.AgentSettingsUpdateEvent

class AgentSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

agentSettings

AgentSettingsEntity agentSettings

Package com.bytedesk.service.agent_status

Class com.bytedesk.service.agent_status.AgentStatusEntity

class AgentStatusEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

durationSeconds

Long durationSeconds

Duration (in seconds) that the agent stayed in this status before switching.

status

String status

Class com.bytedesk.service.agent_status.AgentStatusRequest

class AgentStatusRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

durationSeconds

Long durationSeconds

status

String status

Class com.bytedesk.service.agent_status.AgentStatusResponse

class AgentStatusResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

UserProtobuf agent

durationSeconds

Long durationSeconds

status

String status

Package com.bytedesk.service.agent_status.settings

Class com.bytedesk.service.agent_status.settings.AgentStatusSettingEntity

class AgentStatusSettingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

needReview

Boolean needReview

reviewEndTime

String reviewEndTime

reviewMethod

String reviewMethod

reviewStartTime

String reviewStartTime

reviewTimeoutMinutes

Integer reviewTimeoutMinutes

reviewTimeType

String reviewTimeType

Class com.bytedesk.service.agent_status.settings.AgentStatusSettingRequest

class AgentStatusSettingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

needReview

Boolean needReview

reviewEndTime

String reviewEndTime

reviewMethod

String reviewMethod

reviewStartTime

String reviewStartTime

reviewTimeoutMinutes

Integer reviewTimeoutMinutes

reviewTimeType

String reviewTimeType

Class com.bytedesk.service.agent_status.settings.AgentStatusSettingResponse

class AgentStatusSettingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

needReview

Boolean needReview

reviewEndTime

String reviewEndTime

reviewMethod

String reviewMethod

reviewStartTime

String reviewStartTime

reviewTimeoutMinutes

Integer reviewTimeoutMinutes

reviewTimeType

String reviewTimeType

Package com.bytedesk.service.agent_status.settings.event

Class com.bytedesk.service.agent_status.settings.event.AgentStatusSettingCreateEvent

class AgentStatusSettingCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

AgentStatusSettingEntity tag

Class com.bytedesk.service.agent_status.settings.event.AgentStatusSettingDeleteEvent

class AgentStatusSettingDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

AgentStatusSettingEntity tag

Class com.bytedesk.service.agent_status.settings.event.AgentStatusSettingUpdateEvent

class AgentStatusSettingUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

AgentStatusSettingEntity tag

Package com.bytedesk.service.agent.event

Class com.bytedesk.service.agent.event.AbstractAgentEvent

class AbstractAgentEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

AgentEntity agent

Class com.bytedesk.service.agent.event.AgentCreateEvent

class AgentCreateEvent extends AbstractAgentEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.agent.event.AgentUpdateEvent

class AgentUpdateEvent extends AbstractAgentEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

updateType

String updateType

Class com.bytedesk.service.agent.event.AgentUpdateStatusEvent

class AgentUpdateStatusEvent extends AbstractAgentEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.browse

Class com.bytedesk.service.browse.BrowseEntity

class BrowseEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

browser

String browser

浏览器类型及版本。 记录用户使用的浏览器类型及版本号。

deviceType

String deviceType

设备类型。 可能的值包括：desktop（桌面设备）, mobile（移动设备）, tablet（平板设备）。

duration

Long duration

停留时长（单位：秒）。 记录用户在当前页面的停留时间。

eventData

String eventData

事件信息。 记录用户在页面上执行的具体操作，如点击按钮、滚动页面等。 可选字段，格式通常为JSON字符串。

geoLocation

String geoLocation

地理位置信息。 根据IP地址解析的用户地理位置，通常包含国家、地区、城市等信息。

ipAddress

String ipAddress

IP地址。 记录用户访问时的IP地址。

operatingSystem

String operatingSystem

操作系统。 记录用户使用的操作系统类型及版本。

pageLoadTime

Long pageLoadTime

页面加载时间（单位：毫秒）。 记录页面完全加载所需的时间，用于分析页面性能。

referrer

String referrer

落地页：来源页面URL。 记录用户从哪个页面跳转而来，用于分析流量来源。

screenResolution

String screenResolution

屏幕分辨率。 记录用户设备的屏幕分辨率，格式如"1920x1080"。

sessionId

String sessionId

会话ID。 用于跟踪同一会话中的多个页面浏览，标识用户的一次访问会话。

title

String title

浏览的标题。 记录用户当前访问页面的标题。

url

String url

对话页面：浏览的URL。 记录用户当前访问的页面地址。

userAgent

String userAgent

用户代理(User-Agent)。 记录用户浏览器发送的User-Agent头信息。

utmCampaign

String utmCampaign

UTM活动参数。 记录特定的营销活动名称。 用于营销效果跟踪。

utmMedium

String utmMedium

UTM媒介参数。 记录营销媒介，如"cpc"、"email"等。 用于营销效果跟踪。

utmSource

String utmSource

UTM来源参数。 记录流量来源，如"google"、"newsletter"等。 用于营销效果跟踪。

visitor

VisitorEntity visitor

访客实体。 与该浏览记录关联的访客信息。

Class com.bytedesk.service.browse.BrowseExcel

class BrowseExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

browser

String browser

浏览器类型及版本

createdAt

ZonedDateTime createdAt

创建时间

deviceType

String deviceType

设备类型

duration

Long duration

停留时长（秒）

geoLocation

String geoLocation

地理位置信息

ipAddress

String ipAddress

IP地址

operatingSystem

String operatingSystem

操作系统

pageLoadTime

Long pageLoadTime

页面加载时间（毫秒）

referrer

String referrer

来源页面URL

screenResolution

String screenResolution

屏幕分辨率

sessionId

String sessionId

会话ID

title

String title

浏览的标题

url

String url

浏览的URL

utmCampaign

String utmCampaign

UTM活动参数

utmMedium

String utmMedium

UTM媒介参数

utmSource

String utmSource

UTM来源参数

visitorNickname

String visitorNickname

访客昵称

visitorUid

String visitorUid

访客ID

Class com.bytedesk.service.browse.BrowseRequest

class BrowseRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

browser

String browser

deviceType

String deviceType

duration

Long duration

endDate

String endDate

eventData

String eventData

geoLocation

String geoLocation

ipAddress

String ipAddress

operatingSystem

String operatingSystem

pageLoadTime

Long pageLoadTime

referrer

String referrer

screenResolution

String screenResolution

sessionId

String sessionId

startDate

String startDate

title

String title

url

String url

userAgent

String userAgent

utmCampaign

String utmCampaign

utmMedium

String utmMedium

utmSource

String utmSource

visitorUid

String visitorUid

Class com.bytedesk.service.browse.BrowseResponse

class BrowseResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

browser

String browser

deviceType

String deviceType

duration

Long duration

eventData

String eventData

geoLocation

String geoLocation

ipAddress

String ipAddress

operatingSystem

String operatingSystem

pageLoadTime

Long pageLoadTime

referrer

String referrer

screenResolution

String screenResolution

sessionId

String sessionId

title

String title

url

String url

userAgent

String userAgent

utmCampaign

String utmCampaign

utmMedium

String utmMedium

utmSource

String utmSource

visitor

VisitorResponse visitor

Package com.bytedesk.service.channel_app

Class com.bytedesk.service.channel_app.ChannelAppEntity

class ChannelAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

appKey

String appKey

appPackage

String appPackage

appPlatform

String appPlatform

description

String description

name

String name

Class com.bytedesk.service.channel_app.ChannelAppRequest

class ChannelAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

appKey

String appKey

appPackage

String appPackage

appPlatform

String appPlatform

description

String description

name

String name

Class com.bytedesk.service.channel_app.ChannelAppResponse

class ChannelAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

appKey

String appKey

appPackage

String appPackage

appPlatform

String appPlatform

description

String description

name

String name

Package com.bytedesk.service.channel_app.event

Class com.bytedesk.service.channel_app.event.ChannelAppCreateEvent

class ChannelAppCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

ChannelAppEntity app

Class com.bytedesk.service.channel_app.event.ChannelAppDeleteEvent

class ChannelAppDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

ChannelAppEntity app

Class com.bytedesk.service.channel_app.event.ChannelAppUpdateEvent

class ChannelAppUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

ChannelAppEntity app

Package com.bytedesk.service.customer

Class com.bytedesk.service.customer.CustomerEntity

class CustomerEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Customer description or notes

email

String email

Customer's email address for communication

extra

String extra

Additional customer information stored as JSON format for extensibility

mobile

String mobile

Customer's mobile phone number

nickname

String nickname

Customer's display name or nickname

notes

String notes

Additional notes or comments about the customer

tagList

List<String> tagList

Tags for customer categorization and search

visitorUid

String visitorUid

Associated visitor UID for tracking customer journey

Class com.bytedesk.service.customer.CustomerExcel

class CustomerExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

email

String email

extra

String extra

mobile

String mobile

nickname

String nickname

notes

String notes

Class com.bytedesk.service.customer.CustomerRequest

class CustomerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

email

String email

extra

String extra

mobile

String mobile

nickname

String nickname

notes

String notes

tagList

List<String> tagList

visitorUid

String visitorUid

Class com.bytedesk.service.customer.CustomerResponse

class CustomerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

email

String email

extra

String extra

mobile

String mobile

nickname

String nickname

notes

String notes

tagList

List<String> tagList

visitorUid

String visitorUid

Package com.bytedesk.service.form

Class com.bytedesk.service.form.FormEntity

class FormEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the form's purpose

formVersion

Integer formVersion

表单 schema 业务版本号（用于表单结果快照），与 BaseEntity.version（乐观锁）不同

name

String name

Name or title of the form

schema

String schema

Form structure definition stored as JSON format Contains the complete form schema generated by frontend low-code editor

status

String status

Current status of the form (DRAFT, PUBLISHED, ARCHIVED, DISABLED)

type

String type

Form type (TICKET, THREAD, FLOW, etc.)

Class com.bytedesk.service.form.FormRequest

class FormRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

formVersion

Integer formVersion

name

String name

schema

String schema

status

String status

Class com.bytedesk.service.form.FormResponse

class FormResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

formVersion

Integer formVersion

name

String name

schema

String schema

status

String status

type

String type

Package com.bytedesk.service.form_result

Class com.bytedesk.service.form_result.FormResultEntity

class FormResultEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

formData

String formData

表单数据 - 存储用户填写的表单数据，JSON格式

formUid

String formUid

关联的表单UID - 引用FormEntity的uid

formVersion

Integer formVersion

表单版本号 - 记录提交时表单的版本

type

String type

表单结果类型

user

String user

提交者信息的JSON表示

Class com.bytedesk.service.form_result.FormResultRequest

class FormResultRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

formData

String formData

formUid

String formUid

formVersion

Integer formVersion

user

String user

提交者信息的JSON表示

Class com.bytedesk.service.form_result.FormResultResponse

class FormResultResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

formData

String formData

formUid

String formUid

formVersion

Integer formVersion

type

String type

user

String user

提交者信息的JSON表示

Package com.bytedesk.service.form_result.event

Class com.bytedesk.service.form_result.event.AbstractFormResultEvent

class AbstractFormResultEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

formResult

FormResultEntity formResult

Class com.bytedesk.service.form_result.event.FormResultCreateEvent

class FormResultCreateEvent extends AbstractFormResultEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.form_result.event.FormResultDeleteEvent

class FormResultDeleteEvent extends AbstractFormResultEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.form_result.event.FormResultUpdateEvent

class FormResultUpdateEvent extends AbstractFormResultEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.form.event

Class com.bytedesk.service.form.event.FormCreateEvent

class FormCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

FormEntity tag

Class com.bytedesk.service.form.event.FormDeleteEvent

class FormDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

FormEntity tag

Class com.bytedesk.service.form.event.FormUpdateEvent

class FormUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

FormEntity tag

Package com.bytedesk.service.holiday

Class com.bytedesk.service.holiday.HolidayEntity

class HolidayEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

allDay

Boolean allDay

alternativeGroupId

String alternativeGroupId

alternativeWelcome

String alternativeWelcome

autoReplyContent

String autoReplyContent

autoReplyEnabled

Boolean autoReplyEnabled

customerNotice

String customerNotice

dayOfMonth

Integer dayOfMonth

description

String description

endDate

Date endDate

endTime

String endTime

isOfficial

Boolean isOfficial

isWeekend

Boolean isWeekend

name

String name

repeatEndDate

Date repeatEndDate

repeatType

String repeatType

servicePaused

Boolean servicePaused

startDate

Date startDate

startTime

String startTime

type

String type

weekday

Integer weekday

Class com.bytedesk.service.holiday.HolidayRequest

class HolidayRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.holiday.HolidayResponse

class HolidayResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.holiday.event

Class com.bytedesk.service.holiday.event.HolidayCreateEvent

class HolidayCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

holiday

HolidayEntity holiday

Class com.bytedesk.service.holiday.event.HolidayDeleteEvent

class HolidayDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

holiday

HolidayEntity holiday

Class com.bytedesk.service.holiday.event.HolidayUpdateEvent

class HolidayUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

holiday

HolidayEntity holiday

Package com.bytedesk.service.message_correction

Class com.bytedesk.service.message_correction.MessageCorrectionEntity

class MessageCorrectionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_correction.MessageCorrectionRequest

class MessageCorrectionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_correction.MessageCorrectionResponse

class MessageCorrectionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_correction.event

Class com.bytedesk.service.message_correction.event.MessageCorrectionCreateEvent

class MessageCorrectionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_correction

MessageCorrectionEntity message_correction

Class com.bytedesk.service.message_correction.event.MessageCorrectionDeleteEvent

class MessageCorrectionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_correction

MessageCorrectionEntity message_correction

Class com.bytedesk.service.message_correction.event.MessageCorrectionUpdateEvent

class MessageCorrectionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_correction

MessageCorrectionEntity message_correction

Package com.bytedesk.service.message_feedback

Class com.bytedesk.service.message_feedback.MessageFeedbackEntity

class MessageFeedbackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_feedback.MessageFeedbackRequest

class MessageFeedbackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_feedback.MessageFeedbackResponse

class MessageFeedbackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_feedback.event

Class com.bytedesk.service.message_feedback.event.MessageFeedbackCreateEvent

class MessageFeedbackCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_feedback

MessageFeedbackEntity message_feedback

Class com.bytedesk.service.message_feedback.event.MessageFeedbackDeleteEvent

class MessageFeedbackDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_feedback

MessageFeedbackEntity message_feedback

Class com.bytedesk.service.message_feedback.event.MessageFeedbackUpdateEvent

class MessageFeedbackUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_feedback

MessageFeedbackEntity message_feedback

Package com.bytedesk.service.message_leave

Class com.bytedesk.service.message_leave.MessageLeaveEntity

class MessageLeaveEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

List<String> attachments

URLs of file attachments for the leave message

categoryUid

String categoryUid

Category UID for message classification (consultation, complaint, suggestion, etc.)

channel

String channel

Customer source channel such as website, mobile app, mini-program, etc.

closedAt

ZonedDateTime closedAt

Timestamp when the message was closed

closeUser

String closeUser

Agent who closed the message

confirmedAt

ZonedDateTime confirmedAt

Timestamp when the message was confirmed

confirmUser

String confirmUser

Agent who confirmed the message

contact

String contact

Customer contact information such as email or phone number

content

String content

The main content of the leave message

deviceInfo

String deviceInfo

Customer device information including browser and app version

images

List<String> images

URLs of images attached to the leave message

ipAddress

String ipAddress

Customer's IP address when leaving the message

location

String location

Geographic location information of the customer

messageUid

String messageUid

Associated message UID for updating leave message status

nickname

String nickname

Customer nickname

priority

String priority

Priority level of the leave message (LOW, MEDIUM, HIGH, URGENT)

readAt

ZonedDateTime readAt

Timestamp when the message was read

readUser

String readUser

Agent who read the message

rejectedAt

ZonedDateTime rejectedAt

Timestamp when the message was rejected

rejectUser

String rejectUser

Agent who rejected the message

repliedAt

ZonedDateTime repliedAt

Timestamp when the agent replied to the leave message

replyAttachments

List<String> replyAttachments

URLs of file attachments for the agent's reply

replyContent

String replyContent

Agent's reply content to the leave message

replyImages

List<String> replyImages

URLs of images attached to the agent's reply

replyUser

String replyUser

Agent information who replied to the message stored as JSON string

spamAt

ZonedDateTime spamAt

Timestamp when the message was marked as spam

spamUser

String spamUser

Agent who marked the message as spam

status

String status

Current status of the leave message (PENDING, REPLIED, CLOSED, etc.)

tagList

List<String> tagList

Tags for message categorization and search

targetAgentUid

String targetAgentUid

Target agent UID for transfer

threadUid

String threadUid

Associated thread UID for the conversation

ticketUid

String ticketUid

Associated ticket UID if leave message is converted to ticket

transferredAt

ZonedDateTime transferredAt

Timestamp when the message was transferred

transferUser

String transferUser

Agent who transferred the message

type

String type

Type of the leave message

user

String user

Customer user information stored as JSON string

Class com.bytedesk.service.message_leave.MessageLeaveExcel

class MessageLeaveExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

String attachments

contact

String contact

content

String content

createdAt

String createdAt

images

String images

repliedAt

String repliedAt

reply

String reply

replyAttachments

String replyAttachments

replyImages

String replyImages

replyUser

String replyUser

status

String status

type

String type

user

String user

Class com.bytedesk.service.message_leave.MessageLeaveExtra

class MessageLeaveExtra extends MessageExtra implements Serializable

Serialized Fields

contact

String contact

content

String content

images

List<String> images

nickname

String nickname

replyContent

String replyContent

replyImages

List<String> replyImages

status

String status

type

String type

uid

String uid

Class com.bytedesk.service.message_leave.MessageLeaveRequest

class MessageLeaveRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

List<String> attachments

categoryUid

String categoryUid

closedAt

ZonedDateTime closedAt

closeUser

String closeUser

confirmedAt

ZonedDateTime confirmedAt

confirmUser

String confirmUser

contact

String contact

createdAtEnd

String createdAtEnd

createdAtStart

String createdAtStart

deviceInfo

String deviceInfo

images

List<String> images

ipAddress

String ipAddress

location

String location

messageUid

String messageUid

nickname

String nickname

priority

String priority

readAt

ZonedDateTime readAt

readUser

String readUser

rejectedAt

ZonedDateTime rejectedAt

rejectUser

String rejectUser

repliedAt

ZonedDateTime repliedAt

replyAttachments

List<String> replyAttachments

replyContent

String replyContent

replyImages

List<String> replyImages

replyUser

String replyUser

spamAt

ZonedDateTime spamAt

spamUser

String spamUser

status

String status

tagList

List<String> tagList

targetAgentUid

String targetAgentUid

threadUid

String threadUid

ticketUid

String ticketUid

transferredAt

ZonedDateTime transferredAt

transferUser

String transferUser

user

String user

Class com.bytedesk.service.message_leave.MessageLeaveResponse

class MessageLeaveResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

attachments

List<String> attachments

categoryUid

String categoryUid

channel

String channel

closedAt

ZonedDateTime closedAt

closeUser

UserProtobuf closeUser

confirmedAt

ZonedDateTime confirmedAt

confirmUser

UserProtobuf confirmUser

contact

String contact

content

String content

deviceInfo

String deviceInfo

images

List<String> images

ipAddress

String ipAddress

location

String location

messageUid

String messageUid

nickname

String nickname

priority

String priority

readAt

ZonedDateTime readAt

readUser

UserProtobuf readUser

rejectedAt

ZonedDateTime rejectedAt

rejectUser

UserProtobuf rejectUser

repliedAt

ZonedDateTime repliedAt

replyAttachments

List<String> replyAttachments

replyContent

String replyContent

replyImages

List<String> replyImages

replyUser

UserProtobuf replyUser

spamAt

ZonedDateTime spamAt

spamUser

UserProtobuf spamUser

status

String status

tagList

List<String> tagList

targetAgent

UserProtobuf targetAgent

targetAgentUid

String targetAgentUid

threadUid

String threadUid

ticketUid

String ticketUid

transferredAt

ZonedDateTime transferredAt

transferUser

UserProtobuf transferUser

type

String type

user

UserProtobuf user

Package com.bytedesk.service.message_leave_settings

Class com.bytedesk.service.message_leave_settings.MessageLeaveSettingsEntity

class MessageLeaveSettingsEntity extends BaseEntity implements Serializable

Serialized Fields

messageLeaveAgentUid

String messageLeaveAgentUid

messageLeaveEnabled

Boolean messageLeaveEnabled

messageLeaveForm

String messageLeaveForm

messageLeaveNotify

Boolean messageLeaveNotify

messageLeaveNotifyEmail

String messageLeaveNotifyEmail

messageLeaveNotifyMobile

String messageLeaveNotifyMobile

messageLeaveNotifyType

String messageLeaveNotifyType

messageLeaveTip

@NotBlank String messageLeaveTip

Class com.bytedesk.service.message_leave_settings.MessageLeaveSettingsRequest

class MessageLeaveSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

messageLeaveAgentUid

String messageLeaveAgentUid

messageLeaveEnabled

Boolean messageLeaveEnabled

messageLeaveForm

String messageLeaveForm

messageLeaveNotify

Boolean messageLeaveNotify

messageLeaveNotifyEmail

String messageLeaveNotifyEmail

messageLeaveNotifyMobile

String messageLeaveNotifyMobile

messageLeaveNotifyType

String messageLeaveNotifyType

messageLeaveTip

@NotBlank String messageLeaveTip

Class com.bytedesk.service.message_leave_settings.MessageLeaveSettingsResponse

class MessageLeaveSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

messageLeaveAgentUid

String messageLeaveAgentUid

messageLeaveEnabled

Boolean messageLeaveEnabled

messageLeaveForm

String messageLeaveForm

messageLeaveNotify

Boolean messageLeaveNotify

messageLeaveNotifyEmail

String messageLeaveNotifyEmail

messageLeaveNotifyMobile

String messageLeaveNotifyMobile

messageLeaveNotifyType

String messageLeaveNotifyType

messageLeaveTip

String messageLeaveTip

Package com.bytedesk.service.message_leave.event

Class com.bytedesk.service.message_leave.event.AbstractMessageLeaveEvent

class AbstractMessageLeaveEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

messageLeave

MessageLeaveEntity messageLeave

Class com.bytedesk.service.message_leave.event.MessageLeaveCreateEvent

class MessageLeaveCreateEvent extends AbstractMessageLeaveEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_leave.event.MessageLeaveDeleteEvent

class MessageLeaveDeleteEvent extends AbstractMessageLeaveEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_leave.event.MessageLeaveUpdateEvent

class MessageLeaveUpdateEvent extends AbstractMessageLeaveEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_parsed

Class com.bytedesk.service.message_parsed.MessageParsedEntity

class MessageParsedEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_parsed.MessageParsedRequest

class MessageParsedRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_parsed.MessageParsedResponse

class MessageParsedResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_parsed.event

Class com.bytedesk.service.message_parsed.event.MessageParsedCreateEvent

class MessageParsedCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_parsed

MessageParsedEntity message_parsed

Class com.bytedesk.service.message_parsed.event.MessageParsedDeleteEvent

class MessageParsedDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_parsed

MessageParsedEntity message_parsed

Class com.bytedesk.service.message_parsed.event.MessageParsedUpdateEvent

class MessageParsedUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_parsed

MessageParsedEntity message_parsed

Package com.bytedesk.service.message_rating

Class com.bytedesk.service.message_rating.MessageRatingEntity

class MessageRatingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

faqUid

String faqUid

fromType

String fromType

messageUid

String messageUid

question

String question

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

rateType

String rateType

threadUid

String threadUid

user

String user

Class com.bytedesk.service.message_rating.MessageRatingRequest

class MessageRatingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

faqUid

String faqUid

fromType

String fromType

messageUid

String messageUid

question

String question

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

rateType

String rateType

threadUid

String threadUid

user

String user

Class com.bytedesk.service.message_rating.MessageRatingResponse

class MessageRatingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

answer

String answer

faqUid

String faqUid

fromType

String fromType

messageUid

String messageUid

question

String question

rateDownReason

String rateDownReason

rateDownTagList

List<String> rateDownTagList

rateType

String rateType

threadUid

String threadUid

user

UserProtobuf user

Package com.bytedesk.service.message_rating.event

Class com.bytedesk.service.message_rating.event.MessageRatingCreateEvent

class MessageRatingCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

messageRating

MessageRatingEntity messageRating

Class com.bytedesk.service.message_rating.event.MessageRatingDeleteEvent

class MessageRatingDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

messageRating

MessageRatingEntity messageRating

Class com.bytedesk.service.message_rating.event.MessageRatingUpdateEvent

class MessageRatingUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

messageRating

MessageRatingEntity messageRating

Package com.bytedesk.service.message_template

Class com.bytedesk.service.message_template.MessageTemplateEntity

class MessageTemplateEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Class com.bytedesk.service.message_template.MessageTemplateRequest

class MessageTemplateRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.message_template.MessageTemplateResponse

class MessageTemplateResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.message_template.event

Class com.bytedesk.service.message_template.event.AbstractMessageTemplateEvent

class AbstractMessageTemplateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

template

MessageTemplateEntity template

Class com.bytedesk.service.message_template.event.MessageTemplateCreateEvent

class MessageTemplateCreateEvent extends AbstractMessageTemplateEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_template.event.MessageTemplateDeleteEvent

class MessageTemplateDeleteEvent extends AbstractMessageTemplateEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_template.event.MessageTemplateUpdateEvent

class MessageTemplateUpdateEvent extends AbstractMessageTemplateEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_unanswered

Class com.bytedesk.service.message_unanswered.MessageUnansweredEntity

class MessageUnansweredEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_unanswered.MessageUnansweredRequest

class MessageUnansweredRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.message_unanswered.MessageUnansweredResponse

class MessageUnansweredResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.message_unanswered.event

Class com.bytedesk.service.message_unanswered.event.MessageUnansweredCreateEvent

class MessageUnansweredCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_unanswered

MessageUnansweredEntity message_unanswered

Class com.bytedesk.service.message_unanswered.event.MessageUnansweredDeleteEvent

class MessageUnansweredDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_unanswered

MessageUnansweredEntity message_unanswered

Class com.bytedesk.service.message_unanswered.event.MessageUnansweredUpdateEvent

class MessageUnansweredUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

message_unanswered

MessageUnansweredEntity message_unanswered

Package com.bytedesk.service.quality_appeal

Class com.bytedesk.service.quality_appeal.QualityAppealEntity

class QualityAppealEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

qualityCheck

QualityCheckEntity qualityCheck

被申诉-关联的质量检查

reviewComment

String reviewComment

status

String status

申诉状态

type

String type

Type of appeal (ONLINE_SERVICE, TICKET, etc.)

Class com.bytedesk.service.quality_appeal.QualityAppealRequest

class QualityAppealRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

qualityCheckUid

String qualityCheckUid

reviewComment

String reviewComment

status

String status

申诉状态

Class com.bytedesk.service.quality_appeal.QualityAppealResponse

class QualityAppealResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

qualityCheck

QualityCheckResponse qualityCheck

reviewComment

String reviewComment

status

String status

申诉状态

type

String type

Package com.bytedesk.service.quality_appeal.event

Class com.bytedesk.service.quality_appeal.event.QualityAppealCreateEvent

class QualityAppealCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

appeal

QualityAppealEntity appeal

Class com.bytedesk.service.quality_appeal.event.QualityAppealDeleteEvent

class QualityAppealDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

appeal

QualityAppealEntity appeal

Class com.bytedesk.service.quality_appeal.event.QualityAppealUpdateEvent

class QualityAppealUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

appeal

QualityAppealEntity appeal

Package com.bytedesk.service.quality_check

Class com.bytedesk.service.quality_check.QualityCheckEntity

class QualityCheckEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

indicators

List<QualityIndicator> indicators

质检指标列表 支持多个质检指标，每个指标包含名称、分数、加分、减分、必检等信息

qualityPlanUid

String qualityPlanUid

质量计划

queueMember

QueueMemberEntity queueMember

排队成员

status

String status

Status of the quality check (COMPLETED, APPEALING, etc.) 质检状态：已质检、申诉中等

type

String type

Type of check (ONLINE_SERVICE, TICKET, etc.)

Class com.bytedesk.service.quality_check.QualityCheckRequest

class QualityCheckRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

indicators

List<QualityIndicator> indicators

质检指标列表

qualityPlanUid

String qualityPlanUid

queueMemberUid

String queueMemberUid

status

String status

Class com.bytedesk.service.quality_check.QualityCheckResponse

class QualityCheckResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

bonusScore

Integer bonusScore

加分项总分

comment

String comment

deductionScore

Integer deductionScore

减分项总分

indicators

List<QualityIndicator> indicators

qualityLevel

String qualityLevel

质检评分等级

qualityPlanUid

String qualityPlanUid

queueMember

QueueMemberResponse queueMember

status

String status

totalScore

Integer totalScore

质检总分

type

String type

Package com.bytedesk.service.quality_check.event

Class com.bytedesk.service.quality_check.event.QualityCheckCreateEvent

class QualityCheckCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityCheck

QualityCheckEntity qualityCheck

Class com.bytedesk.service.quality_check.event.QualityCheckDeleteEvent

class QualityCheckDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityCheck

QualityCheckEntity qualityCheck

Class com.bytedesk.service.quality_check.event.QualityCheckUpdateEvent

class QualityCheckUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityCheck

QualityCheckEntity qualityCheck

Package com.bytedesk.service.quality_flow

Class com.bytedesk.service.quality_flow.QualityFlowEntity

class QualityFlowEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the tag

name

String name

Name of the tag

type

String type

Type of tag (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.service.quality_flow.QualityFlowRequest

class QualityFlowRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.quality_flow.QualityFlowResponse

class QualityFlowResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.quality_flow.event

Class com.bytedesk.service.quality_flow.event.QualityFlowCreateEvent

class QualityFlowCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

QualityFlowEntity tag

Class com.bytedesk.service.quality_flow.event.QualityFlowDeleteEvent

class QualityFlowDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

QualityFlowEntity tag

Class com.bytedesk.service.quality_flow.event.QualityFlowUpdateEvent

class QualityFlowUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

QualityFlowEntity tag

Package com.bytedesk.service.quality_plan

Class com.bytedesk.service.quality_plan.QualityIndicator

class QualityIndicator extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

deduction

Boolean deduction

是否为减分指标

description

String description

指标描述

indicatorName

String indicatorName

质检指标名称

indicatorScore

Integer indicatorScore

质检指标分数，仅存放正数，不加负号。例如：5分、10分等

mandatory

Boolean mandatory

是否必检

Class com.bytedesk.service.quality_plan.QualityPlanEntity

class QualityPlanEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the quality plan

enabled

Boolean enabled

Whether this plan is enabled (是否启用)

indicators

List<QualityIndicator> indicators

质检指标列表 支持多个质检指标，每个指标包含名称、分数、加分、减分、必检等信息

name

String name

Name of the quality plan

type

String type

Type of quality plan (ONLINE_SERVICE, BOT, CALL_CENTER, etc.)

Class com.bytedesk.service.quality_plan.QualityPlanRequest

class QualityPlanRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用

indicators

List<QualityIndicator> indicators

质检指标列表

name

String name

Class com.bytedesk.service.quality_plan.QualityPlanResponse

class QualityPlanResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

是否启用

indicators

List<QualityIndicator> indicators

质检指标列表

name

String name

type

String type

Package com.bytedesk.service.quality_plan.event

Class com.bytedesk.service.quality_plan.event.QualityPlanCreateEvent

class QualityPlanCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

plan

QualityPlanEntity plan

Class com.bytedesk.service.quality_plan.event.QualityPlanDeleteEvent

class QualityPlanDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

plan

QualityPlanEntity plan

Class com.bytedesk.service.quality_plan.event.QualityPlanUpdateEvent

class QualityPlanUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

plan

QualityPlanEntity plan

Package com.bytedesk.service.quality_statistic

Class com.bytedesk.service.quality_statistic.QualityStatisticEntity

class QualityStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

appealCount

Integer appealCount

avgBonusScore

double avgBonusScore

avgDeductionScore

double avgDeductionScore

avgScore

double avgScore

channel

String channel

date

String date

excellentCount

Integer excellentCount

failCount

Integer failCount

goodCount

Integer goodCount

hour

Integer hour

passCount

Integer passCount

qualityCheckCount

Integer qualityCheckCount

robotUid

String robotUid

totalThreadCount

Integer totalThreadCount

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.service.quality_statistic.QualityStatisticRequest

class QualityStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

date

String date

endDate

String endDate

hour

Integer hour

robotUid

String robotUid

startDate

String startDate

workgroupUid

String workgroupUid

Class com.bytedesk.service.quality_statistic.QualityStatisticResponse

class QualityStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

appealCount

Integer appealCount

avgBonusScore

double avgBonusScore

avgDeductionScore

double avgDeductionScore

avgScore

double avgScore

channel

String channel

date

String date

excellentCount

Integer excellentCount

failCount

Integer failCount

goodCount

Integer goodCount

hour

Integer hour

passCount

Integer passCount

qualityCheckCount

Integer qualityCheckCount

qualityCheckRate

double qualityCheckRate

计算质检率

robotUid

String robotUid

totalThreadCount

Integer totalThreadCount

type

String type

workgroupUid

String workgroupUid

Package com.bytedesk.service.quality_statistic.event

Class com.bytedesk.service.quality_statistic.event.QualityStatisticCreateEvent

class QualityStatisticCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityStatistic

QualityStatisticEntity qualityStatistic

Class com.bytedesk.service.quality_statistic.event.QualityStatisticDeleteEvent

class QualityStatisticDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityStatistic

QualityStatisticEntity qualityStatistic

Class com.bytedesk.service.quality_statistic.event.QualityStatisticUpdateEvent

class QualityStatisticUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

qualityStatistic

QualityStatisticEntity qualityStatistic

Package com.bytedesk.service.queue

Class com.bytedesk.service.queue.QueueEntity

class QueueEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentQueueMembers

List<QueueMemberEntity> agentQueueMembers

day

String day

nickname

String nickname

robotQueueMembers

List<QueueMemberEntity> robotQueueMembers

status

String status

topic

String topic

type

String type

workgroupQueueMembers

List<QueueMemberEntity> workgroupQueueMembers

Class com.bytedesk.service.queue.QueueExcel

class QueueExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

chattingCount

Integer chattingCount

closedCount

Integer closedCount

day

String day

messageLeaveCount

Integer messageLeaveCount

nickname

String nickname

offlineCount

Integer offlineCount

queuingCount

Integer queuingCount

robotingCount

Integer robotingCount

robotToAgentCount

Integer robotToAgentCount

totalCount

Integer totalCount

type

String type

Class com.bytedesk.service.queue.QueueRequest

class QueueRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

day

String day

nickname

String nickname

status

String status

topic

String topic

Class com.bytedesk.service.queue.QueueResponse

class QueueResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentServedCount

Integer agentServedCount

avgResolveTime

Integer avgResolveTime

avgWaitTime

Integer avgWaitTime

chattingCount

Integer chattingCount

closedCount

Integer closedCount

day

String day

leaveMsgCount

Integer leaveMsgCount

nickname

String nickname

offlineCount

Integer offlineCount

queuingCount

Integer queuingCount

robotingCount

Integer robotingCount

robotToAgentCount

Integer robotToAgentCount

status

String status

threadsCountByHour

List<Integer> threadsCountByHour

topic

String topic

totalCount

Integer totalCount

type

String type

Package com.bytedesk.service.queue_member

Class com.bytedesk.service.queue_member.QueueMemberEntity

class QueueMemberEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agentAcceptedAt

ZonedDateTime agentAcceptedAt

agentAcceptType

String agentAcceptType

客服消息统计： 标记客服是否首次响应 记录首次响应时间 更新最后响应时间 计算平均响应时间（累计平均算法） 追踪最长响应时间 统计客服消息总数

agentAvgResponseLength

Integer agentAvgResponseLength

响应时间计算： 基于访客最后消息时间和客服响应时间计算响应时长 动态更新平均响应时间和最大响应时间

agentClose

Boolean agentClose

agentClosedAt

ZonedDateTime agentClosedAt

agentFirstResponse

Boolean agentFirstResponse

agentFirstResponseAt

ZonedDateTime agentFirstResponseAt

agentLastResponseAt

ZonedDateTime agentLastResponseAt

agentMaxResponseLength

Integer agentMaxResponseLength

agentMessageCount

Integer agentMessageCount

agentOffline

Boolean agentOffline

agentQueue

QueueEntity agentQueue

agentTimeout

Boolean agentTimeout

agentTimeoutAt

ZonedDateTime agentTimeoutAt

agentTimeoutCount

Integer agentTimeoutCount

emotionLastTriggeredAt

ZonedDateTime emotionLastTriggeredAt

情绪分析最近触发时间（用于冷却控制）

emotionType

String emotionType

intentionLastTriggeredAt

ZonedDateTime intentionLastTriggeredAt

意图识别最近触发时间（用于冷却控制）

intentionType

String intentionType

inviteStatus

String inviteStatus

lastNotifiedAt

ZonedDateTime lastNotifiedAt

messageLeave

Boolean messageLeave

messageLeaveAt

ZonedDateTime messageLeaveAt

qualityChecked

Boolean qualityChecked

qualityCheckedAt

ZonedDateTime qualityCheckedAt

qualityCheckScore

Integer qualityCheckScore

queueNumber

Integer queueNumber

rateAt

ZonedDateTime rateAt

rated

Boolean rated

rateScore

Integer rateScore

resolved

Boolean resolved

resolvedStatus

String resolvedStatus

robotAcceptedAt

ZonedDateTime robotAcceptedAt

robotAcceptType

String robotAcceptType

robot 响应时间计算：

robotAvgResponseLength

Integer robotAvgResponseLength

robotClosedAt

ZonedDateTime robotClosedAt

robotFirstResponse

Boolean robotFirstResponse

robotFirstResponseAt

ZonedDateTime robotFirstResponseAt

robotLastResponseAt

ZonedDateTime robotLastResponseAt

robotMaxResponseLength

Integer robotMaxResponseLength

robotMessageCount

Integer robotMessageCount

robotQueue

QueueEntity robotQueue

robotTimeout

Boolean robotTimeout

robotTimeoutAt

ZonedDateTime robotTimeoutAt

robotToAgent

Boolean robotToAgent

robotToAgentAt

ZonedDateTime robotToAgentAt

summarized

Boolean summarized

summaryLastTriggeredAt

ZonedDateTime summaryLastTriggeredAt

会话小结最近触发时间（用于冷却控制）

systemClose

Boolean systemClose

systemClosedAt

ZonedDateTime systemClosedAt

systemFirstResponseAt

ZonedDateTime systemFirstResponseAt

systemLastResponseAt

ZonedDateTime systemLastResponseAt

systemMessageCount

Integer systemMessageCount

thread

ThreadEntity thread

threadEmotionResult

String threadEmotionResult

threadIntentionResult

String threadIntentionResult

threadSummaryResult

String threadSummaryResult

transferStatus

String transferStatus

visitorEnqueueAt

ZonedDateTime visitorEnqueueAt

visitorFirstMessageAt

ZonedDateTime visitorFirstMessageAt

访客消息统计： 记录第一条访客消息的时间 更新最后一条访客消息的时间 统计访客消息总数

visitorLastMessageAt

ZonedDateTime visitorLastMessageAt

visitorLeavedAt

ZonedDateTime visitorLeavedAt

visitorMessageCount

Integer visitorMessageCount

visitorPriority

Integer visitorPriority

workflowQueue

QueueEntity workflowQueue

workgroupQueue

QueueEntity workgroupQueue

Class com.bytedesk.service.queue_member.QueueMemberExcel

class QueueMemberExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

agentAcceptedAt

ZonedDateTime agentAcceptedAt

agentAcceptType

String agentAcceptType

agentFirstResponseLength

Integer agentFirstResponseLength

agentMessageCount

Integer agentMessageCount

agentNickname

String agentNickname

agentOffline

String agentOffline

channel

String channel

messageLeave

String messageLeave

queueNickname

String queueNickname

queueNumber

Integer queueNumber

rateAt

ZonedDateTime rateAt

rated

String rated

rateScore

Integer rateScore

resolved

String resolved

robotAcceptedAt

ZonedDateTime robotAcceptedAt

robotAcceptType

String robotAcceptType

robotMessageCount

Integer robotMessageCount

robotNickname

String robotNickname

robotToAgent

String robotToAgent

robotToAgentAt

ZonedDateTime robotToAgentAt

status

String status

summarized

String summarized

visitorEnqueueAt

ZonedDateTime visitorEnqueueAt

visitorMessageCount

Integer visitorMessageCount

visitorNickname

String visitorNickname

waitLength

Integer waitLength

Class com.bytedesk.service.queue_member.QueueMemberRequest

class QueueMemberRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

agentAcceptedAt

ZonedDateTime agentAcceptedAt

agentAcceptType

String agentAcceptType

agentAvgResponseLength

Integer agentAvgResponseLength

agentClosedAt

ZonedDateTime agentClosedAt

agentFirstResponse

Boolean agentFirstResponse

agentFirstResponseAt

ZonedDateTime agentFirstResponseAt

agentLastResponseAt

ZonedDateTime agentLastResponseAt

agentMaxResponseLength

Integer agentMaxResponseLength

agentMessageCount

Integer agentMessageCount

agentNickname

String agentNickname

agentTimeout

Boolean agentTimeout

agentTimeoutAt

ZonedDateTime agentTimeoutAt

beforeNumber

Integer beforeNumber

emotionType

String emotionType

endDate

String endDate

intentionType

String intentionType

lastNotifiedAt

ZonedDateTime lastNotifiedAt

messageLeave

Boolean messageLeave

messageLeaveAt

ZonedDateTime messageLeaveAt

qualityChecked

Boolean qualityChecked

qualityCheckedAt

ZonedDateTime qualityCheckedAt

qualityCheckScore

Integer qualityCheckScore

queueNickname

String queueNickname

queueNumber

Integer queueNumber

queueUid

String queueUid

rateAt

ZonedDateTime rateAt

rated

Boolean rated

rateScore

Integer rateScore

resolved

Boolean resolved

resolvedStatus

String resolvedStatus

robotNickname

String robotNickname

robotTimeoutAt

ZonedDateTime robotTimeoutAt

robotToAgent

Boolean robotToAgent

robotToAgentAt

ZonedDateTime robotToAgentAt

startDate

String startDate

status

String status

summarized

Boolean summarized

systemMessageCount

Integer systemMessageCount

threadEmotionResult

String threadEmotionResult

threadIntentionResult

String threadIntentionResult

threadSummaryResult

String threadSummaryResult

threadTopic

String threadTopic

threadUid

String threadUid

visitor

String visitor

visitorEnqueueAt

ZonedDateTime visitorEnqueueAt

visitorFirstMessageAt

ZonedDateTime visitorFirstMessageAt

visitorLastMessageAt

ZonedDateTime visitorLastMessageAt

visitorLeavedAt

ZonedDateTime visitorLeavedAt

visitorMessageCount

Integer visitorMessageCount

visitorNickname

String visitorNickname

visitorPriority

Integer visitorPriority

waitLength

Integer waitLength

workgroup

String workgroup

Class com.bytedesk.service.queue_member.QueueMemberResponse

class QueueMemberResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agentAcceptedAt

ZonedDateTime agentAcceptedAt

agentAcceptType

String agentAcceptType

客服消息统计： 标记客服是否首次响应 记录首次响应时间 更新最后响应时间 计算平均响应时间（累计平均算法） 追踪最长响应时间 统计客服消息总数

agentAvgResponseLength

Integer agentAvgResponseLength

响应时间计算： 基于访客最后消息时间和客服响应时间计算响应时长 动态更新平均响应时间和最大响应时间

agentClose

Boolean agentClose

agentClosedAt

ZonedDateTime agentClosedAt

agentFirstResponse

Boolean agentFirstResponse

agentFirstResponseAt

ZonedDateTime agentFirstResponseAt

agentFirstResponseLength

Integer agentFirstResponseLength

agentLastResponseAt

ZonedDateTime agentLastResponseAt

agentMaxResponseLength

Integer agentMaxResponseLength

agentMessageCount

Integer agentMessageCount

agentOffline

Boolean agentOffline

agentTimeout

Boolean agentTimeout

agentTimeoutAt

ZonedDateTime agentTimeoutAt

agentTimeoutCount

Integer agentTimeoutCount

emotionType

String emotionType

intentionType

String intentionType

inviteStatus

String inviteStatus

lastNotifiedAt

ZonedDateTime lastNotifiedAt

messageLeave

Boolean messageLeave

messageLeaveAt

ZonedDateTime messageLeaveAt

qualityChecked

Boolean qualityChecked

qualityCheckedAt

ZonedDateTime qualityCheckedAt

qualityCheckScore

Integer qualityCheckScore

queue

QueueResponse queue

queueNumber

Integer queueNumber

rateAt

ZonedDateTime rateAt

rated

Boolean rated

rateScore

Integer rateScore

resolved

Boolean resolved

resolvedStatus

String resolvedStatus

robotAcceptedAt

ZonedDateTime robotAcceptedAt

robotAcceptType

String robotAcceptType

robot 响应时间计算：

robotAvgResponseLength

Integer robotAvgResponseLength

robotClosedAt

ZonedDateTime robotClosedAt

robotFirstResponse

Boolean robotFirstResponse

robotFirstResponseAt

ZonedDateTime robotFirstResponseAt

robotLastResponseAt

ZonedDateTime robotLastResponseAt

robotMaxResponseLength

Integer robotMaxResponseLength

robotMessageCount

Integer robotMessageCount

robotTimeout

Boolean robotTimeout

robotTimeoutAt

ZonedDateTime robotTimeoutAt

robotToAgent

Boolean robotToAgent

robotToAgentAt

ZonedDateTime robotToAgentAt

status

String status

summarized

Boolean summarized

systemClose

Boolean systemClose

systemClosedAt

ZonedDateTime systemClosedAt

systemFirstResponseAt

ZonedDateTime systemFirstResponseAt

systemLastResponseAt

ZonedDateTime systemLastResponseAt

systemMessageCount

Integer systemMessageCount

thread

ThreadResponse thread

threadEmotionResult

String threadEmotionResult

threadIntentionResult

String threadIntentionResult

threadSummaryResult

String threadSummaryResult

transferStatus

String transferStatus

visitorEnqueueAt

ZonedDateTime visitorEnqueueAt

访客消息统计： 记录第一条访客消息的时间 更新最后一条访客消息的时间 统计访客消息总数

visitorFirstMessageAt

ZonedDateTime visitorFirstMessageAt

visitorLastMessageAt

ZonedDateTime visitorLastMessageAt

visitorLeavedAt

ZonedDateTime visitorLeavedAt

visitorMessageCount

Integer visitorMessageCount

visitorPriority

Integer visitorPriority

waitLength

Integer waitLength

Package com.bytedesk.service.queue_member.event

Class com.bytedesk.service.queue_member.event.QueueMemberCreateEvent

class QueueMemberCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

member

QueueMemberEntity member

Class com.bytedesk.service.queue_member.event.QueueMemberUpdateEvent

class QueueMemberUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

counter

QueueMemberEntity counter

Package com.bytedesk.service.queue_settings

Class com.bytedesk.service.queue_settings.QueueSettingsEntity

class QueueSettingsEntity extends BaseEntity implements Serializable

Serialized Fields

avgWaitTimePerPerson

Integer avgWaitTimePerPerson

maxWaiting

Integer maxWaiting

maxWaitTime

Integer maxWaitTime

queueReadyTip

String queueReadyTip

queueRobot

Boolean queueRobot

queueTip

@NotBlank String queueTip

showEstimatedWaitTime

Boolean showEstimatedWaitTime

showQueuePosition

Boolean showQueuePosition

Class com.bytedesk.service.queue_settings.QueueSettingsRequest

class QueueSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avgWaitTimePerPerson

Integer avgWaitTimePerPerson

maxWaiting

Integer maxWaiting

maxWaitTime

Integer maxWaitTime

queueReadyTip

String queueReadyTip

queueTip

@NotBlank String queueTip

showEstimatedWaitTime

Boolean showEstimatedWaitTime

showQueuePosition

Boolean showQueuePosition

Class com.bytedesk.service.queue_settings.QueueSettingsResponse

class QueueSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avgWaitTimePerPerson

Integer avgWaitTimePerPerson

maxWaiting

Integer maxWaiting

maxWaitTime

Integer maxWaitTime

queueReadyTip

String queueReadyTip

queueTip

String queueTip

showEstimatedWaitTime

Boolean showEstimatedWaitTime

showQueuePosition

Boolean showQueuePosition

Package com.bytedesk.service.queue.exception

Exception com.bytedesk.service.queue.exception.QueueFullException

class QueueFullException extends RuntimeException implements Serializable

Exception com.bytedesk.service.queue.exception.QueueMemberAlreadyExistsException

class QueueMemberAlreadyExistsException extends RuntimeException implements Serializable

Package com.bytedesk.service.robot_to_agent_settings

Class com.bytedesk.service.robot_to_agent_settings.RobotToAgentSettingsEntity

class RobotToAgentSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

allowVisitorManualTransfer

Boolean allowVisitorManualTransfer

enabled

Boolean enabled

keywordTriggerEnabled

Boolean keywordTriggerEnabled

manualTransferLabel

String manualTransferLabel

triggerKeywords

List<String> triggerKeywords

Class com.bytedesk.service.robot_to_agent_settings.RobotToAgentSettingsRequest

class RobotToAgentSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

allowVisitorManualTransfer

Boolean allowVisitorManualTransfer

autoTransferDelaySeconds

Integer autoTransferDelaySeconds

cooldownSeconds

Integer cooldownSeconds

enabled

Boolean enabled

keywordTriggerEnabled

Boolean keywordTriggerEnabled

manualTransferLabel

String manualTransferLabel

maxRobotRepliesBeforeTransfer

Integer maxRobotRepliesBeforeTransfer

minConfidence

Integer minConfidence

triggerKeywords

List<String> triggerKeywords

Class com.bytedesk.service.robot_to_agent_settings.RobotToAgentSettingsResponse

class RobotToAgentSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

allowVisitorManualTransfer

Boolean allowVisitorManualTransfer

autoTransferDelaySeconds

Integer autoTransferDelaySeconds

cooldownSeconds

Integer cooldownSeconds

enabled

Boolean enabled

keywordTriggerEnabled

Boolean keywordTriggerEnabled

manualTransferLabel

String manualTransferLabel

maxRobotRepliesBeforeTransfer

Integer maxRobotRepliesBeforeTransfer

minConfidence

Integer minConfidence

triggerKeywords

List<String> triggerKeywords

Package com.bytedesk.service.robot_to_agent_settings.event

Class com.bytedesk.service.robot_to_agent_settings.event.VisitorRobotMessageEvent

class VisitorRobotMessageEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

messageJson

String messageJson

Package com.bytedesk.service.routing_queue

Class com.bytedesk.service.routing_queue.RoutingQueueEntity

class RoutingQueueEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Class com.bytedesk.service.routing_queue.RoutingQueueRequest

class RoutingQueueRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.routing_queue.RoutingQueueResponse

class RoutingQueueResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.routing_queue.event

Class com.bytedesk.service.routing_queue.event.RoutingQueueCreateEvent

class RoutingQueueCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingQueueEntity tag

Class com.bytedesk.service.routing_queue.event.RoutingQueueDeleteEvent

class RoutingQueueDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingQueueEntity tag

Class com.bytedesk.service.routing_queue.event.RoutingQueueUpdateEvent

class RoutingQueueUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingQueueEntity tag

Package com.bytedesk.service.routing_rule

Class com.bytedesk.service.routing_rule.RoutingRuleEntity

class RoutingRuleEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

type

String type

Class com.bytedesk.service.routing_rule.RoutingRuleRequest

class RoutingRuleRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.routing_rule.RoutingRuleResponse

class RoutingRuleResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.routing_rule.event

Class com.bytedesk.service.routing_rule.event.RoutingRuleCreateEvent

class RoutingRuleCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingRuleEntity tag

Class com.bytedesk.service.routing_rule.event.RoutingRuleDeleteEvent

class RoutingRuleDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingRuleEntity tag

Class com.bytedesk.service.routing_rule.event.RoutingRuleUpdateEvent

class RoutingRuleUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

tag

RoutingRuleEntity tag

Package com.bytedesk.service.screen

Class com.bytedesk.service.screen.ScreenEntity

class ScreenEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the screen display

description

String description

Description of the screen

name

String name

Name of the screen

order

Integer order

Display order of the screen

type

String type

Type of screen (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.service.screen.ScreenRequest

class ScreenRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.screen.ScreenResponse

class ScreenResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.screen.event

Class com.bytedesk.service.screen.event.ScreenCreateEvent

class ScreenCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

screen

ScreenEntity screen

Class com.bytedesk.service.screen.event.ScreenDeleteEvent

class ScreenDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

screen

ScreenEntity screen

Class com.bytedesk.service.screen.event.ScreenUpdateEvent

class ScreenUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

screen

ScreenEntity screen

Package com.bytedesk.service.service_statistic

Class com.bytedesk.service.service_statistic.ServiceStatisticEntity

class ServiceStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

abandonedThreadCount

Integer abandonedThreadCount

abandonRate

double abandonRate

acceptedThreadCount

Integer acceptedThreadCount

acceptRate

double acceptRate

agentMessageCount

Integer agentMessageCount

agentUid

String agentUid

autoAssignedCount

Integer autoAssignedCount

availableAgentCount

Integer availableAgentCount

avgConversationTime

Integer avgConversationTime

avgFirstResponseTime

Integer avgFirstResponseTime

avgMessagePerThread

Integer avgMessagePerThread

avgWaitingTime

Integer avgWaitingTime

awayAgentCount

Integer awayAgentCount

busyAgentCount

Integer busyAgentCount

busyTime

Integer busyTime

channel

String channel

currentThreadCount

Integer currentThreadCount

date

String date

durationOver15Min

Integer durationOver15Min

durationWithin15Min

Integer durationWithin15Min

durationWithin5Min

Integer durationWithin5Min

firstSolveCount

Integer firstSolveCount

firstSolveRate

double firstSolveRate

hour

Integer hour

invitedThreadCount

Integer invitedThreadCount

manualAssignedCount

Integer manualAssignedCount

maxResponseTime

Integer maxResponseTime

maxWaitingTime

Integer maxWaitingTime

minResponseTime

Integer minResponseTime

offlineAgentCount

Integer offlineAgentCount

offlineTime

Integer offlineTime

onlineAgentCount

Integer onlineAgentCount

onlineTime

Integer onlineTime

queuingThreadCount

Integer queuingThreadCount

ratingRate

double ratingRate

responseOver5Min

Integer responseOver5Min

responseWithin1Min

Integer responseWithin1Min

responseWithin5Min

Integer responseWithin5Min

robotSolveRate

double robotSolveRate

robotThreadCount

Integer robotThreadCount

robotToHumanCount

Integer robotToHumanCount

robotUid

String robotUid

satisfactionRate

double satisfactionRate

satisfiedRatingCount

Integer satisfiedRatingCount

timeoutTransferCount

Integer timeoutTransferCount

totalIncomingThreads

Integer totalIncomingThreads

totalRatingCount

Integer totalRatingCount

transferRate

double transferRate

transferredThreadCount

Integer transferredThreadCount

type

String type

visitorMessageCount

Integer visitorMessageCount

workgroupUid

String workgroupUid

Class com.bytedesk.service.service_statistic.ServiceStatisticRequest

class ServiceStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

date

String date

endDate

String endDate

hour

Integer hour

robotUid

String robotUid

startDate

String startDate

workgroupUid

String workgroupUid

Class com.bytedesk.service.service_statistic.ServiceStatisticResponse

class ServiceStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

abandonedThreadCount

Integer abandonedThreadCount

abandonRate

double abandonRate

acceptedThreadCount

Integer acceptedThreadCount

acceptRate

double acceptRate

agentMessageCount

Integer agentMessageCount

agentUid

String agentUid

autoAssignedCount

Integer autoAssignedCount

availableAgentCount

Integer availableAgentCount

avgConversationTime

Integer avgConversationTime

avgFirstResponseTime

Integer avgFirstResponseTime

avgMessagePerThread

Integer avgMessagePerThread

avgWaitingTime

Integer avgWaitingTime

awayAgentCount

Integer awayAgentCount

busyAgentCount

Integer busyAgentCount

busyTime

Integer busyTime

currentThreadCount

Integer currentThreadCount

date

String date

durationOver15Min

Integer durationOver15Min

durationWithin15Min

Integer durationWithin15Min

durationWithin5Min

Integer durationWithin5Min

firstSolveCount

Integer firstSolveCount

firstSolveRate

double firstSolveRate

hour

Integer hour

invitedThreadCount

Integer invitedThreadCount

manualAssignedCount

Integer manualAssignedCount

maxResponseTime

Integer maxResponseTime

maxWaitingTime

Integer maxWaitingTime

minResponseTime

Integer minResponseTime

offlineAgentCount

Integer offlineAgentCount

offlineTime

Integer offlineTime

onlineAgentCount

Integer onlineAgentCount

onlineTime

Integer onlineTime

queuingThreadCount

Integer queuingThreadCount

ratingRate

double ratingRate

responseOver5Min

Integer responseOver5Min

responseWithin1Min

Integer responseWithin1Min

responseWithin5Min

Integer responseWithin5Min

robotSolveRate

double robotSolveRate

robotThreadCount

Integer robotThreadCount

robotToHumanCount

Integer robotToHumanCount

robotUid

String robotUid

satisfactionRate

double satisfactionRate

satisfiedRatingCount

Integer satisfiedRatingCount

timeoutTransferCount

Integer timeoutTransferCount

totalIncomingThreads

Integer totalIncomingThreads

totalRatingCount

Integer totalRatingCount

transferRate

double transferRate

transferredThreadCount

Integer transferredThreadCount

type

String type

visitorMessageCount

Integer visitorMessageCount

workgroupUid

String workgroupUid

Package com.bytedesk.service.service_statistic.view

Class com.bytedesk.service.service_statistic.view.ViewAgentThreadStats.ViewAgentThreadStatsId

class ViewAgentThreadStatsId extends Object implements Serializable

Serialized Fields

agentUid

String agentUid

orgUid

String orgUid

statDate

LocalDate statDate

statHour

Integer statHour

Package com.bytedesk.service.thread_emotion

Class com.bytedesk.service.thread_emotion.ThreadEmotionEntity

class ThreadEmotionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

solution

String solution

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Class com.bytedesk.service.thread_emotion.ThreadEmotionExcel

class ThreadEmotionExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

createdAt

ZonedDateTime createdAt

solution

String solution

status

String status

tags

String tags

threadUid

String threadUid

title

String title

topic

String topic

type

String type

updatedAt

ZonedDateTime updatedAt

Class com.bytedesk.service.thread_emotion.ThreadEmotionRequest

class ThreadEmotionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Class com.bytedesk.service.thread_emotion.ThreadEmotionResponse

class ThreadEmotionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Package com.bytedesk.service.thread_emotion.event

Class com.bytedesk.service.thread_emotion.event.ThreadEmotionCreateEvent

class ThreadEmotionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadEmotion

ThreadEmotionEntity threadEmotion

Class com.bytedesk.service.thread_emotion.event.ThreadEmotionDeleteEvent

class ThreadEmotionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadEmotion

ThreadEmotionEntity threadEmotion

Class com.bytedesk.service.thread_emotion.event.ThreadEmotionUpdateEvent

class ThreadEmotionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadEmotion

ThreadEmotionEntity threadEmotion

Package com.bytedesk.service.thread_intention

Class com.bytedesk.service.thread_intention.ThreadIntentionEntity

class ThreadIntentionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

solution

String solution

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Class com.bytedesk.service.thread_intention.ThreadIntentionExcel

class ThreadIntentionExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

createdAt

ZonedDateTime createdAt

solution

String solution

status

String status

tags

String tags

threadUid

String threadUid

title

String title

topic

String topic

type

String type

updatedAt

ZonedDateTime updatedAt

Class com.bytedesk.service.thread_intention.ThreadIntentionRequest

class ThreadIntentionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Class com.bytedesk.service.thread_intention.ThreadIntentionResponse

class ThreadIntentionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

confidence

Double confidence

content

String content

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

type

String type

Package com.bytedesk.service.thread_intention.event

Class com.bytedesk.service.thread_intention.event.ThreadIntentionCreateEvent

class ThreadIntentionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadIntention

ThreadIntentionEntity threadIntention

Class com.bytedesk.service.thread_intention.event.ThreadIntentionDeleteEvent

class ThreadIntentionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadIntention

ThreadIntentionEntity threadIntention

Class com.bytedesk.service.thread_intention.event.ThreadIntentionUpdateEvent

class ThreadIntentionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadIntention

ThreadIntentionEntity threadIntention

Package com.bytedesk.service.thread_invite

Class com.bytedesk.service.thread_invite.ThreadInviteEntity

class ThreadInviteEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

expireLength

Long expireLength

inviteAt

ZonedDateTime inviteAt

messageUid

String messageUid

note

String note

receiver

String receiver

rejectAt

ZonedDateTime rejectAt

sender

String sender

status

String status

thread

String thread

type

String type

Class com.bytedesk.service.thread_invite.ThreadInviteExcel

class ThreadInviteExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

inviteAt

ZonedDateTime inviteAt

note

String note

receiverNickname

String receiverNickname

rejectAt

ZonedDateTime rejectAt

senderNickname

String senderNickname

status

String status

type

String type

Class com.bytedesk.service.thread_invite.ThreadInviteExtra

class ThreadInviteExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

sender

UserProtobuf sender

status

String status

thread

ThreadProtobuf thread

type

String type

uid

String uid

Class com.bytedesk.service.thread_invite.ThreadInviteRequest

class ThreadInviteRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUid

String agentUid

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

receiverNickname

String receiverNickname

sender

UserProtobuf sender

senderNickname

String senderNickname

status

String status

thread

ThreadProtobuf thread

threadUid

String threadUid

Class com.bytedesk.service.thread_invite.ThreadInviteResponse

class ThreadInviteResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

expireLength

Long expireLength

inviteAt

ZonedDateTime inviteAt

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

rejectAt

ZonedDateTime rejectAt

sender

UserProtobuf sender

status

String status

thread

ThreadProtobuf thread

type

String type

Package com.bytedesk.service.thread_invite.event

Class com.bytedesk.service.thread_invite.event.ThreadInviteCreateEvent

class ThreadInviteCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadInvite

ThreadInviteEntity threadInvite

Class com.bytedesk.service.thread_invite.event.ThreadInviteDeleteEvent

class ThreadInviteDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadInvite

ThreadInviteEntity threadInvite

Class com.bytedesk.service.thread_invite.event.ThreadInviteUpdateEvent

class ThreadInviteUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadInvite

ThreadInviteEntity threadInvite

Package com.bytedesk.service.thread_rating

Class com.bytedesk.service.thread_rating.ThreadRatingEntity

class ThreadRatingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

images

List<String> images

messageUid

String messageUid

resolved

Boolean resolved

score

Integer score

thread

ThreadEntity thread

Class com.bytedesk.service.thread_rating.ThreadRatingExcel

class ThreadRatingExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

comment

String comment

createdAt

ZonedDateTime createdAt

resolved

String resolved

score

Integer score

user

String user

Class com.bytedesk.service.thread_rating.ThreadRatingMessageExtra

class ThreadRatingMessageExtra extends MessageExtra implements Serializable

Serialized Fields

comment

String comment

resolved

Boolean resolved

score

Integer score

Class com.bytedesk.service.thread_rating.ThreadRatingRequest

class ThreadRatingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

messageUid

String messageUid

resolved

Boolean resolved

score

Integer score

threadUid

String threadUid

user

String user

Class com.bytedesk.service.thread_rating.ThreadRatingResponse

class ThreadRatingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

messageUid

String messageUid

resolved

Boolean resolved

score

Integer score

thread

ThreadResponse thread

Package com.bytedesk.service.thread_rating.event

Class com.bytedesk.service.thread_rating.event.ThreadRatingCreateEvent

class ThreadRatingCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadRating

ThreadRatingEntity threadRating

Class com.bytedesk.service.thread_rating.event.ThreadRatingDeleteEvent

class ThreadRatingDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadRating

ThreadRatingEntity threadRating

Class com.bytedesk.service.thread_rating.event.ThreadRatingUpdateEvent

class ThreadRatingUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadRating

ThreadRatingEntity threadRating

Package com.bytedesk.service.thread_summary

Class com.bytedesk.service.thread_summary.ThreadSummaryEntity

class ThreadSummaryEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

Class com.bytedesk.service.thread_summary.ThreadSummaryExcel

class ThreadSummaryExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

createdAt

ZonedDateTime createdAt

solution

String solution

status

String status

tags

String tags

threadUid

String threadUid

title

String title

topic

String topic

updatedAt

ZonedDateTime updatedAt

Class com.bytedesk.service.thread_summary.ThreadSummaryRequest

class ThreadSummaryRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

Class com.bytedesk.service.thread_summary.ThreadSummaryResponse

class ThreadSummaryResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUid

String categoryUid

content

String content

solution

String solution

status

String status

tagList

List<String> tagList

threadUid

String threadUid

title

String title

topic

String topic

Package com.bytedesk.service.thread_summary.event

Class com.bytedesk.service.thread_summary.event.ThreadSummaryCreateEvent

class ThreadSummaryCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadSummary

ThreadSummaryEntity threadSummary

Class com.bytedesk.service.thread_summary.event.ThreadSummaryDeleteEvent

class ThreadSummaryDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadSummary

ThreadSummaryEntity threadSummary

Class com.bytedesk.service.thread_summary.event.ThreadSummaryUpdateEvent

class ThreadSummaryUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadSummary

ThreadSummaryEntity threadSummary

Package com.bytedesk.service.thread_transfer

Class com.bytedesk.service.thread_transfer.ThreadTransferEntity

class ThreadTransferEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

String receiver

rejectAt

ZonedDateTime rejectAt

sender

String sender

status

String status

thread

String thread

transferAt

ZonedDateTime transferAt

type

String type

Class com.bytedesk.service.thread_transfer.ThreadTransferExcel

class ThreadTransferExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

note

String note

receiverNickname

String receiverNickname

rejectAt

ZonedDateTime rejectAt

senderNickname

String senderNickname

status

String status

transferAt

ZonedDateTime transferAt

type

String type

Class com.bytedesk.service.thread_transfer.ThreadTransferExtra

class ThreadTransferExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

sender

UserProtobuf sender

status

String status

thread

ThreadProtobuf thread

type

String type

uid

String uid

Class com.bytedesk.service.thread_transfer.ThreadTransferRequest

class ThreadTransferRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

receiverNickname

String receiverNickname

sender

UserProtobuf sender

senderNickname

String senderNickname

status

String status

thread

ThreadProtobuf thread

threadUid

String threadUid

Class com.bytedesk.service.thread_transfer.ThreadTransferResponse

class ThreadTransferResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptAt

ZonedDateTime acceptAt

cancelAt

ZonedDateTime cancelAt

expireAt

ZonedDateTime expireAt

expireLength

Long expireLength

messageUid

String messageUid

note

String note

receiver

UserProtobuf receiver

rejectAt

ZonedDateTime rejectAt

sender

UserProtobuf sender

status

String status

thread

ThreadProtobuf thread

threadResponse

ThreadResponse threadResponse

transferAt

ZonedDateTime transferAt

type

String type

Package com.bytedesk.service.thread_transfer.event

Class com.bytedesk.service.thread_transfer.event.ThreadTransferCreateEvent

class ThreadTransferCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadTransfer

ThreadTransferEntity threadTransfer

Class com.bytedesk.service.thread_transfer.event.ThreadTransferDeleteEvent

class ThreadTransferDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadTransfer

ThreadTransferEntity threadTransfer

Class com.bytedesk.service.thread_transfer.event.ThreadTransferUpdateEvent

class ThreadTransferUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

threadTransfer

ThreadTransferEntity threadTransfer

Package com.bytedesk.service.transfer_keyword

Class com.bytedesk.service.transfer_keyword.TransferKeywordEntity

class TransferKeywordEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Class com.bytedesk.service.transfer_keyword.TransferKeywordRequest

class TransferKeywordRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.service.transfer_keyword.TransferKeywordResponse

class TransferKeywordResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.service.transfer_keyword.event

Class com.bytedesk.service.transfer_keyword.event.TransferKeywordCreateEvent

class TransferKeywordCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

transfer_keyword

TransferKeywordEntity transfer_keyword

Class com.bytedesk.service.transfer_keyword.event.TransferKeywordDeleteEvent

class TransferKeywordDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

transfer_keyword

TransferKeywordEntity transfer_keyword

Class com.bytedesk.service.transfer_keyword.event.TransferKeywordUpdateEvent

class TransferKeywordUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

transfer_keyword

TransferKeywordEntity transfer_keyword

Package com.bytedesk.service.unified

Class com.bytedesk.service.unified.UnifiedEntity

class UnifiedEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

language

@NotBlank String language

name

String name

nickname

String nickname

routingMode

String routingMode

status

String status

type

String type

welcomeTip

@NotBlank String welcomeTip

workgroups

List<WorkgroupEntity> workgroups

Class com.bytedesk.service.unified.UnifiedRequest

class UnifiedRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

language

String language

name

String name

nickname

@NotBlank String nickname

status

String status

welcomeTip

String welcomeTip

workgroupUids

List<String> workgroupUids

Class com.bytedesk.service.unified.UnifiedResponse

class UnifiedResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

description

String description

language

String language

nickname

String nickname

status

String status

type

String type

welcomeTip

String welcomeTip

workgroups

List<UserProtobuf> workgroups

Package com.bytedesk.service.unified.event

Class com.bytedesk.service.unified.event.UnifiedCreateEvent

class UnifiedCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

unified

UnifiedEntity unified

Class com.bytedesk.service.unified.event.UnifiedDeleteEvent

class UnifiedDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

unified

UnifiedEntity unified

Class com.bytedesk.service.unified.event.UnifiedUpdateEvent

class UnifiedUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

unified

UnifiedEntity unified

Package com.bytedesk.service.visitor

Class com.bytedesk.service.visitor.VisitorEntity

class VisitorEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

channel

String channel

deviceInfo

VisitorDevice deviceInfo

email

String email

extra

String extra

ip

String ip

ipLocation

String ipLocation

lang

String lang

mobile

String mobile

nickname

String nickname

note

String note

status

String status

tagList

List<String> tagList

type

String type

vipLevel

Integer vipLevel

visitorUid

String visitorUid

Class com.bytedesk.service.visitor.VisitorExcel

class VisitorExcel extends BaseExcel implements Serializable

serialVersionUID:

1L

Serialized Fields

channel

String channel

createdAt

ZonedDateTime createdAt

email

String email

ip

String ip

ipLocation

String ipLocation

mobile

String mobile

nickname

String nickname

note

String note

vipLevel

Integer vipLevel

Class com.bytedesk.service.visitor.VisitorExtra

class VisitorExtra extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.visitor.VisitorGoodsInfo

class VisitorGoodsInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

商品描述

extra

String extra

额外信息，可用于存储其他扩展数据

image

String image

商品图片URL

price

Double price

商品价格

tagList

List<String> tagList

商品标签

title

String title

商品标题

uid

String uid

商品唯一标识

url

String url

商品链接URL

Class com.bytedesk.service.visitor.VisitorProtobuf

class VisitorProtobuf extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

extra

String extra

nickname

String nickname

type

String type

uid

String uid

visitorUid

String visitorUid

Class com.bytedesk.service.visitor.VisitorRequest

class VisitorRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

browser

String browser

debug

Boolean debug

device

String device

draft

Boolean draft

email

String email

extra

String extra

forceAgent

Boolean forceAgent

forceNewThread

Boolean forceNewThread

goodsInfo

String goodsInfo

ip

String ip

ipLocation

String ipLocation

lang

String lang

mobile

String mobile

nickname

String nickname

developers can set basic visitor info

note

String note

orderInfo

String orderInfo

os

String os

referrer

String referrer

settingsUid

String settingsUid

sid

String sid

status

String status

tagList

List<String> tagList

title

String title

topic

String topic

url

String url

vipLevel

Integer vipLevel

visitorUid

String visitorUid

Class com.bytedesk.service.visitor.VisitorResponse

class VisitorResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

channel

ChannelEnum channel

deviceInfo

VisitorDevice deviceInfo

email

String email

extra

String extra

ip

String ip

ipLocation

String ipLocation

lang

String lang

mobile

String mobile

nickname

String nickname

developers can set basic visitor info

note

String note

status

String status

tagList

List<String> tagList

type

String type

vipLevel

Integer vipLevel

visitorUid

String visitorUid

Package com.bytedesk.service.visitor_message

Class com.bytedesk.service.visitor_message.VisitorMessage

class VisitorMessage extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.visitor_rating

Class com.bytedesk.service.visitor_rating.VisitorRatingEntity

class VisitorRatingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

comment

String comment

images

List<String> images

score

Integer score

threadUid

String threadUid

topic

String topic

user

String user

Class com.bytedesk.service.visitor_rating.VisitorRatingRequest

class VisitorRatingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

String comment

score

Integer score

threadUid

String threadUid

topic

String topic

user

String user

Class com.bytedesk.service.visitor_rating.VisitorRatingResponse

class VisitorRatingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

UserProtobuf agent

comment

String comment

score

Integer score

threadUid

String threadUid

topic

String topic

user

UserProtobuf user

Package com.bytedesk.service.visitor_thread

Class com.bytedesk.service.visitor_thread.VisitorThreadEntity

class VisitorThreadEntity extends AbstractThreadEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Class com.bytedesk.service.visitor_thread.VisitorThreadRequest

class VisitorThreadRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Class com.bytedesk.service.visitor_thread.VisitorThreadResponse

class VisitorThreadResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorUid

String visitorUid

Package com.bytedesk.service.visitor_token

Class com.bytedesk.service.visitor_token.VisitorTokenEntity

class VisitorTokenEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessVisitorToken

String accessVisitorToken

channel

String channel

clientId

String clientId

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

name

String name

permanent

Boolean permanent

refreshVisitorToken

String refreshVisitorToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

type

String type

Class com.bytedesk.service.visitor_token.VisitorTokenRequest

class VisitorTokenRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessVisitorToken

String accessVisitorToken

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

name

String name

permanent

Boolean permanent

refreshVisitorToken

String refreshVisitorToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

Class com.bytedesk.service.visitor_token.VisitorTokenResponse

class VisitorTokenResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessVisitorToken

String accessVisitorToken

channel

String channel

description

String description

device

String device

expiresAt

ZonedDateTime expiresAt

name

String name

permanent

Boolean permanent

refreshVisitorToken

String refreshVisitorToken

revoked

Boolean revoked

revokeReason

String revokeReason

scope

List<String> scope

type

String type

Package com.bytedesk.service.visitor.event

Class com.bytedesk.service.visitor.event.AbstractVisitorEvent

class AbstractVisitorEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

visitor

VisitorEntity visitor

Class com.bytedesk.service.visitor.event.VisitorBrowseEvent

class VisitorBrowseEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

visitorRequest

VisitorRequest visitorRequest

Class com.bytedesk.service.visitor.event.VisitorCreateEvent

class VisitorCreateEvent extends AbstractVisitorEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.visitor.event.VisitorUpdateEvent

class VisitorUpdateEvent extends AbstractVisitorEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.workgroup

Class com.bytedesk.service.workgroup.WorkgroupEntity

class WorkgroupEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agents

List<AgentEntity> agents

Agents assigned to this workgroup

avatar

String avatar

Workgroup avatar or profile picture URL

description

String description

Description of the workgroup's function

enabled

Boolean enabled

Whether the workgroup is enabled and active

extra

String extra

Additional configuration data stored as JSON

messageLeaveAgent

AgentEntity messageLeaveAgent

Agent responsible for handling offline messages

nickname

@NotBlank String nickname

Display name of the workgroup

settings

WorkgroupSettingsEntity settings

Configuration settings reference All settings are managed through the settings entity

status

String status

Current status of the workgroup (AVAILABLE, BUSY, OFFLINE, etc.)

Class com.bytedesk.service.workgroup.WorkgroupRequest

class WorkgroupRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

agentUids

@NotEmpty(message="agentUids must not be empty") List<String> agentUids

avatar

String avatar

description

String description

enabled

Boolean enabled

messageLeaveAgentUid

String messageLeaveAgentUid

nickname

@NotBlank String nickname

settingsUid

String settingsUid

Workgroup settings reference UID If not provided, will use the default settings

status

String status

Class com.bytedesk.service.workgroup.WorkgroupResponse

class WorkgroupResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

agents

List<AgentResponse> agents

availableAgentCount

Long availableAgentCount

avatar

String avatar

awayAgentCount

Long awayAgentCount

busyAgentCount

Long busyAgentCount

connectedAgentCount

Long connectedAgentCount

connectedAndAvailableAgentCount

Long connectedAndAvailableAgentCount

description

String description

enabled

Boolean enabled

messageLeaveAgent

AgentResponse messageLeaveAgent

nickname

String nickname

offlineAgentCount

Long offlineAgentCount

settings

WorkgroupSettingsResponse settings

Workgroup settings (loaded from settings entity)

status

String status

Package com.bytedesk.service.workgroup_message

Class com.bytedesk.service.workgroup_message.WorkgroupMessageEntity

class WorkgroupMessageEntity extends AbstractMessageEntity implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.workgroup_routing

Class com.bytedesk.service.workgroup_routing.WorkgroupRoutingEntity

class WorkgroupRoutingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

cursor

Long cursor

轮询游标：用于 ROUND_ROBIN 在持久化层维护 nextAgent。

description

String description

Description of the workgroup_routing

name

String name

Name of the workgroup_routing

nextAgentUid

String nextAgentUid

预计算好的“下一个将被分配的客服”UID。

routingExtra

String routingExtra

预留扩展字段（例如缓存可视化需要的快照）。

routingMode

String routingMode

当前使用的路由模式（来自 WorkgroupSettingsEntity.routingMode）。

workgroupUid

String workgroupUid

所属工作组 UID（用于维护该工作组的路由状态）。

Class com.bytedesk.service.workgroup_routing.WorkgroupRoutingRequest

class WorkgroupRoutingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

cursor

Long cursor

轮询游标（ROUND_ROBIN 等模式使用）。

description

String description

name

String name

nextAgentUid

String nextAgentUid

预计算好的“下一个将被分配的客服”UID。

routingExtra

String routingExtra

预留扩展字段。

routingMode

String routingMode

当前路由模式（通常来自 WorkgroupSettingsEntity.routingMode）。

workgroupUid

String workgroupUid

所属工作组 UID（用于维护该工作组的路由状态）。

Class com.bytedesk.service.workgroup_routing.WorkgroupRoutingResponse

class WorkgroupRoutingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

cursor

Long cursor

description

String description

name

String name

nextAgentUid

String nextAgentUid

routingExtra

String routingExtra

routingMode

String routingMode

workgroupUid

String workgroupUid

Package com.bytedesk.service.workgroup_routing.event

Class com.bytedesk.service.workgroup_routing.event.AbstractWorkgroupRoutingEvent

class AbstractWorkgroupRoutingEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workgroupRouting

WorkgroupRoutingEntity workgroupRouting

Class com.bytedesk.service.workgroup_routing.event.WorkgroupRoutingAdvanceEvent

class WorkgroupRoutingAdvanceEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

assignedAgentUid

String assignedAgentUid

workgroupUid

String workgroupUid

Class com.bytedesk.service.workgroup_routing.event.WorkgroupRoutingCreateEvent

class WorkgroupRoutingCreateEvent extends AbstractWorkgroupRoutingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.workgroup_routing.event.WorkgroupRoutingDeleteEvent

class WorkgroupRoutingDeleteEvent extends AbstractWorkgroupRoutingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.service.workgroup_routing.event.WorkgroupRoutingRefreshEvent

class WorkgroupRoutingRefreshEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

reason

String reason

触发原因（用于日志/排查），可为空

workgroupUid

String workgroupUid

Class com.bytedesk.service.workgroup_routing.event.WorkgroupRoutingUpdateEvent

class WorkgroupRoutingUpdateEvent extends AbstractWorkgroupRoutingEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.service.workgroup_settings

Class com.bytedesk.service.workgroup_settings.WorkgroupSettingsEntity

class WorkgroupSettingsEntity extends BaseSettingsEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

draftMessageLeaveSettings

MessageLeaveSettingsEntity draftMessageLeaveSettings

Draft Message leave settings

draftQueueSettings

QueueSettingsEntity draftQueueSettings

Draft Queue settings

draftRobotSettings

RobotRoutingSettingsEntity draftRobotSettings

Draft Robot routing settings Note: Override columns and association to avoid conflicts with published embedded fields

draftRobotToAgentSettings

RobotToAgentSettingsEntity draftRobotToAgentSettings

Draft robot to agent transition settings

draftWorktimeSettings

WorktimeSettingEntity draftWorktimeSettings

Draft worktime settings reference

messageLeaveSettings

MessageLeaveSettingsEntity messageLeaveSettings

Message leave settings

queueSettings

QueueSettingsEntity queueSettings

Queue settings

robotSettings

RobotRoutingSettingsEntity robotSettings

Robot routing settings

robotToAgentSettings

RobotToAgentSettingsEntity robotToAgentSettings

Robot to agent transition settings

routingMode

String routingMode

Customer routing mode (ROUND_ROBIN, LEAST_BUSY, etc.) Moved from WorkgroupEntity to centralize configuration

worktimeSettings

WorktimeSettingEntity worktimeSettings

Worktime settings reference (shared template)

Class com.bytedesk.service.workgroup_settings.WorkgroupSettingsRequest

class WorkgroupSettingsRequest extends BaseSettingsRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

messageLeaveSettings

MessageLeaveSettingsRequest messageLeaveSettings

Message leave settings (Workgroup-specific)

queueSettings

QueueSettingsRequest queueSettings

Queue settings (Workgroup-specific)

robotRoutingSettings

RobotRoutingSettingsRequest robotRoutingSettings

Robot routing settings (Workgroup-specific)

robotToAgentSettings

RobotToAgentSettingsRequest robotToAgentSettings

Robot to agent transition settings (Workgroup-specific)

routingMode

String routingMode

Customer routing mode (ROUND_ROBIN, LEAST_BUSY, etc.)

worktimeSettings

WorktimeSettingRequest worktimeSettings

Worktime settings (inline, behaves like message leave)

Class com.bytedesk.service.workgroup_settings.WorkgroupSettingsResponse

class WorkgroupSettingsResponse extends BaseSettingsResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

draftMessageLeaveSettings

MessageLeaveSettingsResponse draftMessageLeaveSettings

Draft message leave settings (Workgroup-specific)

draftQueueSettings

QueueSettingsResponse draftQueueSettings

Draft queue settings (Workgroup-specific)

draftRobotRoutingSettings

RobotRoutingSettingsResponse draftRobotRoutingSettings

Draft robot routing settings (Workgroup-specific)

draftRobotToAgentSettings

RobotToAgentSettingsResponse draftRobotToAgentSettings

Draft robot to agent transition settings (Workgroup-specific)

draftWorktimeSettings

WorktimeSettingResponse draftWorktimeSettings

Draft worktime settings reference (Workgroup-specific)

messageLeaveSettings

MessageLeaveSettingsResponse messageLeaveSettings

Message leave settings (Workgroup-specific)

queueSettings

QueueSettingsResponse queueSettings

Queue settings (Workgroup-specific)

robotRoutingSettings

RobotRoutingSettingsResponse robotRoutingSettings

Robot routing settings (Workgroup-specific)

robotToAgentSettings

RobotToAgentSettingsResponse robotToAgentSettings

Robot to agent transition settings (Workgroup-specific)

routingMode

String routingMode

Customer routing mode (ROUND_ROBIN, LEAST_BUSY, etc.)

worktimeSettings

WorktimeSettingResponse worktimeSettings

Worktime settings reference (Workgroup-specific)

Package com.bytedesk.service.workgroup_settings.event

Class com.bytedesk.service.workgroup_settings.event.WorkgroupSettingsCreateEvent

class WorkgroupSettingsCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workgroupSettings

WorkgroupSettingsEntity workgroupSettings

Class com.bytedesk.service.workgroup_settings.event.WorkgroupSettingsUpdateEvent

class WorkgroupSettingsUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

workgroupSettings

WorkgroupSettingsEntity workgroupSettings

Package com.bytedesk.service.workgroup.event

Class com.bytedesk.service.workgroup.event.WorkgroupCreateEvent

class WorkgroupCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

orgUid

String orgUid

workgroupUid

String workgroupUid

Class com.bytedesk.service.workgroup.event.WorkgroupDeleteEvent

class WorkgroupDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

orgUid

String orgUid

workgroupUid

String workgroupUid

Class com.bytedesk.service.workgroup.event.WorkgroupUpdateEvent

class WorkgroupUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

nickname

String nickname

orgUid

String orgUid

workgroupUid

String workgroupUid

Package com.bytedesk.service.worktime_settings

Class com.bytedesk.service.worktime_settings.WorktimeSettingEntity

class WorktimeSettingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

enabled

Boolean enabled

holidays

String holidays

regularWorktimes

List<WorktimeSlotValue> regularWorktimes

specialWorktimes

List<WorktimeSlotValue> specialWorktimes

Class com.bytedesk.service.worktime_settings.WorktimeSettingRequest

class WorktimeSettingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

enabled

Boolean enabled

是否启用该工作时间设置

holidays

String holidays

节假日配置，存为 JSON 文本（key=date, value=name）

regularWorktimes

List<WorktimeSlotValue> regularWorktimes

常规工作时间段列表（例如周一~周五的周期性工作时间）

specialWorktimes

List<WorktimeSlotValue> specialWorktimes

特殊工作时间段列表（节假日、活动期间等覆盖性时间段）

Class com.bytedesk.service.worktime_settings.WorktimeSettingResponse

class WorktimeSettingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

enabled

Boolean enabled

holidays

String holidays

regularWorktimes

List<WorktimeSlotValue> regularWorktimes

specialWorktimes

List<WorktimeSlotValue> specialWorktimes

type

String type

Class com.bytedesk.service.worktime_settings.WorktimeSlotValue

class WorktimeSlotValue extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

endTime

String endTime

startTime

String startTime

workDays

String workDays

Comma separated day-of-week values (1-7) where 1 represents Monday.

Package com.bytedesk.shop.app

Class com.bytedesk.shop.app.ShopAppEntity

class ShopAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.shop.app.ShopAppRequest

class ShopAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.shop.app.ShopAppResponse

class ShopAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.shop.app.event

Class com.bytedesk.shop.app.event.AbstractShopAppEvent

class AbstractShopAppEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

ShopAppEntity app

Class com.bytedesk.shop.app.event.ShopAppCreateEvent

class ShopAppCreateEvent extends AbstractShopAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.shop.app.event.ShopAppDeleteEvent

class ShopAppDeleteEvent extends AbstractShopAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.shop.app.event.ShopAppUpdateEvent

class ShopAppUpdateEvent extends AbstractShopAppEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.shop.product

Class com.bytedesk.shop.product.ProductEntity

class ProductEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

name

String name

price

double price

state

String state

title

String title

Class com.bytedesk.shop.product.ProductRequest

class ProductRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

price

Double price

state

String state

title

String title

Class com.bytedesk.shop.product.ProductResponse

class ProductResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

price

Double price

state

String state

title

String title

Package com.bytedesk.social.kakao

Class com.bytedesk.social.kakao.KakaoEntity

class KakaoEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.kakao.KakaoRequest

class KakaoRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.kakao.KakaoResponse

class KakaoResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.social.kakao.event

Class com.bytedesk.social.kakao.event.AbstractKakaoEvent

class AbstractKakaoEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

KakaoEntity app

Class com.bytedesk.social.kakao.event.KakaoCreateEvent

class KakaoCreateEvent extends AbstractKakaoEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.kakao.event.KakaoDeleteEvent

class KakaoDeleteEvent extends AbstractKakaoEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.kakao.event.KakaoUpdateEvent

class KakaoUpdateEvent extends AbstractKakaoEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.line

Class com.bytedesk.social.line.LineEntity

class LineEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

channelAccessToken

String channelAccessToken

channelId

String channelId

channelSecret

String channelSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

kid

String kid

name

String name

privateKey

String privateKey

publicKey

String publicKey

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.social.line.LineRequest

class LineRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

channelId

String channelId

channelSecret

String channelSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

kid

String kid

name

String name

privateKey

String privateKey

publicKey

String publicKey

workgroupUid

String workgroupUid

Class com.bytedesk.social.line.LineResponse

class LineResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

channelAccessToken

LineService.ChannelAccessTokenResponse channelAccessToken

channelId

String channelId

channelSecret

String channelSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

kid

String kid

name

String name

privateKey

String privateKey

publicKey

String publicKey

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.social.line.LineVisitorExtra

class LineVisitorExtra extends VisitorExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

channelAccessToken

String channelAccessToken

Line相关字段

channelId

String channelId

displayName

String displayName

用户基本信息

language

String language

messageId

String messageId

messageType

String messageType

消息相关信息

pictureUrl

String pictureUrl

replyToken

String replyToken

statusMessage

String statusMessage

timestamp

String timestamp

userId

String userId

Package com.bytedesk.social.line.event

Class com.bytedesk.social.line.event.AbstractLineEvent

class AbstractLineEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

line

LineEntity line

Class com.bytedesk.social.line.event.LineCreateEvent

class LineCreateEvent extends AbstractLineEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.line.event.LineDeleteEvent

class LineDeleteEvent extends AbstractLineEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.line.event.LineUpdateEvent

class LineUpdateEvent extends AbstractLineEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.meta

Class com.bytedesk.social.meta.MetaAppEntity

class MetaAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

pageAccessToken

String pageAccessToken

pageId

String pageId

type

String type

verifyToken

String verifyToken

workgroupUid

String workgroupUid

Class com.bytedesk.social.meta.MetaAppRequest

class MetaAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

pageAccessToken

String pageAccessToken

pageId

String pageId

verifyToken

String verifyToken

workgroupUid

String workgroupUid

Class com.bytedesk.social.meta.MetaAppResponse

class MetaAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

pageAccessToken

String pageAccessToken

pageId

String pageId

type

String type

verifyToken

String verifyToken

workgroupUid

String workgroupUid

Class com.bytedesk.social.meta.MetaExtra

class MetaExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

gender

String gender

isGuestUser

boolean isGuestUser

locale

String locale

name

String name

pageAccessToken

String pageAccessToken

pageId

String pageId

recipientPsid

String recipientPsid

senderId

String senderId

timezone

String timezone

Package com.bytedesk.social.meta.event

Class com.bytedesk.social.meta.event.AbstractMetaAppEvent

class AbstractMetaAppEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

MetaAppEntity app

Class com.bytedesk.social.meta.event.MetaAppCreateEvent

class MetaAppCreateEvent extends AbstractMetaAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.meta.event.MetaAppDeleteEvent

class MetaAppDeleteEvent extends AbstractMetaAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.meta.event.MetaAppUpdateEvent

class MetaAppUpdateEvent extends AbstractMetaAppEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.slack

Class com.bytedesk.social.slack.SlackEntity

class SlackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.social.slack.SlackRequest

class SlackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

workgroupUid

String workgroupUid

Class com.bytedesk.social.slack.SlackResponse

class SlackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

debug

Boolean debug

description

String description

enabled

Boolean enabled

name

String name

type

String type

workgroupUid

String workgroupUid

Package com.bytedesk.social.slack.event

Class com.bytedesk.social.slack.event.AbstractSlackEvent

class AbstractSlackEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

slack

SlackEntity slack

Class com.bytedesk.social.slack.event.SlackCreateEvent

class SlackCreateEvent extends AbstractSlackEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.slack.event.SlackDeleteEvent

class SlackDeleteEvent extends AbstractSlackEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.slack.event.SlackUpdateEvent

class SlackUpdateEvent extends AbstractSlackEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.telegram

Class com.bytedesk.social.telegram.TelegramEntity

class TelegramEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

debug

Boolean debug

description

String description

enabled

Boolean enabled

nickname

String nickname

token

String token

type

String type

username

String username

workgroupUid

String workgroupUid

Class com.bytedesk.social.telegram.TelegramExtra

class TelegramExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

botToken

String botToken

chatId

String chatId

chatTitle

String chatTitle

chatType

String chatType

firstName

String firstName

languageCode

String languageCode

lastName

String lastName

senderId

String senderId

username

String username

Class com.bytedesk.social.telegram.TelegramRequest

class TelegramRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

nickname

String nickname

token

String token

username

String username

workgroupUid

String workgroupUid

Class com.bytedesk.social.telegram.TelegramResponse

class TelegramResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

enabled

Boolean enabled

nickname

String nickname

token

String token

type

String type

username

String username

workgroupUid

String workgroupUid

Package com.bytedesk.social.telegram.event

Class com.bytedesk.social.telegram.event.AbstractTelegramEvent

class AbstractTelegramEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

telegram

TelegramEntity telegram

Class com.bytedesk.social.telegram.event.TelegramCreateEvent

class TelegramCreateEvent extends AbstractTelegramEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.telegram.event.TelegramDeleteEvent

class TelegramDeleteEvent extends AbstractTelegramEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.telegram.event.TelegramEnableEvent

class TelegramEnableEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

enabled

boolean enabled

telegram

TelegramEntity telegram

Class com.bytedesk.social.telegram.event.TelegramUpdateEvent

class TelegramUpdateEvent extends AbstractTelegramEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.tiktok

Class com.bytedesk.social.tiktok.TiktokEntity

class TiktokEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.tiktok.TiktokRequest

class TiktokRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.tiktok.TiktokResponse

class TiktokResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.social.tiktok.event

Class com.bytedesk.social.tiktok.event.AbstractTiktokEvent

class AbstractTiktokEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

TiktokEntity app

Class com.bytedesk.social.tiktok.event.TiktokCreateEvent

class TiktokCreateEvent extends AbstractTiktokEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.tiktok.event.TiktokDeleteEvent

class TiktokDeleteEvent extends AbstractTiktokEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.tiktok.event.TiktokUpdateEvent

class TiktokUpdateEvent extends AbstractTiktokEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.whatsapp

Class com.bytedesk.social.whatsapp.WhatsAppEntity

class WhatsAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

debug

Boolean debug

description

String description

enabled

Boolean enabled

key

String key

name

String name

type

String type

workgroupUid

String workgroupUid

Class com.bytedesk.social.whatsapp.WhatsAppExtra

class WhatsAppExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

apiKey

String apiKey

WhatsApp相关字段

countryCode

String countryCode

from

String from

language

String language

messageId

String messageId

messageType

String messageType

消息相关信息

name

String name

客户基本信息

profileName

String profileName

status

String status

timestamp

String timestamp

to

String to

wabaId

String wabaId

wamid

String wamid

Class com.bytedesk.social.whatsapp.WhatsAppRequest

class WhatsAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

debug

Boolean debug

description

String description

enabled

Boolean enabled

key

String key

name

String name

workgroupUid

String workgroupUid

Class com.bytedesk.social.whatsapp.WhatsAppResponse

class WhatsAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

debug

Boolean debug

description

String description

enabled

Boolean enabled

key

String key

name

String name

type

String type

workgroupUid

String workgroupUid

Package com.bytedesk.social.whatsapp.event

Class com.bytedesk.social.whatsapp.event.AbstractWhatsAppEvent

class AbstractWhatsAppEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

WhatsAppEntity app

Class com.bytedesk.social.whatsapp.event.WhatsAppCreateEvent

class WhatsAppCreateEvent extends AbstractWhatsAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.whatsapp.event.WhatsAppDeleteEvent

class WhatsAppDeleteEvent extends AbstractWhatsAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.whatsapp.event.WhatsAppUpdateEvent

class WhatsAppUpdateEvent extends AbstractWhatsAppEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.social.zalo

Class com.bytedesk.social.zalo.ZaloEntity

class ZaloEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.zalo.ZaloRequest

class ZaloRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

用户关注公众号后发送欢迎语

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.social.zalo.ZaloResponse

class ZaloResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

appId

String appId

app_id

appSecret

String appSecret

dataType

String dataType

数据格式

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.social.zalo.event

Class com.bytedesk.social.zalo.event.AbstractZaloEvent

class AbstractZaloEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

ZaloEntity app

Class com.bytedesk.social.zalo.event.ZaloCreateEvent

class ZaloCreateEvent extends AbstractZaloEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.zalo.event.ZaloDeleteEvent

class ZaloDeleteEvent extends AbstractZaloEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.social.zalo.event.ZaloUpdateEvent

class ZaloUpdateEvent extends AbstractZaloEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.attachment

Class com.bytedesk.ticket.attachment.TicketAttachmentEntity

class TicketAttachmentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

ticket

TicketEntity ticket

upload

UploadEntity upload

Class com.bytedesk.ticket.attachment.TicketAttachmentRequest

class TicketAttachmentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

commentUid

String commentUid

ticketUid

String ticketUid

uploadUid

String uploadUid

Class com.bytedesk.ticket.attachment.TicketAttachmentResponse

class TicketAttachmentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

upload

UploadResponse upload

Package com.bytedesk.ticket.message

Class com.bytedesk.ticket.message.TicketMessageEntity

class TicketMessageEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.process

Class com.bytedesk.ticket.process.ProcessDefinitionResponse

class ProcessDefinitionResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

deploymentId

String deploymentId

description

String description

id

String id

key

String key

name

String name

tenantId

String tenantId

version

Integer version

Class com.bytedesk.ticket.process.ProcessEntity

class ProcessEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

deploymentId

String deploymentId

description

String description

name

String name

schema

String schema

Form structure definition stored as JSON format Contains the complete form schema generated by frontend low-code editor

status

String status

Current status of the process (DRAFT, PUBLISHED, DISABLED)

type

String type

Process type (TICKET_INTERNAL, TICKET_EXTERNAL)

Class com.bytedesk.ticket.process.ProcessRequest

class ProcessRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

deploymentId

String deploymentId

description

String description

name

String name

schema

String schema

status

String status

Class com.bytedesk.ticket.process.ProcessResponse

class ProcessResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

deploymentId

String deploymentId

description

String description

name

String name

schema

String schema

status

String status

type

String type

Package com.bytedesk.ticket.process.demo

Class com.bytedesk.ticket.process.demo.DemoExecutionListener

class DemoExecutionListener extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.process.demo.DemoTaskListener

class DemoTaskListener extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.process.demo.DemoTaskTimeoutListener

class DemoTaskTimeoutListener extends Object implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.process.event

Class com.bytedesk.ticket.process.event.AbstractProcessEvent

class AbstractProcessEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

process

ProcessEntity process

Class com.bytedesk.ticket.process.event.ProcessCreateEvent

class ProcessCreateEvent extends AbstractProcessEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.process.event.ProcessDeleteEvent

class ProcessDeleteEvent extends AbstractProcessEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.process.event.ProcessUpdateEvent

class ProcessUpdateEvent extends AbstractProcessEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.thread.listener

Class com.bytedesk.ticket.thread.listener.ThreadExecutionListener

class ThreadExecutionListener extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.thread.listener.ThreadTaskListener

class ThreadTaskListener extends Object implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.ticket

Class com.bytedesk.ticket.ticket.TicketEntity

class TicketEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

assignee

String assignee

Ticket assignee information stored as JSON string 工单处理人、办理人

attachments

Set<TicketAttachmentEntity> attachments

Attachments associated with the ticket

categoryUid

String categoryUid

Associated category UID for ticket classification

channel

String channel

Client platform from which the ticket was created

closedTime

ZonedDateTime closedTime

Timestamp when the ticket was closed

contactName

String contactName

departmentUid

String departmentUid

Associated department UID for ticket routing 默认内部工单类型关联部门

description

String description

Detailed description of the ticket issue (optional)

email

String email

formEntityUid

String formEntityUid

Selected form definition UID

phone

String phone

priority

String priority

Priority level of the ticket (LOW, MEDIUM, HIGH, URGENT)

processEntityUid

String processEntityUid

Process definition entity UID Also used as Flowable's processDefinitionKey

processInstanceId

String processInstanceId

Process instance ID for workflow integration

reporter

String reporter

Ticket reporter information stored as JSON string 工单提出者/创建人

resolvedTime

ZonedDateTime resolvedTime

Timestamp when the ticket was resolved

schema

String schema

使用自定义表单 替换默认表单 Form structure definition stored as JSON format Contains the complete form schema generated by frontend low-code editor

status

String status

Current status of the ticket (NEW, IN_PROGRESS, RESOLVED, CLOSED)

threadUid

String threadUid

Associated thread UID for ticket conversation

ticketNumber

String ticketNumber

Human friendly ticket number generated from ticket settings

ticketSettingsUid

String ticketSettingsUid

Ticket settings applied during creation

title

String title

Title of the support ticket

topic

String topic

Thread topic for online customer service session

type

String type

Ticket scope type (INTERNAL/EXTERNAL)

verified

Boolean verified

Whether the customer has been verified

visitorThreadTopic

String visitorThreadTopic

visitorThreadUid

String visitorThreadUid

wechat

String wechat

workgroupUid

String workgroupUid

Associated workgroup UID for ticket assignment 默认外部工单类型关联客服工作组

Class com.bytedesk.ticket.ticket.TicketRequest

class TicketRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

addSignUids

Set<String> addSignUids

assignee

UserProtobuf assignee

assigneeUid

String assigneeUid

assignmentAll

Boolean assignmentAll

categoryUid

String categoryUid

ccUids

Set<String> ccUids

contactName

String contactName

createdAtEnd

String createdAtEnd

createdAtStart

String createdAtStart

delegateUid

String delegateUid

departmentUid

String departmentUid

description

String description

email

String email

phone

String phone

priority

String priority

processEntityUid

String processEntityUid

processInstanceId

String processInstanceId

reason

String reason

reporter

UserProtobuf reporter

reporterUid

String reporterUid

rollbackFromActivityId

String rollbackFromActivityId

rollbackToActivityId

String rollbackToActivityId

schema

String schema

status

String status

taskId

String taskId

threadUid

String threadUid

ticketNumber

String ticketNumber

ticketSettingsUid

String ticketSettingsUid

title

String title

topic

String topic

uploadUids

Set<String> uploadUids

verified

Boolean verified

visitorThreadTopic

String visitorThreadTopic

visitorThreadUid

String visitorThreadUid

wechat

String wechat

workgroupUid

String workgroupUid

Class com.bytedesk.ticket.ticket.TicketResponse

class TicketResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

assignee

UserProtobuf assignee

attachments

Set<TicketAttachmentResponse> attachments

categoryUid

String categoryUid

contactName

String contactName

departmentUid

String departmentUid

description

String description

email

String email

formEntityUid

String formEntityUid

phone

String phone

priority

String priority

processEntityUid

String processEntityUid

processInstanceId

String processInstanceId

reporter

UserProtobuf reporter

schema

String schema

status

String status

threadUid

String threadUid

ticketNumber

String ticketNumber

ticketSettingsUid

String ticketSettingsUid

title

String title

topic

String topic

type

String type

verified

Boolean verified

visitorThreadTopic

String visitorThreadTopic

visitorThreadUid

String visitorThreadUid

wechat

String wechat

workgroupUid

String workgroupUid

Package com.bytedesk.ticket.ticket_rating

Class com.bytedesk.ticket.ticket_rating.TicketRatingEntity

class TicketRatingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

Description of the ticket_rating

name

String name

Name of the ticket_rating

type

String type

Type of ticket_rating (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.ticket.ticket_rating.TicketRatingRequest

class TicketRatingRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.ticket.ticket_rating.TicketRatingResponse

class TicketRatingResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.ticket.ticket_rating.event

Class com.bytedesk.ticket.ticket_rating.event.AbstractTicketRatingEvent

class AbstractTicketRatingEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ticket_rating

TicketRatingEntity ticket_rating

Class com.bytedesk.ticket.ticket_rating.event.TicketRatingCreateEvent

class TicketRatingCreateEvent extends AbstractTicketRatingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket_rating.event.TicketRatingDeleteEvent

class TicketRatingDeleteEvent extends AbstractTicketRatingEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket_rating.event.TicketRatingUpdateEvent

class TicketRatingUpdateEvent extends AbstractTicketRatingEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.ticket_settings

Class com.bytedesk.ticket.ticket_settings.TicketSettingsEntity

class TicketSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

basicSettings

TicketBasicSettingsEntity basicSettings

categorySettings

TicketCategorySettingsEntity categorySettings

customFormEnabled

Boolean customFormEnabled

Whether custom ticket forms are enabled for this settings template

description

String description

Description of the ticketSettings

draftBasicSettings

TicketBasicSettingsEntity draftBasicSettings

draftCategorySettings

TicketCategorySettingsEntity draftCategorySettings

draftForm

FormEntity draftForm

Draft form binding

draftProcess

ProcessEntity draftProcess

Draft workflow process binding

enabled

Boolean enabled

Whether the settings is enabled

form

FormEntity form

Published form binding

hasUnpublishedChanges

Boolean hasUnpublishedChanges

Whether there are unpublished changes in draft

isDefault

Boolean isDefault

Whether this is a default settings template for new entities Only one settings per organization should have isDefault=true

name

String name

Name of the ticketSettings

process

ProcessEntity process

Published workflow process binding

publishedAt

ZonedDateTime publishedAt

Last published time

type

String type

Ticket scope type (INTERNAL / EXTERNAL)

Class com.bytedesk.ticket.ticket_settings.TicketSettingsRequest

class TicketSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

basicSettings

TicketBasicSettingsRequest basicSettings

categorySettings

TicketCategorySettingsRequest categorySettings

customFormEnabled

Boolean customFormEnabled

是否启用自定义表单（默认为 false）

description

String description

enabled

Boolean enabled

是否启用（默认为 true）

formUid

String formUid

绑定的表单 UID（若为空则沿用默认表单）

isDefault

Boolean isDefault

是否设为组织默认配置（同一 org 仅允许一个默认，服务端在事务内保证唯一）

name

String name

notificationSettings

TicketNotificationSettingsRequest notificationSettings

processUid

String processUid

绑定的流程 UID（若为空则沿用默认流程）

Class com.bytedesk.ticket.ticket_settings.TicketSettingsResponse

class TicketSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

basicSettings

TicketBasicSettingsResponse basicSettings

categorySettings

TicketCategorySettingsResponse categorySettings

customFormEnabled

Boolean customFormEnabled

是否启用自定义表单

description

String description

draftBasicSettings

TicketBasicSettingsResponse draftBasicSettings

draftCategorySettings

TicketCategorySettingsResponse draftCategorySettings

draftForm

FormResponse draftForm

draftNotificationSettings

TicketNotificationSettingsResponse draftNotificationSettings

draftProcess

ProcessResponse draftProcess

enabled

Boolean enabled

是否启用

form

FormResponse form

hasUnpublishedChanges

Boolean hasUnpublishedChanges

草稿是否存在未发布变更（由服务端维护）

isDefault

Boolean isDefault

是否为组织默认配置

name

String name

notificationSettings

TicketNotificationSettingsResponse notificationSettings

process

ProcessResponse process

publishedAt

ZonedDateTime publishedAt

最近发布时间（由服务端在发布时更新）

type

String type

Package com.bytedesk.ticket.ticket_settings_basic

Class com.bytedesk.ticket.ticket_settings_basic.TicketBasicSettingsEntity

class TicketBasicSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessTip

String accessTip

工单接入提示语（线程 NEW -> CHATTING 时发送给访客）

agentTimeoutTip

String agentTimeoutTip

工单客服超时未回复提示语（预留给超时触发器/定时任务使用）

assignmentMode

String assignmentMode

工单分配方式

autoCloseHours

Integer autoCloseHours

closeTip

String closeTip

工单关闭提示语（会话关闭后仅用于展示/提示）

defaultPriority

String defaultPriority

enableAutoClose

Boolean enableAutoClose

numberLength

Integer numberLength

numberPrefix

String numberPrefix

requireContactName

Boolean requireContactName

联系人姓名是否必填

requireEmail

Boolean requireEmail

邮箱是否必填

requireLogin

Boolean requireLogin

requirePhone

Boolean requirePhone

手机是否必填

requireWechat

Boolean requireWechat

微信是否必填

showContactName

Boolean showContactName

是否显示联系人姓名字段

showEmail

Boolean showEmail

是否显示邮箱字段

showPhone

Boolean showPhone

是否显示手机字段

showWechat

Boolean showWechat

是否显示微信字段

validityDays

Integer validityDays

visitorTimeoutTip

String visitorTimeoutTip

工单访客超时未回复提示语（预留给超时触发器/定时任务使用）

Class com.bytedesk.ticket.ticket_settings_basic.TicketBasicSettingsRequest

class TicketBasicSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessTip

String accessTip

agentTimeoutTip

String agentTimeoutTip

assignmentMode

String assignmentMode

autoCloseHours

Integer autoCloseHours

closeTip

String closeTip

defaultPriority

String defaultPriority

enableAutoClose

Boolean enableAutoClose

numberLength

Integer numberLength

numberPrefix

String numberPrefix

requireContactName

Boolean requireContactName

requireEmail

Boolean requireEmail

requireLogin

Boolean requireLogin

requirePhone

Boolean requirePhone

requireWechat

Boolean requireWechat

showContactName

Boolean showContactName

showEmail

Boolean showEmail

showPhone

Boolean showPhone

showWechat

Boolean showWechat

validityDays

Integer validityDays

visitorTimeoutTip

String visitorTimeoutTip

Class com.bytedesk.ticket.ticket_settings_basic.TicketBasicSettingsResponse

class TicketBasicSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessTip

String accessTip

agentTimeoutTip

String agentTimeoutTip

assignmentMode

String assignmentMode

autoCloseHours

Integer autoCloseHours

closeTip

String closeTip

defaultPriority

String defaultPriority

enableAutoClose

Boolean enableAutoClose

numberLength

Integer numberLength

numberPrefix

String numberPrefix

requireContactName

Boolean requireContactName

requireEmail

Boolean requireEmail

requireLogin

Boolean requireLogin

requirePhone

Boolean requirePhone

requireWechat

Boolean requireWechat

showContactName

Boolean showContactName

showEmail

Boolean showEmail

showPhone

Boolean showPhone

showWechat

Boolean showWechat

validityDays

Integer validityDays

visitorTimeoutTip

String visitorTimeoutTip

Package com.bytedesk.ticket.ticket_settings_binding

Class com.bytedesk.ticket.ticket_settings_binding.TicketSettingsBindingEntity

class TicketSettingsBindingEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

ticketSettingsUid

String ticketSettingsUid

被绑定的工单设置 UID

workgroupUid

String workgroupUid

工作组 UID（字符串，不做 JPA 关联，避免依赖 service 模块）

Package com.bytedesk.ticket.ticket_settings_category

Class com.bytedesk.ticket.ticket_settings_category.CategoryItemData

class CategoryItemData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultCategory

Boolean defaultCategory

是否为默认分类。

description

String description

分类描述或提示。

enabled

Boolean enabled

是否启用。

name

String name

分类显示名称。

orderIndex

Integer orderIndex

排序序号，越小越靠前。

uid

String uid

分类唯一标识（对访客暴露）。

Class com.bytedesk.ticket.ticket_settings_category.CategorySettingsData

class CategorySettingsData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

items

List<CategoryItemData> items

Class com.bytedesk.ticket.ticket_settings_category.TicketCategoryItemRequest

class TicketCategoryItemRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultCategory

Boolean defaultCategory

description

String description

enabled

Boolean enabled

name

String name

orderIndex

Integer orderIndex

Class com.bytedesk.ticket.ticket_settings_category.TicketCategoryItemResponse

class TicketCategoryItemResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultCategory

Boolean defaultCategory

description

String description

enabled

Boolean enabled

name

String name

orderIndex

Integer orderIndex

Class com.bytedesk.ticket.ticket_settings_category.TicketCategorySettingsEntity

class TicketCategorySettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

content

CategorySettingsData content

Class com.bytedesk.ticket.ticket_settings_category.TicketCategorySettingsRequest

class TicketCategorySettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

items

List<TicketCategoryItemRequest> items

Class com.bytedesk.ticket.ticket_settings_category.TicketCategorySettingsResponse

class TicketCategorySettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

defaultCategoryUid

String defaultCategoryUid

disabledCount

Long disabledCount

enabledCount

Long enabledCount

items

List<TicketCategoryItemResponse> items

Package com.bytedesk.ticket.ticket_settings_notification

Class com.bytedesk.ticket.ticket_settings_notification.EmailTemplateDef

class EmailTemplateDef extends Object implements Serializable

Serialized Fields

body

String body

enabled

boolean enabled

event

String event

subject

String subject

Class com.bytedesk.ticket.ticket_settings_notification.TicketNotificationSettingsEntity

class TicketNotificationSettingsEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

emailEnabled

Boolean emailEnabled

emailEvents

List<String> emailEvents

邮件事件集合

emailTemplates

List<EmailTemplateDef> emailTemplates

邮件模板集合

internalEnabled

Boolean internalEnabled

internalEvents

List<String> internalEvents

内部事件集合

webhookEnabled

Boolean webhookEnabled

webhookEvents

List<String> webhookEvents

webhook事件集合

webhookUrl

String webhookUrl

Class com.bytedesk.ticket.ticket_settings_notification.TicketNotificationSettingsRequest

class TicketNotificationSettingsRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

emailEnabled

Boolean emailEnabled

emailEvents

String emailEvents

emailTemplates

String emailTemplates

internalEnabled

Boolean internalEnabled

internalEvents

String internalEvents

webhookEnabled

Boolean webhookEnabled

webhookEvents

String webhookEvents

webhookUrl

String webhookUrl

Class com.bytedesk.ticket.ticket_settings_notification.TicketNotificationSettingsResponse

class TicketNotificationSettingsResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

emailEnabled

Boolean emailEnabled

emailEvents

List<String> emailEvents

emailTemplates

List<EmailTemplateDef> emailTemplates

internalEnabled

Boolean internalEnabled

internalEvents

List<String> internalEvents

webhookEnabled

Boolean webhookEnabled

webhookEvents

List<String> webhookEvents

webhookUrl

String webhookUrl

Package com.bytedesk.ticket.ticket_settings.event

Class com.bytedesk.ticket.ticket_settings.event.AbstractTicketSettingsEvent

class AbstractTicketSettingsEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ticketSettings

TicketSettingsEntity ticketSettings

Class com.bytedesk.ticket.ticket_settings.event.TicketSettingsCreateEvent

class TicketSettingsCreateEvent extends AbstractTicketSettingsEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket_settings.event.TicketSettingsDeleteEvent

class TicketSettingsDeleteEvent extends AbstractTicketSettingsEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket_settings.event.TicketSettingsUpdateEvent

class TicketSettingsUpdateEvent extends AbstractTicketSettingsEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.ticket_statistic

Class com.bytedesk.ticket.ticket_statistic.TicketStatisticEntity

class TicketStatisticEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

assignedTickets

long assignedTickets

assigneeResolutionRate

double assigneeResolutionRate

assigneeTickets

long assigneeTickets

assigneeUid

String assigneeUid

averageFirstResponseTime

double averageFirstResponseTime

averageResolutionTime

double averageResolutionTime

cancelledTickets

long cancelledTickets

claimedTickets

long claimedTickets

closedTickets

long closedTickets

criticalTickets

long criticalTickets

customerSatisfactionRate

double customerSatisfactionRate

date

String date

departmentResolutionRate

double departmentResolutionRate

departmentTickets

long departmentTickets

departmentUid

String departmentUid

endDate

ZonedDateTime endDate

escalatedTickets

long escalatedTickets

highTickets

long highTickets

holdingTickets

long holdingTickets

hour

Integer hour

lowTickets

long lowTickets

mediumTickets

long mediumTickets

newTickets

long newTickets

openTickets

long openTickets

pendingTickets

long pendingTickets

processingTickets

long processingTickets

reopenedTickets

long reopenedTickets

resolvedTickets

long resolvedTickets

resumedTickets

long resumedTickets

satisfiedTickets

long satisfiedTickets

slaBreachCount

long slaBreachCount

slaComplianceRate

double slaComplianceRate

startDate

ZonedDateTime startDate

totalTickets

long totalTickets

transferredTickets

long transferredTickets

type

String type

unclaimedTickets

long unclaimedTickets

unreadTickets

long unreadTickets

unsatisfiedTickets

long unsatisfiedTickets

verifiedFailTickets

long verifiedFailTickets

verifiedOkTickets

long verifiedOkTickets

workgroupResolutionRate

double workgroupResolutionRate

workgroupTickets

long workgroupTickets

workgroupUid

String workgroupUid

Class com.bytedesk.ticket.ticket_statistic.TicketStatisticRequest

class TicketStatisticRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

assigneeUid

String assigneeUid

date

String date

departmentUid

String departmentUid

endDate

String endDate

hour

Integer hour

startDate

String startDate

workgroupUid

String workgroupUid

Class com.bytedesk.ticket.ticket_statistic.TicketStatisticResponse

class TicketStatisticResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

assigneeResolutionRate

double assigneeResolutionRate

assigneeTickets

long assigneeTickets

assigneeUid

String assigneeUid

averageFirstResponseTime

double averageFirstResponseTime

averageResolutionTime

double averageResolutionTime

claimedTickets

long claimedTickets

closedTickets

long closedTickets

criticalTickets

long criticalTickets

customerSatisfactionRate

double customerSatisfactionRate

date

String date

departmentResolutionRate

double departmentResolutionRate

departmentTickets

long departmentTickets

departmentUid

String departmentUid

endDate

String endDate

escalatedTickets

long escalatedTickets

highTickets

long highTickets

holdingTickets

long holdingTickets

hour

Integer hour

lowTickets

long lowTickets

mediumTickets

long mediumTickets

newTickets

long newTickets

openTickets

long openTickets

pendingTickets

long pendingTickets

processingTickets

long processingTickets

reopenedTickets

long reopenedTickets

resolvedTickets

long resolvedTickets

satisfiedTickets

long satisfiedTickets

slaBreachCount

long slaBreachCount

slaComplianceRate

double slaComplianceRate

startDate

String startDate

totalTickets

long totalTickets

unclaimedTickets

long unclaimedTickets

unreadTickets

long unreadTickets

unsatisfiedTickets

long unsatisfiedTickets

workgroupResolutionRate

double workgroupResolutionRate

workgroupTickets

long workgroupTickets

workgroupUid

String workgroupUid

Package com.bytedesk.ticket.ticket.event

Class com.bytedesk.ticket.ticket.event.AbstractTicketEvent

class AbstractTicketEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

ticket

TicketEntity ticket

Class com.bytedesk.ticket.ticket.event.TicketCreateEvent

class TicketCreateEvent extends AbstractTicketEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket.event.TicketUpdateAssigneeEvent

class TicketUpdateAssigneeEvent extends AbstractTicketEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

newAssigneeUid

String newAssigneeUid

oldAssigneeUid

String oldAssigneeUid

Class com.bytedesk.ticket.ticket.event.TicketUpdateDepartmentEvent

class TicketUpdateDepartmentEvent extends AbstractTicketEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

newDepartmentUid

String newDepartmentUid

oldDepartmentUid

String oldDepartmentUid

Class com.bytedesk.ticket.ticket.event.TicketUpdateEvent

class TicketUpdateEvent extends AbstractTicketEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.ticket.ticket.listener

Class com.bytedesk.ticket.ticket.listener.TicketExecutionListener

class TicketExecutionListener extends Object implements Serializable

serialVersionUID:

1L

Class com.bytedesk.ticket.ticket.listener.TicketTaskListener

class TicketTaskListener extends Object implements Serializable

serialVersionUID:

1L

Package com.bytedesk.voc.comment

Class com.bytedesk.voc.comment.VocCommentEntity

class VocCommentEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

content

String content

imageUrl

String imageUrl

title

String title

Class com.bytedesk.voc.comment.VocCommentRequest

class VocCommentRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

imageUrl

String imageUrl

title

String title

Class com.bytedesk.voc.comment.VocCommentResponse

class VocCommentResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

imageUrl

String imageUrl

title

String title

Package com.bytedesk.voc.comment.event

Class com.bytedesk.voc.comment.event.VocCommentCreateEvent

class VocCommentCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

VocCommentEntity comment

Class com.bytedesk.voc.comment.event.VocCommentDeleteEvent

class VocCommentDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

VocCommentEntity comment

Class com.bytedesk.voc.comment.event.VocCommentUpdateEvent

class VocCommentUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

comment

VocCommentEntity comment

Package com.bytedesk.voc.complaint

Class com.bytedesk.voc.complaint.ComplaintEntity

class ComplaintEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

Agent information who is handling the complaint (stored as JSON)

attachments

List<String> attachments

List of attachment URLs

categoryUids

List<String> categoryUids

Category UIDs for classification

channel

String channel

Customer source channel

closedAt

ZonedDateTime closedAt

Timestamp when the complaint was closed

closeUser

String closeUser

Agent who closed the complaint (stored as JSON)

content

String content

Main complaint content

deviceInfo

String deviceInfo

Customer device information

extra

String extra

Additional metadata stored as JSON

images

List<String> images

List of image URLs

imageUrl

String imageUrl

Associated image URL

investigationNotes

String investigationNotes

Investigation notes and findings

ipAddress

String ipAddress

Customer's IP address

location

String location

Geographic location information

messageUid

String messageUid

Associated message UID if complaint is related to a specific message

priority

String priority

Priority level of the complaint

readAt

ZonedDateTime readAt

Timestamp when the complaint was read

readUser

String readUser

Agent who read the complaint (stored as JSON)

repliedAt

ZonedDateTime repliedAt

Timestamp when the complaint was replied to

replyAttachments

List<String> replyAttachments

Files attached to the reply

replyContent

String replyContent

Agent's reply to the complaint

replyImages

List<String> replyImages

Images attached to the reply

replyUser

String replyUser

Agent who replied to the complaint (stored as JSON)

resolutionDescription

String resolutionDescription

Resolution description

resolvedAt

ZonedDateTime resolvedAt

Timestamp when the complaint was resolved

resolveUser

String resolveUser

Agent who resolved the complaint (stored as JSON)

severity

Integer severity

Complaint severity level (1-5)

status

String status

Complaint processing status

tagList

List<String> tagList

Tags for categorization and search

targetAgentUid

String targetAgentUid

Target agent UID for transfer

threadUid

String threadUid

Associated thread UID if complaint is related to a conversation

ticketUid

String ticketUid

Associated ticket UID if complaint is converted to or related to a ticket

title

String title

Complaint title/subject

transferredAt

ZonedDateTime transferredAt

Timestamp when the complaint was transferred

transferUser

String transferUser

Agent who transferred the complaint (stored as JSON)

type

String type

Complaint type - SERVICE, PRODUCT, AGENT, etc.

user

String user

Customer/user information who submitted the complaint (stored as JSON)

workgroup

String workgroup

Workgroup information if complaint is related to a workgroup (stored as JSON)

Class com.bytedesk.voc.complaint.ComplaintRequest

class ComplaintRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

imageUrl

String imageUrl

title

String title

Class com.bytedesk.voc.complaint.ComplaintResponse

class ComplaintResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

imageUrl

String imageUrl

title

String title

Package com.bytedesk.voc.complaint.event

Class com.bytedesk.voc.complaint.event.ComplaintCreateEvent

class ComplaintCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

complaint

ComplaintEntity complaint

Class com.bytedesk.voc.complaint.event.ComplaintDeleteEvent

class ComplaintDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

complaint

ComplaintEntity complaint

Class com.bytedesk.voc.complaint.event.ComplaintUpdateEvent

class ComplaintUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

complaint

ComplaintEntity complaint

Package com.bytedesk.voc.feedback

Class com.bytedesk.voc.feedback.FeedbackEntity

class FeedbackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

agent

String agent

Agent information who is handling the feedback (stored as JSON)

attachments

List<String> attachments

List of attachment URLs

categoryUids

List<String> categoryUids

Category UIDs for classification

channel

String channel

Customer source channel

closedAt

ZonedDateTime closedAt

Timestamp when the feedback was closed

closeUser

String closeUser

Agent who closed the feedback (stored as JSON)

content

String content

Main feedback content

deviceInfo

String deviceInfo

Customer device information

extra

String extra

Additional metadata stored as JSON

images

List<String> images

List of image URLs

ipAddress

String ipAddress

Customer's IP address

location

String location

Geographic location information

messageUid

String messageUid

Associated message UID if feedback is related to a specific message

priority

String priority

Priority level of the feedback

rating

Integer rating

Feedback rating/score (1-5 stars)

readAt

ZonedDateTime readAt

Timestamp when the feedback was read

readUser

String readUser

Agent who read the feedback (stored as JSON)

repliedAt

ZonedDateTime repliedAt

Timestamp when the feedback was replied to

replyAttachments

List<String> replyAttachments

Files attached to the reply

replyContent

String replyContent

Agent's reply to the feedback

replyImages

List<String> replyImages

Images attached to the reply

replyUser

String replyUser

Agent who replied to the feedback (stored as JSON)

resolvedAt

ZonedDateTime resolvedAt

Timestamp when the feedback was resolved

resolveUser

String resolveUser

Agent who resolved the feedback (stored as JSON)

robot

String robot

Robot information if feedback is related to robot interaction (stored as JSON)

status

String status

Feedback processing status

tagList

List<String> tagList

Tags for categorization and search

targetAgentUid

String targetAgentUid

Target agent UID for transfer

threadUid

String threadUid

Associated thread UID if feedback is related to a conversation

ticketUid

String ticketUid

Associated ticket UID if feedback is converted to or related to a ticket

title

String title

Feedback title/subject

transferredAt

ZonedDateTime transferredAt

Timestamp when the feedback was transferred

transferUser

String transferUser

Agent who transferred the feedback (stored as JSON)

type

String type

Feedback type - WORKGROUP, AGENT, CUSTOMER, etc.

user

String user

Customer/user information who submitted the feedback (stored as JSON)

workgroup

String workgroup

Workgroup information if feedback is related to a workgroup (stored as JSON)

Class com.bytedesk.voc.feedback.FeedbackRequest

class FeedbackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryNames

List<String> categoryNames

categoryUids

List<String> categoryUids

images

List<String> images

title

String title

Class com.bytedesk.voc.feedback.FeedbackResponse

class FeedbackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

categoryUids

List<String> categoryUids

images

List<String> images

title

String title

Package com.bytedesk.voc.feedback.event

Class com.bytedesk.voc.feedback.event.FeedbackCreateEvent

class FeedbackCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

feedback

FeedbackEntity feedback

Class com.bytedesk.voc.feedback.event.FeedbackDeleteEvent

class FeedbackDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

feedback

FeedbackEntity feedback

Class com.bytedesk.voc.feedback.event.FeedbackUpdateEvent

class FeedbackUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

feedback

FeedbackEntity feedback

Package com.bytedesk.voc.opinion

Class com.bytedesk.voc.opinion.OpinionEntity

class OpinionEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

Color theme for the opinion display

description

String description

Description of the opinion

name

String name

Name of the opinion

order

Integer order

Display order of the opinion

type

String type

Type of opinion (CUSTOMER, TICKET, ARTICLE, etc.)

Class com.bytedesk.voc.opinion.OpinionRequest

class OpinionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

Class com.bytedesk.voc.opinion.OpinionResponse

class OpinionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

color

String color

description

String description

name

String name

order

Integer order

type

String type

Package com.bytedesk.voc.opinion.event

Class com.bytedesk.voc.opinion.event.OpinionCreateEvent

class OpinionCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

opinion

OpinionEntity opinion

Class com.bytedesk.voc.opinion.event.OpinionDeleteEvent

class OpinionDeleteEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

opinion

OpinionEntity opinion

Class com.bytedesk.voc.opinion.event.OpinionUpdateEvent

class OpinionUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

opinion

OpinionEntity opinion

Package com.bytedesk.wechat.app

Class com.bytedesk.wechat.app.WeChatAppEntity

class WeChatAppEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

WeChat access token for API authentication Valid for 2 hours, requires periodic refresh

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

Expiration timestamp for the access token

agentId

String agentId

AgentID for WeChat Work

appId

String appId

WeChat application ID (app_id) 企业ID (CorpID) for WeChat Work

appSecret

String appSecret

WeChat application secret key

dataType

String dataType

Data format for WeChat API communication (XML, JSON)

debug

Boolean debug

description

String description

Description of the WeChat application

enabled

Boolean enabled

Whether the WeChat application is enabled

encodingAesKey

String encodingAesKey

WeChat application encoding AES key for message encryption

encryptMode

String encryptMode

Message encryption mode (PLAINTEXT, COMPATIBLE, SAFE)

flowTip

String flowTip

Welcome message sent to users when they follow the official account

name

String name

Name of the WeChat application

token

String token

WeChat application token for webhook verification

type

String type

Type of WeChat application (MP, MINI, WORK)

url

String url

WeChat application URL for webhook configuration

workgroupUid

String workgroupUid

Associated workgroup UID for customer service routing

Class com.bytedesk.wechat.app.WeChatAppRequest

class WeChatAppRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

ZonedDateTime accessTokenExpiresAt

agentId

String agentId

AgentID for WeChat Work

appId

String appId

app_id 企业ID (CorpID) for WeChat Work

appSecret

String appSecret

dataType

String dataType

数据格式

debug

Boolean debug

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

url

String url

workgroupUid

String workgroupUid

Class com.bytedesk.wechat.app.WeChatAppResponse

class WeChatAppResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

accessTokenExpiresAt

String accessTokenExpiresAt

agentId

String agentId

AgentID for WeChat Work

appId

String appId

app_id 企业ID (CorpID) for WeChat Work

appSecret

String appSecret

dataType

String dataType

数据格式

debug

Boolean debug

description

String description

enabled

Boolean enabled

encodingAesKey

String encodingAesKey

encryptMode

String encryptMode

flowTip

String flowTip

用户关注公众号后发送欢迎语

name

String name

token

String token

type

String type

url

String url

workgroupUid

String workgroupUid

Package com.bytedesk.wechat.app.event

Class com.bytedesk.wechat.app.event.AbstractWeChatAppEvent

class AbstractWeChatAppEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

app

WeChatAppEntity app

Class com.bytedesk.wechat.app.event.WeChatAppCreateEvent

class WeChatAppCreateEvent extends AbstractWeChatAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.app.event.WeChatAppDeleteEvent

class WeChatAppDeleteEvent extends AbstractWeChatAppEvent implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.app.event.WeChatAppUpdateEvent

class WeChatAppUpdateEvent extends AbstractWeChatAppEvent implements Serializable

serialVersionUID:

1L

Package com.bytedesk.wechat.common.aes_json

Exception com.bytedesk.wechat.common.aes_json.AesException

class AesException extends Exception implements Serializable

Serialized Fields

code

int code

Package com.bytedesk.wechat.common.aes_xml

Exception com.bytedesk.wechat.common.aes_xml.AesException

class AesException extends Exception implements Serializable

Serialized Fields

code

int code

Package com.bytedesk.wechat.mini

Class com.bytedesk.wechat.mini.WeChatMiniThreadExtra

class WeChatMiniThreadExtra extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

openid

String openid

token

String token

Package com.bytedesk.wechat.mini.message

Class com.bytedesk.wechat.mini.message.WeChatMiniMessage

class WeChatMiniMessage extends Object implements Serializable

serialVersionUID:

1L

Package com.bytedesk.wechat.mini.user

Class com.bytedesk.wechat.mini.user.WeChatMiniUserEntity

class WeChatMiniUserEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

channel

String channel

city

String city

country

String country

email

String email

groupid

Integer groupid

language

String language

mobile

String mobile

nickname

String nickname

note

String note

openid

String openid

province

String province

qrScene

Integer qrScene

qrSceneStr

String qrSceneStr

remark

String remark

sex

Integer sex

subscribe

Integer subscribe

subscribeScene

String subscribeScene

subscribeTime

Long subscribeTime

unionid

String unionid

Class com.bytedesk.wechat.mini.user.WeChatMiniUserRequest

class WeChatMiniUserRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mini.user.WeChatMiniUserResponse

class WeChatMiniUserResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp

Class com.bytedesk.wechat.mp.WeChatMpThreadExtra

class WeChatMpThreadExtra extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

openid

String openid

token

String token

Package com.bytedesk.wechat.mp.black

Class com.bytedesk.wechat.mp.black.WeChatMpBlackEntity

class WeChatMpBlackEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.black.WeChatMpBlackEntityCreateEvent

class WeChatMpBlackEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpBlackEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.black.WeChatMpBlackEntityUpdateEvent

class WeChatMpBlackEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpBlackEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.black.WeChatMpBlackRequest

class WeChatMpBlackRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.black.WeChatMpBlackResponse

class WeChatMpBlackResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.draft

Class com.bytedesk.wechat.mp.draft.WeChatMpDraftEntity

class WeChatMpDraftEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.draft.WeChatMpDraftEntityCreateEvent

class WeChatMpDraftEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpDraftEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.draft.WeChatMpDraftEntityUpdateEvent

class WeChatMpDraftEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpDraftEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.draft.WeChatMpDraftRequest

class WeChatMpDraftRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.draft.WeChatMpDraftResponse

class WeChatMpDraftResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.groupon

Class com.bytedesk.wechat.mp.groupon.WeChatMpGrouponEntity

class WeChatMpGrouponEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.groupon.WeChatMpGrouponEntityCreateEvent

class WeChatMpGrouponEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpGrouponEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.groupon.WeChatMpGrouponEntityUpdateEvent

class WeChatMpGrouponEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpGrouponEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.groupon.WeChatMpGrouponRequest

class WeChatMpGrouponRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.groupon.WeChatMpGrouponResponse

class WeChatMpGrouponResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.kefu

Class com.bytedesk.wechat.mp.kefu.WeChatMpKefuEntity

class WeChatMpKefuEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptedCase

int acceptedCase

inviteExpireTime

int inviteExpireTime

inviteStatus

String inviteStatus

inviteWx

String inviteWx

kfAccount

String kfAccount

kfHeadimgurl

String kfHeadimgurl

kfId

String kfId

kfNick

String kfNick

kfWx

String kfWx

name

String name

nickname

String nickname

status

int status

Class com.bytedesk.wechat.mp.kefu.WeChatMpKefuRequest

class WeChatMpKefuRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptedCase

Integer acceptedCase

kfAccount

String kfAccount

kfHeadimgurl

String kfHeadimgurl

kfId

String kfId

kfNick

String kfNick

kfWx

String kfWx

status

Integer status

Class com.bytedesk.wechat.mp.kefu.WeChatMpKefuResponse

class WeChatMpKefuResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

acceptedCase

Integer acceptedCase

kfAccount

String kfAccount

kfHeadimgurl

String kfHeadimgurl

kfId

String kfId

kfNick

String kfNick

kfWx

String kfWx

name

String name

status

Integer status

Package com.bytedesk.wechat.mp.kefu.event

Class com.bytedesk.wechat.mp.kefu.event.WeChatMpKefuEntityCreateEvent

class WeChatMpKefuEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpKefuEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.kefu.event.WeChatMpKefuEntityUpdateEvent

class WeChatMpKefuEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpKefuEntity weChatMiniEntity

Package com.bytedesk.wechat.mp.media

Class com.bytedesk.wechat.mp.media.WeChatMpMediaEntity

class WeChatMpMediaEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.media.WeChatMpMediaRequest

class WeChatMpMediaRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.media.WeChatMpMediaResponse

class WeChatMpMediaResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.media.event

Class com.bytedesk.wechat.mp.media.event.WeChatMpMediaEntityCreateEvent

class WeChatMpMediaEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpMediaEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.media.event.WeChatMpMediaEntityUpdateEvent

class WeChatMpMediaEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpMediaEntity weChatMiniEntity

Package com.bytedesk.wechat.mp.menu

Class com.bytedesk.wechat.mp.menu.WeChatMpMenuEntity

class WeChatMpMenuEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.menu.WeChatMpMenuRequest

class WeChatMpMenuRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.menu.WeChatMpMenuResponse

class WeChatMpMenuResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.menu.event

Class com.bytedesk.wechat.mp.menu.event.WeChatMpMenuEntityCreateEvent

class WeChatMpMenuEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpMenuEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.menu.event.WeChatMpMenuEntityUpdateEvent

class WeChatMpMenuEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpMenuEntity weChatMiniEntity

Package com.bytedesk.wechat.mp.tag

Class com.bytedesk.wechat.mp.tag.WeChatMpTagEntity

class WeChatMpTagEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.mp.tag.WeChatMpTagRequest

class WeChatMpTagRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.tag.WeChatMpTagResponse

class WeChatMpTagResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.mp.tag.event

Class com.bytedesk.wechat.mp.tag.event.WeChatMpTagEntityCreateEvent

class WeChatMpTagEntityCreateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpTagEntity weChatMiniEntity

Class com.bytedesk.wechat.mp.tag.event.WeChatMpTagEntityUpdateEvent

class WeChatMpTagEntityUpdateEvent extends org.springframework.context.ApplicationEvent implements Serializable

serialVersionUID:

1L

Serialized Fields

weChatMiniEntity

WeChatMpTagEntity weChatMiniEntity

Package com.bytedesk.wechat.mp.user

Class com.bytedesk.wechat.mp.user.WeChatMpUserEntity

class WeChatMpUserEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

channel

String channel

city

String city

country

String country

email

String email

groupid

Integer groupid

language

String language

mobile

String mobile

nickname

String nickname

note

String note

openid

String openid

province

String province

qrScene

Integer qrScene

qrSceneStr

String qrSceneStr

remark

String remark

sex

Integer sex

subscribe

Integer subscribe

subscribeScene

String subscribeScene

subscribeTime

Long subscribeTime

unionid

String unionid

Class com.bytedesk.wechat.mp.user.WeChatMpUserRequest

class WeChatMpUserRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Class com.bytedesk.wechat.mp.user.WeChatMpUserResponse

class WeChatMpUserResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.pay

Class com.bytedesk.wechat.pay.WeChatPayEntity

class WeChatPayEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Name of the WeChat Pay configuration

Class com.bytedesk.wechat.pay.WeChatPayRequest

class WeChatPayRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.pay.WeChatPayResponse

class WeChatPayResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Package com.bytedesk.wechat.work

Class com.bytedesk.wechat.work.WeChatWorkExtra

class WeChatWorkExtra extends BaseExtra implements Serializable

serialVersionUID:

1L

Serialized Fields

accessToken

String accessToken

企业微信访问令牌

appSecret

String appSecret

应用Secret

avatar

String avatar

头像URL

corpId

String corpId

企业ID

corpName

String corpName

所属企业名称

externalUserId

String externalUserId

企业微信客户的外部联系人ID

gender

String gender

性别

msgId

String msgId

消息ID

name

String name

客户姓名

openKfId

String openKfId

客服账号ID

position

String position

职位

servicerId

String servicerId

客服人员ID

sessionState

String sessionState

会话状态

type

String type

客户类型

unionId

String unionId

企业微信统一ID

welcomeCode

String welcomeCode

欢迎消息code

Package com.bytedesk.wechat.work.customer

Class com.bytedesk.wechat.work.customer.WeChatWorkCustomerRequest

class WeChatWorkCustomerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

adminList

List<String> adminList

appSecret

String appSecret

corpId

String corpId

cursor

String cursor

分页游标

description

String description

描述信息

externalUserid

String externalUserid

外部联系人的userid

limit

Integer limit

每次查询的数量上限

parentId

Integer parentId

partyid

List<Integer> partyid

部门ID列表

privilege

Map<String,Boolean> privilege

range

List<Map<String,Object>> range

rangeAdd

List<Map<String,Object>> rangeAdd

rangeDel

List<Map<String,Object>> rangeDel

remark

String remark

备注信息

remarkCompany

String remarkCompany

备注的企业名称

remarkMobiles

List<String> remarkMobiles

备注的手机号

remarkPicMediaid

String remarkPicMediaid

备注图片的mediaid

strategyId

Integer strategyId

strategyName

String strategyName

userid

List<String> userid

用户ID列表

userIdForExternal

String userIdForExternal

企业成员的userid

Class com.bytedesk.wechat.work.customer.WeChatWorkCustomerResponse

class WeChatWorkCustomerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

authorized

Map<String,List<String>> authorized

授权信息

externalContact

Map<String,Object> externalContact

外部联系人基本信息(原始Map数据)

externalContactInfo

WeChatWorkExternalContact externalContactInfo

外部联系人基本信息(对象形式)

externalUserids

List<String> externalUserids

外部联系人的userid列表

followInfos

List<Map<String,Object>> followInfos

跟进人信息列表

followUsers

List<String> followUsers

配置了客户联系功能的成员userid列表

invalidExternalUserIds

List<String> invalidExternalUserIds

无效的外部联系人ID列表

nextCursor

String nextCursor

分页游标

rangeList

List<Map<String,Object>> rangeList

规则组管理范围

sessionContext

Map<String,Object> sessionContext

客户会话上下文信息

strategy

Map<String,Object> strategy

规则组详情

strategyId

Integer strategyId

规则组ID

strategyList

List<Map<String,Object>> strategyList

规则组列表

unauthorized

Map<String,List<?>> unauthorized

未授权信息

Package com.bytedesk.wechat.work.group

Class com.bytedesk.wechat.work.group.WeChatWorkGroupRequest

class WeChatWorkGroupRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

appSecret

String appSecret

chatId

String chatId

客户群ID

corpId

String corpId

cursor

String cursor

用于分页查询的游标，字符串类型，由上一次调用返回，首次调用不填

limit

Integer limit

分页，预期请求的数据量，取值范围 1 ~ 1000

needName

Integer needName

是否需要返回群成员的名字 0-不返回；1-返回

opengid

String opengid

小程序在微信获取到的群ID

statusFilter

Integer statusFilter

客户群跟进状态过滤 0 - 所有列表(即不过滤) 1 - 离职待继承 2 - 离职继承中 3 - 离职继承完成

useridList

List<String> useridList

群主ID列表，用于过滤

Class com.bytedesk.wechat.work.group.WeChatWorkGroupResponse

class WeChatWorkGroupResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

chatId

String chatId

客户群ID（OpenGID转换）

code

Integer code

错误码

groupChat

WeChatWorkGroupChat groupChat

客户群详情

groupChatList

List<WeChatWorkGroupResponse.GroupChatItem> groupChatList

客户群列表

message

String message

错误消息

nextCursor

String nextCursor

分页游标，下次请求时填写以获取之后分页的记录

Package com.bytedesk.wechat.work.kefu.account

Class com.bytedesk.wechat.work.kefu.account.WeChatAccountEntity

class WeChatAccountEntity extends BaseEntity implements Serializable

serialVersionUID:

1L

Serialized Fields

name

String name

Class com.bytedesk.wechat.work.kefu.account.WeChatAccountRequest

class WeChatAccountRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

appSecret

String appSecret

corpId

String corpId

mediaId

String mediaId

客服头像临时素材ID

name

String name

客服名称

openKfid

String openKfid

客服账号ID

Class com.bytedesk.wechat.work.kefu.account.WeChatAccountResponse

class WeChatAccountResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

客服头像URL

managePrivilege

Boolean managePrivilege

是否有管理权限

name

String name

客服名称

openKfid

String openKfid

客服账号ID

Package com.bytedesk.wechat.work.kefu.servicer

Class com.bytedesk.wechat.work.kefu.servicer.WeChatWorkKefuResponse

class WeChatWorkKefuResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

avatar

String avatar

客服头像URL

managePrivilege

Boolean managePrivilege

是否有管理权限

name

String name

客服名称

openKfid

String openKfid

客服账号ID

Class com.bytedesk.wechat.work.kefu.servicer.WeChatWorkKefuServicerRequest

class WeChatWorkKefuServicerRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

appSecret

String appSecret

corpId

String corpId

departmentIdList

List<Integer> departmentIdList

接待人员部门id列表

mediaId

String mediaId

客服头像临时素材ID

name

String name

客服名称

openKfid

String openKfid

客服账号ID

useridList

List<String> useridList

接待人员userid列表

Class com.bytedesk.wechat.work.kefu.servicer.WeChatWorkKefuServicerResponse

class WeChatWorkKefuServicerResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

errcode

Integer errcode

错误码

errmsg

String errmsg

错误信息

resultList

List<WeChatWorkKefuServicerResultItem> resultList

操作结果列表 - 用于添加/删除接待人员

servicerList

List<WeChatWorkKefuServicerItem> servicerList

客服账号的接待人员列表 - 用于获取接待人员列表

Package com.bytedesk.wechat.work.kefu.session

Class com.bytedesk.wechat.work.kefu.session.WeChatWorkSessionRequest

class WeChatWorkSessionRequest extends BaseRequest implements Serializable

serialVersionUID:

1L

Serialized Fields

appSecret

String appSecret

changeType

Integer changeType

变更类型，均为接待人员在企业微信客户端操作触发 1-从接待池接入会话 2-转接会话 3-结束会话 4-重新接入已结束/已转接会话

corpId

String corpId

externalUserid

String externalUserid

微信客户的external_userid

file

Map<String,Object> file

文件消息

image

Map<String,Object> image

图片消息

link

Map<String,Object> link

链接消息

location

Map<String,Object> location

位置消息

mediaId

String mediaId

媒体文件ID

msgCode

String msgCode

用于发送事件响应消息的code

msgid

String msgid

消息ID

msgmenu

Map<String,Object> msgmenu

msgType

String msgType

事件响应消息类型

newServicerUserid

String newServicerUserid

新的接待人员userid

oldServicerUserid

String oldServicerUserid

老的接待人员userid

openKfid

String openKfid

客服账号ID

servicerUserid

String servicerUserid

接待人员的userid 当state=3时要求必填

serviceState

WeChatWorkSessionState serviceState

变更的目标状态

thread

ThreadProtobuf thread

会话线程对象，用于发送系统通知

video

Map<String,Object> video

视频消息

voice

Map<String,Object> voice

语音消息

Class com.bytedesk.wechat.work.kefu.session.WeChatWorkSessionResponse

class WeChatWorkSessionResponse extends BaseResponse implements Serializable

serialVersionUID:

1L

Serialized Fields

errcode

Integer errcode

错误码

errmsg

String errmsg

错误信息

msgCode

String msgCode

用于发送响应事件消息的code 将会话初次变更为service_state为2和3时，返回回复语code service_state为4时，返回结束语code

msgid

String msgid

消息ID

servicerUserid

String servicerUserid

接待人员的userid 仅当serviceState=3（由人工接待）时有效

serviceState

Integer serviceState

当前的会话状态 0: 未处理 - 新会话接入（客户发消息咨询） 1: 由智能助手接待 - 可使用API回复消息 2: 待接入池排队中 - 在待接入池中排队等待接待人员接入 3: 由人工接待 - 人工接待中 4: 已结束/未开始 - 会话已经结束或未开始

See Also:

• WeChatWorkSessionState

Package com.bytedesk.wechat.work.tag

Class com.bytedesk.wechat.work.tag.WeChatWorkTagRequest

class WeChatWorkTagRequest extends BaseRequest implements Serializable

Serialized Fields

addTag

List<String> addTag

agentid

Integer agentid

appSecret

String appSecret

corpId

String corpId

externalUserid

String externalUserid

groupId

List<String> groupId

groupIdSingle

String groupIdSingle

groupName

String groupName

id

String id

name

String name

order

Integer order

removeTag

List<String> removeTag

strategyId

Integer strategyId

tag

List<WeChatWorkTagItem> tag

tagId

List<String> tagId

userid

String userid