All Classes and Interfaces
Class
Description
帮助文档抽象基类
线程路由策略抽象基类
record for action and failed operations
操作日志记录处理
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
System action log entity
Represents user actions and system events for audit and monitoring purposes
Database Table: bytedesk_core_action
Purpose: Tracks user activities, system events, and security-related actions
创建发表朋友圈任务请求
创建朋友圈任务响应
Indicated that the Method of a Class extending
<br&gt;
SpringLongPollingBot will be called after the bot was registered
If the Method has a single Parameter of type BotSession, the method get passed the bot session the bot was registered with
<br&gt;
human agent, not ai agent
- agent：一对一人工客服，不支持机器人接待
- robot：机器人客服，不支持转人工
- workgroup：工作组，支持机器人接待，支持转人工
分表存储一对一客服消息
同步message中客服消息，包括uid。
接待状态变更记录
https://github.com/alibaba/easyexcel
客服配置模板：当有多个客服时，可以快速为多个客服配置相同的模板，例如：客服工作时间、客服头像等。
https://github.com/alibaba/easyexcel
客服线程路由策略
负责处理一对一人工客服的线程创建和路由逻辑
AiStatistic entity for content categorization and organization
Provides ai functionality for various system entities
Database Table: bytedesk_core_statistic
Purpose: Stores statistic definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
阿里云OSS对象存储服务工具类
参考
阿里云OSS上传服务实现
https://blog.csdn.net/MICHAELKING1/article/details/106058874
https://springdoc.cn/spring/core.html#aop
https://blog.csdn.net/MICHAELKING1/article/details/106058874
Pushy
帮助文档: 文章归档, 历史版本
Controller for "/article_archive".
elasticsearch 全文检索服务
帮助文档
文章索引消息
用于在Artemis队列中传递需要索引的文章信息
文章索引消息监听器
处理文章的索引和删除消息
文章索引消费者
用于处理文章索引队列中的消息
文章消息服务
使用核心模块中的JmsTemplate发送文章索引请求
Controller for "/article".
文章向量索引实体类
用于在Elasticsearch中存储文章的向量表示
文章向量搜索结果实体类
用于表示向量相似度检索的结果
文章向量检索服务
用于处理文章的向量存储和相似度搜索
assistant - 如：文件助手
音频消息内容类
语音转文本（语音识别）
spring ai alibaba 1.0.0.3 待发布，暂时无法使用
语音转文本（语音合成）
spring ai alibaba 1.0.0.3 待发布，暂时无法使用
https://www.baeldung.com/get-user-in-spring-security
客户端扫码授权vip接口
访客端
扫码授权vip接口
访客验证
自动回复-固定自动回复，无匹配规则，直接回复。
Auto reply data structure
自动回复数据结构
自动回复-关键词匹配
Auto reply keyword data structure
自动回复关键词数据结构
头像常量, 可以去这里获取 https://www.iconfont.cn/
重构API配置
用户余额
Date -&gt; ZonedDateTime ？
Date -&gt; ZonedDateTime ？
基础请求类
所有请求类的父类，提供通用字段和方法
企业微信API基础响应类，包含通用的响应码和消息
通用响应类
基础RestController，不需要指定Service类型
适用于所有方法都被子类重写的场景
改进的基础RestService类
在原有抽象方法基础上，提供通用的默认实现来减少重复代码
需要自己重新实现的抽象方法
改进的基础RestService类
在原有抽象方法基础上，提供通用的默认实现来减少重复代码
改进的带Excel导出功能的基础RestService类
继承自BaseRestServiceImproved，增加Excel相关抽象方法
基础Specification类
提供通用的查询条件构建方法
Prompt处理结果类
Spring Batch配置类
用于配置Spring Batch所需的基本组件
时间常用函数
File utilities.
高性能中文拼音转换工具
https://github.com/houbb/pinyin
https://mvnrepository.com/artifact/com.github.houbb/pinyin
https://github.com/houbb/pinyin/blob/master/src/test/java/com/github/houbb/pinyin/test/util/PinyinHelperTest.java
敏感词工具类
https://github.com/houbb/sensitive-word
https://mvnrepository.com/artifact/com.github.houbb/sensitive-word
https://mp.weixin.qq.com/s/7wSy0PuJLTudEo9gTY5s5w
Handles handshakes and messages
Allocate 64 bits for the UID(long)<br&gt;
sign (fixed 1bit) -> deltaSecond -> workerId -> sequence(within the same second)
black list
黑名单
https://github.com/alibaba/easyexcel
黑名单ip拦截器
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
黑名单管理接口
黑名单用户拦截器
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
https://github.com/alibaba/easyexcel
访客浏览网站记录实体类。
访客浏览记录Excel导出模型
浏览记录管理控制器。
浏览记录服务实现类。
浏览器语言检测过滤器
优先使用URL参数中的语言设置，其次使用浏览器语言设置，最后使用默认语言
Buffered UID provider(Lambda supported), which provides UID in the same one second
Represents an executor for padding
RingBuffer<br>
There are two kinds of executors: one for scheduled padding, the other for padding immediately.按钮内容类
用于构建Messenger平台的各种按钮类型
支持的按钮类型：
- web_url: 网页按钮
- postback: 回发按钮
- phone_number: 电话按钮
- game_play: 游戏开始按钮
- account_link: 登录按钮
- account_unlink: 注销按钮
- extension: 扩展按钮
使用示例：
1.
游戏元数据类
验证结果类
统一管理监控指标
缓存 常量
Represents a cached implementation of
UidGeneratorService extends
from DefaultUidGenerator, based on a lock free RingBuffer<p>
<p>
The spring properties you can specified as below:<br>
boostPower:</b> RingBuffer size boost for a power of 2, Sample: boostPower is 3, it means the buffer size
will be getMaxSequence() + 1
paddingFactor:</b> Represents a percent value of (0 - 100).Call坐席实体类
坐席模式枚举
坐席状态枚举
Call坐席数据访问接口
Call坐席服务类
通话应答事件
Call呼叫实体类
呼叫状态枚举
呼叫类型枚举
通话事件基类
通话事件监听器
负责监听和处理各种通话相关的事件
通话挂断事件
Call呼叫数据访问接口
呼叫信息
呼叫控制器
Call呼叫服务类
呼叫服务
通话开始事件
Call通话详单REST API控制器
FreeSwitch通话详单表 (CDR)
Call call detail record entity
Stores detailed information about voice calls processed by Call
Database Table: bytedesk_call_cdr
Purpose: Records call metadata, timing information, and call quality metrics
Call CDR实体监听器
Call事件监听器
Call通话详单Excel导出类
https://github.com/alibaba/easyexcel
Call CDR仓库接口
Call通话详单请求实体
Call通话详单响应实体
Call CDR服务类
通话统计信息类
Call会议室管理REST API控制器
Call会议室实体
对应数据库表：freeswitch_conferences
Call会议室实体监听器
Call事件监听器
Call会议室Excel导出类
https://github.com/alibaba/easyexcel
Call会议室仓库接口
Call会议服务类
处理会议室创建、管理、成员控制等业务逻辑
会议室统计信息类
Call会议室查询规范
Call配置类
该配置类用于设置Call ESL客户端连接和事件监听器。
Call连接测试工具
在应用程序启动时自动测试ESL连接
Call REST API控制器
Call默认配置
当Call未启用时，提供一个空的Client实现
DTMF 事件
使用 thingscloud 库的 Call ESL 客户端配置
参考链接：https://github.com/zhouhailin/freeswitch-externals
Call事件监听器
Call事件发布器
Call配置属性
Call网关管理REST API控制器
网关统计信息内部类
Call网关实体
对应数据库表：freeswitch_gateways
Call网关实体监听器
Call事件监听器
Call网关Excel导出实体
Call网关仓库接口
Call网关请求实体
Call网关响应实体
Call网关REST控制器
Call网关REST服务
Call网关服务类
处理SIP网关配置、状态监控、连接管理等业务逻辑
Call网关查询规格
Call健康检查器
为Spring Boot Actuator提供Call连接状态监控
连接状态信息类
CallIvr entity for content categorization and organization
Provides ivr functionality for various system entities
Database Table: bytedesk_call_ivr
Purpose: Stores ivr definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
Call管理API
提供Call连接状态查询和诊断功能
配置信息类
测试结果类
故障排除指南类
CallMrcp entity for content categorization and organization
Provides mrcp functionality for various system entities
Database Table: bytedesk_call_mrcp
Purpose: Stores mrcp definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
Call队列实体类
队列状态枚举
队列类型枚举
Call队列数据访问接口
Call队列服务类
Call队列统计信息
Call路由服务类
Call核心服务类
CallStatistic entity for content categorization and organization
Provides statistic functionality for various system entities
Database Table: bytedesk_core_statistic
Purpose: Stores statistic definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
呼叫统计数据模型
呼叫统计服务接口
Call用户管理REST API控制器
用户统计信息内部类
Call用户实体
对应数据库表：freeswitch_users
Call用户实体监听器
Call事件监听器
Call用户Excel导出类
https://github.com/alibaba/easyexcel
Call用户仓库接口
Call用户请求实体
Call用户响应实体
Call用户服务类
处理SIP用户管理、注册状态监控等业务逻辑
Call 视频客服实体
用于管理基于WebRTC的视频客服功能
https://github.com/alibaba/easyexcel
WebSocket配置 - 用于WebRTC信令
取消朋友圈任务请求
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
ChatClient信息查询控制器
提供查看所有ChatClient和Primary ChatClient的接口
ChatClient信息查询服务
提供查看所有ChatClient和Primary ChatClient的服务
根据spring.ai.model.chat配置动态设置Primary的ChatClient
支持的值：zhipuai, ollama, dashscope, deepseek, baidu, tencent, volcengine, openai, openrouter, siliconflow, gitee, none
ChatClient测试控制器
提供基本的聊天功能演示
ChatModel信息查询控制器
提供查看所有ChatModel和Primary ChatModel的接口
ChatModel信息查询服务
提供查看所有ChatModel和Primary ChatModel的服务
根据spring.ai.model.chat配置动态设置Primary的ChatModel
支持的值：zhipuai, ollama, dashscope, deepseek, baidu, tencent, volcengine, openai, openrouter, siliconflow, gitee, none
Chunk实体的Elasticsearch版本
用于全文搜索
elasticsearch 全文检索服务
拆分实体
用于向量检索：文件、文本、网站等所有拆分内容全部存储在此
向量检索内容全部放到且仅放在此表中
Chunk导出Excel实体类
Chunk向量索引实体类
用于在Elasticsearch中存储Chunk的向量表示
Chunk向量搜索结果实体类
用于表示向量相似度检索的结果，参考FaqVectorSearchResult结构
Chunk向量检索服务
用于处理Chunk的向量存储和相似度搜索
剪贴板
https://github.com/alibaba/easyexcel
Consumer entity for content categorization and organization
Provides consumer functionality for various system entities
Database Table: bytedesk_ai_consumer
Purpose: Stores consumer definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
非销售模块
仅用于密钥验证
防止非法盗用
https://dzone.com/articles/how-to-use-cookies-in-spring-boot
Course entity for educational content management
Represents courses with categories, pricing, and publication status
Database Table: liangshibao_course
Purpose: Stores course information, categories, and publication settings
https://www.coze.cn/open/docs/developer_guides
https://www.coze.cn/open/docs/developer_guides
自定义聊天客户端观察约定
获客助手控制器
提供企业微信获客助手相关REST API接口
企业微信获客助手服务
提供获客链接相关的API功能实现
Customer entity for lead management and customer relationship management
Represents customer information collected automatically or manually added
Database Table: bytedesk_service_customer
Purpose: Stores customer contact information, preferences, and interaction history
客户信息导出Excel模型
https://github.com/alibaba/easyexcel
https://docs.spring.io/spring-data/jpa/reference/repositories/projections.html
https://docs.spring.io/spring-ai/reference/api/tools.html#_requiredoptional
自定义webhook推送
https://docs.spring.io/spring-ai/reference/api/tools.html
Represents an implementation of
UidGeneratorService
<p>
The unique id has 64bits (long), default allocated as blow:<br>
sign: The highest bit is 0
delta seconds: The next 28 bits, represents delta seconds since a customer epoch(2016-05-20 00:00:00.000).Department entity for organizational hierarchy management
Manages department structure with parent-child relationships
Database Table: bytedesk_team_department
Purpose: Stores department information and hierarchical organization structure
Dify Chat Controller
https://docs.dify.ai/zh-hans/guides/application-publishing/developing-with-apis
Dify Chat Service - 基于 Dify API 的对话服务
https://docs.dify.ai/zh-hans/guides/application-publishing/developing-with-apis
Dify 配置属性
对话信息
对话列表响应
消息信息
消息列表响应
检索项
使用情况统计
Dify 功能测试工具
推送到钉钉的webhook
Represents an implementation of
WorkerIdAssigner,
the worker id will be discarded after assigned to the UidGenerator文档消息内容类
Douyin application entity for managing Douyin integration
Handles Douyin Official Account, Mini Program, and Work application configurations
Database Table: bytedesk_channel_douyin_app
Purpose: Stores Douyin app credentials, access tokens, and integration settings
https://github.com/alibaba/easyexcel
微语互动
https://developer.open-douyin.com/docs/resource/zh-CN/web-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
评论互动
抖店
https://developer.open-douyin.com/docs/resource/zh-CN/web-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
抖店相关接口
对接抖音小程序：微语
https://developer.open-douyin.com/docs/resource/zh-CN/mini-app/open-capacity/operation/customer-service/customer-service-introduce
https://developer.open-douyin.com/docs/resource/zh-CN/dop/develop/webhooks/summarize
小程序
邮件消息内容类
用于存储邮件的核心信息，包括主题、内容、附件等
邮件附件类
邮件编码测试工具类
用于测试和验证邮件编码解码功能
邮件编码解码工具类
用于处理MIME编码的邮件头和邮件内容提取
https://github.com/alibaba/easyexcel
邮件统一额外信息存储类
用于解析 VisitorRequest.extra 和 ThreadEntity.extra 字段中的信息，特别是当 client/channel 为 EMAIL 时
邮件IDLE监听服务
使用IMAP IDLE协议实现实时邮件接收，替代轮询方式
邮件监听配置
用于管理不同协议的监听策略
监听策略枚举
邮件监听管理控制器
提供监听状态查询和管理接口
邮件附件信息
https://github.com/alibaba/easyexcel
邮件附件内部类
发送状态枚举
邮件发送服务
提供邮件发送功能，支持HTML、文本、附件等
邮件接收服务实现
邮件同步概览状态
邮件同步服务
负责管理和监控邮件账户的收发邮件
邮件同步状态信息
邮件模板
推送到email
EmbeddingModel信息查询控制器
提供查看所有EmbeddingModel和Primary EmbeddingModel的接口
EmbeddingModel信息查询服务
提供查看所有EmbeddingModel和Primary EmbeddingModel的服务
企业微信企业群发消息服务
提供企业群发相关功能，包括：
1.
JPA Entity Listener 辅助工具类
用于在 Entity Listener 中安全地获取 Spring Bean
EnumUtils provides the operations for
ValuedEnum such as Parse, value of...储存不同VIP等级的答案内容
FAQ批处理作业配置
FAQ批量导入服务
用于启动和管理FAQ批量导入作业
elasticsearch 全文检索服务
faq: Frequently Asked Questions
实现Spring Batch的ItemReader接口，用于读取Excel文件中的FAQ数据
自定义监听器，将读取到的数据添加到队列中
FAQ索引消费者
用于处理FAQ索引队列中的消息
FAQ索引消息
用于在Artemis队列中传递需要索引的FAQ信息
FAQ数据处理器
将Excel中的FAQ数据转换为FaqEntity对象
FAQ数据写入器
将处理后的FaqEntity批量保存到数据库
FAQ JSON文件加载器
用于从JSON文件中加载FAQ数据并解析成对象
FAQ实体类
对应JSON文件中的每个FAQ条目
FAQ配置类
对应JSON文件的根节点
FAQ消息服务
使用核心模块中的JmsTemplate发送FAQ索引请求
FAQ向量索引实体类
用于在Elasticsearch中存储FAQ的向量表示
FAQ向量搜索结果实体类
用于表示向量相似度检索的结果，参考FaqElasticSearchResult结构
FAQ向量检索服务
用于处理FAQ的向量存储和相似度搜索
收藏来源枚举
收藏工具类
Feature entity for system feature management and licensing
Manages feature flags, configurations, and premium feature access
Database Table: bytedesk_core_feature
Purpose: Stores feature definitions, configurations, and access control settings
https://github.com/alibaba/easyexcel
Voice of Customer feedback entity for user feedback management
Manages user feedback, suggestions, and complaint tracking
Database Table: bytedesk_voc_feedback
Purpose: Stores user feedback content, status tracking, and assignment management
飞书通知服务
提供各种业务场景的通知功能
推送到飞书的webhook
文件消息内容类
文件导出Excel实体类
Exception caused by accessing forbidden resources.
Custom form entity for customer service interactions
Supports various form types like feedback forms, pre-inquiry forms, ticket forms, surveys, etc.
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
表单状态枚举
获取朋友圈互动数据响应
获取朋友圈可见客户列表响应
获取朋友圈列表请求
获取朋友圈列表响应
获取朋友圈发送结果响应
获取客户朋友圈企业发表的列表响应
获取朋友圈任务结果请求
获取朋友圈任务结果响应
灰度发布控制器
灰度发布配置
用于控制新功能的逐步放量
灰度发布功能枚举
功能使用统计
灰度发布指标实体
灰度发布指标服务
灰度发布服务
灰度发布状态
灰度发布策略
按自然日聚合的群聊数据统计响应
按自然日聚合的统计项
统计数据详情
群聊数据统计请求模型
群主过滤器
按群主聚合的群聊数据统计响应
按群主聚合的统计项
统计数据详情
Team group entity for group chat and collaboration management
Manages group settings, members, and communication features
Database Table: bytedesk_team_groups
Purpose: Stores group information, member relationships, and group settings
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
for testing api
http://127.0.0.1:9003/swagger-ui/index.html
节假日设置
https://github.com/alibaba/easyexcel
节假日重复类型枚举
用于标记需要国际化的 API 操作
国际化配置
图片消息内容类
Instagram按钮模板数据模型
Button Template for Instagram Messaging
https://developers.facebook.com/docs/messenger-platform/instagram/features/button-template
附件类型常量
按钮类型常量
模板类型常量
Instagram按钮模板控制器
Button Template Controller for Instagram Messaging
提供按钮模板消息的REST API接口
https://developers.facebook.com/docs/messenger-platform/instagram/features/button-template
按钮模板请求
混合按钮请求
回传按钮请求
三按钮请求
URL按钮请求
验证响应
Instagram按钮模板使用示例
Button Template Usage Examples for Instagram Messaging
展示如何使用按钮模板服务发送各种类型的按钮消息
https://developers.facebook.com/docs/messenger-platform/instagram/features/button-template
Button Template Service
按钮模板服务
按钮模板发送一条最多可附带三个按钮的文本消息。
Instagram菜单操作响应
成功响应示例:
{
"result": "success"
}
失败响应示例:
{
"error": {
"message": "Error message",
"type": "OAuthException",
"code": 190,
"error_subcode": 33,
"fbtrace_id": "trace_id"
}
}
消息类型常量
反应类型常量
发送者动作常量
Instagram消息发送控制器
提供REST API接口用于发送各种类型的Instagram消息
Instagram消息发送响应
成功响应示例:
{
"recipient_id": "IGSID",
"message_id": "MESSAGE-ID"
}
失败响应示例:
{
"error": {
"message": "Error message",
"type": "OAuthException",
"code": 190,
"error_subcode": 33,
"fbtrace_id": "trace_id"
}
}
发送消息
Instagram Message Service
https://developers.facebook.com/docs/messenger-platform/instagram/features/send-message
Instagram持久菜单数据模型
Persistent Menu for Instagram Messaging
持久菜单允许您创建并发送包含业务主要功能（如营业时间、店铺位置和产品等）的菜单，
该菜单始终显示在用户与您的业务在 Messenger 中的对话中。
按钮类型常量
区域设置常量
Instagram持久菜单控制器
Persistent Menu Controller for Instagram Messaging
提供持久菜单的REST API接口
https://developers.facebook.com/docs/messenger-platform/instagram/features/persistent-menu
默认菜单请求
本地化菜单请求
多区域菜单请求
验证响应
Instagram持久菜单使用示例
Persistent Menu Usage Examples for Instagram Messaging
展示如何使用持久菜单服务设置各种类型的菜单
https://developers.facebook.com/docs/messenger-platform/instagram/features/persistent-menu
Persistent Menu Service
持久菜单服务
持久菜单允许您创建并发送包含业务主要功能（如营业时间、店铺位置和产品等）的菜单，
该菜单始终显示在用户与您的业务在 Messenger 中的对话中。
Instagram私密回复控制器
提供REST API接口用于发送私密回复和管理相关功能
https://developers.facebook.com/docs/messenger-platform/instagram/features/private-replies
Instagram私密回复使用示例
展示如何使用Instagram私密回复功能的完整示例
https://developers.facebook.com/docs/messenger-platform/instagram/features/private-replies
Private Replies
私密回复
https://developers.facebook.com/docs/messenger-platform/instagram/features/private-replies
功能说明：
1.
评论数据类
Instagram商品模板API控制器
Product Template Controller for Instagram Messaging
https://developers.facebook.com/docs/messenger-platform/instagram/features/product-template
默认订阅请求
通知CTA文本响应
通知频率响应
订阅请求
商品轮播请求
单个商品请求
验证响应
Instagram商品模板使用示例
Product Template Examples for Instagram Messaging
https://developers.facebook.com/docs/messenger-platform/instagram/features/product-template
用于 Instagram 消息的商品模板
产品模板
https://developers.facebook.com/docs/messenger-platform/instagram/features/product-template
通知CTA文本常量
通知频率常量
Instagram快速回复控制器
Quick Replies API Controller
https://developers.facebook.com/docs/messenger-platform/instagram/features/quick-replies
混合快速回复请求
用户电话号码快速回复请求
文本快速回复请求
验证请求
验证响应
Instagram快速回复使用示例
Quick Replies Usage Examples
https://developers.facebook.com/docs/messenger-platform/instagram/features/quick-replies
快速回复
Quick Replies
https://developers.facebook.com/docs/messenger-platform/instagram/features/quick-replies
快速回复数据类
快速回复Webhook事件数据类
快速回复类型常量
动态提及
Story Mentions
https://developers.facebook.com/docs/messenger-platform/instagram/features/story-mention
上传附件
Upload Media for Instagram Messaging
为 Instagram 消息上传媒体
https://developers.facebook.com/docs/messenger-platform/instagram/features/attachment-upload
用户个人主页 API
User Profile
https://developers.facebook.com/docs/messenger-platform/instagram/features/user-profile
https://github.com/alibaba/easyexcel
用于训练意图识别模型的数据结构
记录会话中意图的转换历史
https://github.com/alibaba/easyexcel
发票
发票管理
https://github.com/lionsoul2014/ip2region/blob/master/binding/java/ReadMe.md
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
IP缓存初始化器
在应用启动时加载所有IP白名单和黑名单到缓存中
IP缓存服务 - 使用Redis缓存提高IP匹配效率
优化策略：
1.
for testing
https://github.com/lionsoul2014/ip2region/blob/master/binding/java/ReadMe.md
https://github.com/alibaba/easyexcel
域名管理，实现主备域名自动切换
Jackson ObjectMapper 配置
提供两种不同的 ObjectMapper 实例:
1.
自定义 ZonedDateTime 反序列化器
支持多种日期时间格式，包括没有时区信息的格式
JanusAudio entity for content categorization and organization
Provides audio functionality for various system entities
Database Table: bytedesk_janus_audio
Purpose: Stores janus_audio definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
JanusVideo entity for content categorization and organization
Provides video functionality for various system entities
Database Table: bytedesk_janus_video
Purpose: Stores janus_video definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
for testing api
JMS 错误处理器
JPA审计配置
解决LocalDateTime到ZonedDateTime的转换问题
将 List<String&gt; 转换为 JSON 数组字符串进行存储
专门用于存储包含 JSON 的列表，避免使用逗号分隔导致的问题
JsonParse class
提供提取消息格式中的密文及生成回复消息格式的接口.
返回结果
https://github.com/jwtk/jjwt#jws-create-key
https://github.com/alibaba/easyexcel
知识库切面
Knowledge base entity for organizing and managing knowledge articles
Combines knowledge base functionality with workspace features
Database Table: bytedesk_kbase
Purpose: Stores knowledge base configurations, themes, and member management
TODO: delete event 删除相应网页
Knowledge base invite entity for member invitation management
Manages invitations to join knowledge bases and collaboration spaces
Database Table: bytedesk_kbase_invite
Purpose: Stores invitation configurations and member access management
https://github.com/alibaba/easyexcel
KbaseStatistic entity for content categorization and organization
Provides statistic functionality for various system entities
Database Table: bytedesk_core_statistic
Purpose: Stores statistic definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
授权版本枚举
功能特性枚举
授权类型枚举
用户类型枚举
https://github.com/alibaba/easyexcel
Line消息服务
用于发送消息到Line用户
注意：Line的主动推送消息需要特殊的权限和配置
目前所有消息类型都转换为文本消息发送
Line Bot配置属性
Line线程额外信息
存储线程中的Line相关参数
Line访客额外信息存储类
用于解析 VisitorRequest.extra 字段中的信息，特别是当 client 为 LINE 时
链接消息内容类
获客链接请求模型
获客链接响应模型
聊天信息
客户信息
链接信息
优先选项
配额信息
使用范围
LLM model entity for AI model management
Manages large language model configurations and provider relationships
Database Table: bytedesk_ai_model
Purpose: Stores LLM model definitions, types, and provider associations
AI Token使用统计事件
用于解耦AI服务和Token统计服务
位置消息内容类
https://docs.spring.io/spring-integration/reference/mail.html
邮件接收配置类
https://docs.spring.io/spring-integration/reference/mail.html
https://github.com/alibaba/easyexcel
MaxKB Chat Controller - MaxKB 对话 API 控制器
https://maxkb.cn/docs/v1/dev_manual/APIKey_chat/#1-openai-api
MaxKB 聊天完成请求类 - OpenAI 兼容格式
https://maxkb.cn/docs/v1/dev_manual/APIKey_chat/#1-openai-api
MaxKB Chat Service - 基于 MaxKB OpenAI 兼容 API 的对话服务
https://maxkb.cn/docs/v1/dev_manual/APIKey_chat/#1-openai-api
MaxKB 配置类
https://maxkb.cn/docs/v1/dev_manual/APIKey_chat/#1-openai-api
MaxKB 简单消息请求类
MaxKB 带系统角色的消息请求类
MaxKB 测试工具类
用于验证 MaxKB API 集成功能
简化的 MCP 提示类
用于替代 Spring AI MCP 中缺失的 McpPrompt
简化的 MCP 资源类
用于替代 Spring AI MCP 中缺失的 McpResource
MCP Server authentication type enumeration
Represents different authentication methods for MCP servers
McpServer entity for Model Context Protocol server configuration and management
Stores MCP server connection details, capabilities, and runtime information
Database Table: bytedesk_ai_mcp_server
Purpose: Stores MCP server definitions, connection settings, and capability information
https://github.com/alibaba/easyexcel
MCP Server Excel export/import template
MCP Server protocol enumeration
Represents the communication protocol used by MCP servers
MCP Server 客户端服务 - 简化版本
负责与第三方 MCP 服务器通信，调用工具、获取资源、管理连接等
注意：当前版本为简化实现，主要用于配置管理和接口定义
Spring AI 1.0.1 的 MCP 客户端 API 正在发展中，未来版本将提供完整的客户端功能
服务器状态信息
MCP Server status enumeration
Represents the current operational status of MCP servers
简化的 MCP 工具类
用于替代 Spring AI MCP 中缺失的 McpTool
MD5编码相关的类
Member批量导入消息消费者
参考FAQ的异步处理模式，用于处理Member批量导入消息
Member批量导入消息
用于在消息队列中传递Member批量导入信息
Member批量导入消息服务
参考FAQ的异步处理模式，用于发送Member批量导入消息到消息队列
Team member entity for organizational structure management
Manages member profiles, roles, and department assignments
Database Table: bytedesk_team_member
Purpose: Stores member information, contact details, and organizational relationships
https://spring.io/guides/tutorials/react-and-spring-data-rest/
https://docs.spring.io/spring-security/reference/
http://127.0.0.1:9003/swagger-ui/index.html
https://www.bezkoder.com/swagger-3-annotations/#Swagger_3_annotations
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
Message entity for storing individual chat messages
Represents a single message within a conversation thread
Database Table: bytedesk_core_message
Purpose: Stores message content, sender information, and message metadata
消息扩展字段，用于存储额外的信息
https://github.com/alibaba/easyexcel
Customer leave message entity
Represents customer messages left when agents are offline or unavailable
Database Table: bytedesk_service_message_leave
Purpose: Stores offline messages from customers when agents are unavailable
Message leave type enumeration
Defines different types of leave messages for categorization and routing
消息解析
解析器：提取关键词、提取实体信息、提取意图
https://github.com/alibaba/easyexcel
消息持久化缓存服务
使用Redis List结构存储消息，支持消息的推入和批量获取
消息三要素：1.
消息三要素：1.
所有字段跟message.proto中字段一一对应
response for visitor init/request thread
distinguish visitor message from agent view
区分 访客端拉取的消息格式 和 客服端拉取到的消息格式
https://github.com/alibaba/easyexcel
消息点赞、点踩、反馈、转接
response for visitor init/request thread
distinguish visitor message from agent view
区分 访客端拉取的消息格式 和 客服端拉取到的消息格式
消息管理接口控制器
企业版消息管理接口控制器 - 包含未读消息等高级功能
企业版消息服务 - 包含未读消息等高级功能
企业版消息查询规范 - 包含未读消息等高级功能
群发消息-模版实体
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
存储未读消息，减少message表查询压力
缓存每个用户该接收的消息，自己发送的消息自己不缓存
收到客户端的回执receipt后，删除该条缓存记录
客户端拉取之后，从表中删除该条记录
消息未读事件监听器
https://github.com/alibaba/easyexcel
Messenger广告欢迎消息流API服务
https://developers.facebook.com/docs/messenger-platform/ads/ads-welcome-message-flows
实现Facebook Messenger广告直接API的欢迎消息流功能
Messenger访客模式服务
https://developers.facebook.com/docs/messenger-platform/discovery/facebook-chat-plugin/guest-mode
Guest Mode允许用户通过Chat Plugin与企业聊天，无需登录Facebook账户
https://developers.facebook.com/docs/messenger-platform/send-messages/personas
Meta应用相关常量定义
https://github.com/alibaba/easyexcel
Meta平台的Webhooks处理类
处理来自Meta平台的webhook事件
https://developers.facebook.com/docs/messenger-platform/webhooks
测试：
1. ngrok http 9003，生成url
2.
Graph API交互类
内部用户类
Meta Catalog API服务
用于与Facebook Commerce Manager和Catalog API交互
参考文档：https://developers.facebook.com/docs/commerce-platform/catalog-api
Meta额外信息
合并了MetaThreadExtra和MetaVisitorExtra的功能
存储Meta相关的线程和访客参数
Meta平台素材服务
用于上传附件并获取attachment_id，用于媒体模板
参考文档：
https://developers.facebook.com/docs/messenger-platform/send-messages/saving-assets
https://developers.facebook.com/docs/messenger-platform/reference/attachment-upload-api/
注意：附件编号将于90天后过期。
Meta平台消息服务演示类
展示如何使用MetaMessageService发送各种类型的模板消息
Meta平台消息服务
用于发送各种类型的消息到Meta平台
限制：
标准消息时间范围指的是 24 小时的时段，在此期间，您可向用户发送消息
消息模板：
https://developers.facebook.com/docs/messenger-platform/send-messages/templates
https://developers.facebook.com/docs/messenger-platform/send-messages
Request object for Facebook Messenger API
Response object for Facebook Messenger API
Service for handling media uploads to Facebook Messenger
Service for handling Facebook access tokens
https://github.com/alibaba/easyexcel
Moment entity for content categorization and organization
Provides moment functionality for various system entities
Database Table: bytedesk_core_moment
Purpose: Stores moment definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
企业微信朋友圈服务接口
Various utilities for working with channels
存储常量
检测空闲连接和超时是为了及时释放资源: 在规定时间内没有收到来自客户端的任何packet，包括ping
常用的方法：
1.
会话存储
encrypt/security through nginx proxy
Auto-configuration for MySQL chat memory repository.
Configuration properties for MySQL chat memory repository.
MySQL implementation of chat memory repository
RAGFlow Chat Controller
https://n8n.io/docs/dev/http_api_reference
RAGFlow 聊天请求数据结构
RAGFlow 简单消息请求数据结构
N8N Chat Service - 基于 N8N API 的对话服务
https://n8n.io/docs/dev/http_api_reference
RAGFlow 配置属性
RAGFlow 功能测试工具
Named thread in ThreadFactory.
NetUtils
Resource not found
channel 频道 - 类似公众号
System notice entity for announcements and notifications
Different from message type notices - used for system-wide announcements
Database Table: bytedesk_core_notice
Purpose: Stores system announcements, alerts, and important notifications
https://github.com/alibaba/easyexcel
Service for handling notice operations
Enum for message types
Not Login Exception.
https://github.com/ollama4j/ollama4j
https://ollama4j.github.io/ollama4j/intro
企业微信在职成员客户转接服务
Generic handler for optimistic locking retry operations
订单信息
https://github.com/alibaba/easyexcel
// @RepositoryRestResource(exported = false) // 隐藏接口
Represents a padded
AtomicLong to prevent the FalseSharing problem<p>
The CPU cache line commonly be 64 bytes, here is a sample of cache line after padding:<br>
64 bytes = 8 bytes (object reference) + 6 * 8 bytes (padded long) + 8 bytes (a long value)可分页请求接口
为不同的Request基类提供统一的分页方法接口
Controller for "/".
http://127.0.0.1:9003/swagger-ui/index.html
only used for development
页面服务，仅用于开发阶段
密码加密解密工具类
与前端JavaScript实现保持一致的AES加密解密
修复说明：
- 统一前后端密钥生成方式，解决 BadPaddingException 问题
- 对于特定盐值 "bytedesk_salt"，使用固定密钥 "bytedesk_license"（与前端保持一致）
- 对于其他盐值，使用SHA-256哈希生成16字节密钥（128位AES）
- 加密算法：AES/ECB/PKCS5Padding
密码哈希工具类
用于验证前端传来的密码哈希
消费记录
消费记录
https://github.com/google/libphonenumber/
https://www.baeldung.com/java-libphonenumber
基于google的libphonenumber将手机号转成地区及供应商信息
提供基于PKCS7算法的加解密接口.
提供基于PKCS7算法的加解密接口.
Forum post entity for community discussions
Manages forum posts, content, and user interactions
Database Table: bytedesk_forum_post
Purpose: Stores forum posts, categories, and engagement metrics
微信企业商品图册控制器
删除商品图册的请求
获取商品图册的请求
获取商品图册列表的请求
商品图册请求模型
商品图册响应模型
微信企业商品图册服务接口
微信企业商品图册服务实现类
更新商品图册请求模型
商品信息
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
async push
https://www.baeldung.com/spring-async
https://spring.io/guides/gs/async-method
https://springdoc.cn/spring-boot-email/
https://springdoc.cn/spring/integration.html#mail
https://mailtrap.io/blog/spring-send-email/
https://www.thymeleaf.org/doc/articles/springmail.html
http://blog.didispace.com/springbootmailsender/
离线推送token
QualityAppeal entity for content categorization and organization
Provides appeal functionality for various system entities
Database Table: bytedesk_service_appeal
Purpose: Stores appeal definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
QualityAppeal Status Enum
申诉状态枚举
QualityCheck entity for content categorization and organization
Provides check functionality for various system entities
Database Table: bytedesk_service_check
Purpose: Stores check definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
质检等级枚举
定义不同的质检等级及其对应的分数范围和颜色
QualityCheck status enum for appeal related states
质检状态枚举，用于表示申诉相关状态
QualityFlow entity for content categorization and organization
Provides tagging functionality for various system entities
Database Table: bytedesk_service_tag
Purpose: Stores tag definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
质检指标信息
存储单个质检指标的详细信息
QualityPlan entity for quality inspection plan management
Provides comprehensive quality inspection functionality for various service types
Database Table: bytedesk_service_quality_plan
Purpose: Stores quality inspection plan definitions, indicators, and scoring rules
https://github.com/alibaba/easyexcel
QualityStatistic entity for quality inspection statistics
Provides comprehensive quality inspection statistics and analysis data
Database Table: bytedesk_service_quality_statistic
Purpose: Stores quality inspection statistics, scores, and analysis results
https://github.com/alibaba/easyexcel
QualityStatistic response for quality inspection statistics
Provides comprehensive quality inspection statistics and analysis data
Quality Statistic Summary for aggregated statistics
质检统计摘要类
任务调度通用常量
1天-运行一次，凌晨0点
1天-运行一次，每天8点
Quartz job entity for scheduled task management
Manages cron jobs, scheduled tasks, and job execution configurations
Database Table: bytedesk_core_quartz
Purpose: Stores job definitions, trigger configurations, and execution schedules
5 min job
5分钟定时任务
半小时-运行一次
1小时-运行一次，0分
1 min job
https://cloud.tencent.com/developer/article/1923722
队列实体类：
三个维度：
1.
队列成员消息消费者
用于处理队列成员更新消息
队列成员消息
用于在消息队列中传递队列成员更新信息
队列成员消息服务
用于发送队列成员更新消息到消息队列
队列统计信息
队列状态枚举
快捷回复-全文检索
快捷回复-全文检索结果
快捷回复-全文检索服务
常用语-快捷回复
快捷回复索引消费者
快捷回复索引消息
用于在Artemis队列中传递需要索引的快捷回复信息
快捷回复消息服务
使用核心模块中的JmsTemplate发送快捷回复索引请求
快捷回复-向量检索
快捷回复-向量检索结果
快捷回复-向量检索服务
引用消息内容类
类似微信的引用消息功能，包含被引用消息的信息和当前消息的内容
RAGFlow Chat Controller
https://ragflow.io/docs/dev/http_api_reference
RAGFlow 聊天请求数据结构
RAGFlow 简单消息请求数据结构
RAGFlow Chat Service - 基于 RAGFlow API 的对话服务
https://ragflow.io/docs/dev/http_api_reference
RAGFlow 配置属性
RAGFlow 功能测试工具
https://github.com/alibaba/easyexcel
充值记录
cache config
https://docs.spring.io/spring-boot/reference/io/caching.html
https://docs.spring.io/spring-data/redis/reference/redis/redis-cache.html
https://docs.spring.io/spring-framework/reference/integration/cache/annotations.html#cache-spel-context
https://docs.spring.io/spring-boot/docs/3.2.0/reference/htmlsingle/#io.caching
https://www.51cto.com/article/753777.html
登录重试次数限制和账户锁定的Redis服务
专门处理用户登录失败重试、账户锁定等安全相关功能
登录重试统计信息
微信客服缓存
appid 添加、取消订阅，保存当前订阅，方便推送
appid 添加、取消订阅，保存当前订阅，方便推送
微信客服缓存
If tail catches the cursor it means that the ring buffer is full, any more buffer put request will be rejected.
If cursor catches the tail it means that the ring buffer is empty, any more buffer take request will be rejected.
Relation entity for social relationships and content categorization
Provides comprehensive relation functionality for various system entities
Reference: Xiaohongshu (Little Red Book) social platform design
Database Table: bytedesk_core_relation
Purpose: Stores relation definitions, social interactions, and organization settings
https://github.com/alibaba/easyexcel
关系状态枚举
定义社交关系的各种状态
关系类型枚举
参考小红书等社交平台的关系设计
社交关系工具类
提供社交关系相关的工具方法
Voice of Customer reply entity for feedback response management
Manages replies to user feedback and internal communication
Database Table: bytedesk_voc_reply
Purpose: Stores feedback replies, threaded conversations, and internal notes
https://github.com/alibaba/easyexcel
离职成员客户管理控制器
离职成员客户管理服务
Generic retry callback interface for database operations
启用Spring Retry重试机制的配置类
Represents a ring buffer based on array.<br>
Using array could improve read element performance due to the CUP cache line.
机器人代理请求参数
智能工单填写、智能小结、智能质检
AI robot entity for automated customer service
Supports different service types: agent (human-only), robot (AI-only), workgroup (hybrid)
Database Table: bytedesk_ai_robot
Purpose: Stores AI robot configurations, LLM settings, and service parameters
FAQ数据转换工具类，用于解析生成FAQ的结果并转换为FaqRequest对象
机器人：问答消息
用于AI生成问答对格式化输出
同步thread中客服会话，包括uid。
机器人线程路由策略
角色类型常量
https://github.com/alibaba/easyexcel
Screen entity for content categorization and organization
Provides screen functionality for various system entities
Database Table: bytedesk_service_screen
Purpose: Stores screen definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
Server entity for monitoring server resources and status
Provides server monitoring functionality for system administration
Database Table: bytedesk_core_server
Purpose: Stores server information, resource usage, and monitoring data
Note: Only super administrators can access server monitoring data
https://github.com/alibaba/easyexcel
Scheduled task for cleaning up old server metrics data
Helps manage database storage by removing outdated metrics records
Server metrics entity for recording historical server resource usage
Provides time-series data for server monitoring and trend analysis
Database Table: bytedesk_core_server_metrics
Purpose: Stores historical server metrics data for trend analysis
Note: Only super administrators can access server monitoring data
Repository for ServerMetricsEntity
Provides database operations for server metrics historical data
Note: Only super administrators can access server monitoring data
Server metrics request DTO
Used for server metrics operations
Server metrics response DTO
Used for server metrics operations
REST controller for server metrics operations
Provides APIs for server metrics CRUD operations and historical data queries
Repository for ServerEntity
Provides database operations for server monitoring data
Note: Only super administrators can access server monitoring data
Server request DTO
Used for server monitoring operations
Server response DTO
Used for server monitoring operations
REST service for server monitoring operations
Provides CRUD operations and business logic for server management
Server statistics data class
Server status enumeration
Defines different statuses of servers
Server type enumeration
Defines different types of servers in the system
https://github.com/alibaba/easyexcel
客服对话统计数据：
组织、工作组、客服、机器人
时间维度：小时、日期、月
渠道维度：channel区分渠道
可监控机器人的服务关键数据，包含解决率、评价满意度、服务转人工率、未知回答率、有效会话、当前生效知识等关键运营指标。
触发条件配置
示例JSON:
{
"conditions": [
{
"type": "no_response",
"timeout": 300
},
{
"type": "keyword_match",
"keywords": ["价格", "费用"],
"message": "您似乎对价格感兴趣，这里有一些相关信息..."
},
{
"type": "visit_count",
"threshold": 3,
"message": "欢迎您再次访问..."
},
{
"type": "page_stay",
"timeout": 300,
"message": "您似乎在浏览页面，需要帮助吗？"
https://docs.spring.io/spring-session/reference/guides/boot-redis.html
SHA1 class
计算消息签名接口.
SHA1 class
计算公众平台的消息签名接口.
https://github.com/alibaba/easyexcel
Shopping entity for content categorization and organization
Provides shopping functionality for various system entities
Database Table: bytedesk_core_shopping
Purpose: Stores shopping definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
百度智能云配置
https://console.bce.baidu.com/iam/#/iam/apikey/list
https://cloud.baidu.com/doc/WENXINWORKSHOP/s/Fm2vrveyu
百度智能云聊天配置
Baidu接口
Coze AI服务类
使用 Coze OpenAPI SDK 实现聊天功能，继承自BaseSpringAIService
https://www.coze.cn/open/docs/developer_guides
Custom AI 聊天配置
统一的OpenAI兼容服务
支持所有基于OpenAI API兼容的LLM提供商，包括：
- OpenAI
- DeepSeek
- GiteeAI
- Tencent HunYuan
- Baidu Qianfan
- Volcengine
- OpenRouter
- SiliconFlow
- Custom providers
等
阿里云 Dashscope 聊天配置
DashScope接口
阿里云 DashScope 向量嵌入配置
https://java2ai.com/docs/dev/get-started/
阿里云百炼大模型获取api key：https://bailian.console.aliyun.com/?
Deepseek 聊天配置
DeepSeek接口
SpringAI Dify Service - 基于 Dify API 的SpringAI服务实现
继承BaseSpringAIService，提供统一的AI服务接口
Gitee 聊天配置
Gitee接口
SpringAI MaxKB Service - 基于 MaxKB API 的SpringAI服务实现
继承BaseSpringAIService，提供统一的AI服务接口
Minimax 聊天配置
DeepSeek接口
阿里云 DashScope 向量嵌入配置
https://java2ai.com/docs/dev/get-started/
阿里云百炼大模型获取api key：https://bailian.console.aliyun.com/?
SpringAI N8N Service - 基于 N8N API 的SpringAI服务实现
继承BaseSpringAIService，提供统一的AI服务接口
https://ollama.com/
https://www.promptingguide.ai/
Ollama Chat Configuration
Ollama接口
https://ollama.com/
https://docs.spring.io/spring-ai/reference/api/embeddings/ollama-embeddings.html
Ollama Embedding Configuration
OpenAI 聊天配置
Openai接口
OpenRouter 聊天配置
Openrouter接口
Prompt Engineering 提示词工程
AI应用的核心：提示词的好坏直接影响AI的回答质量
Prompt四个核心要点：
1.
RAG知识库问答
https://docs.spring.io/spring-ai/reference/api/retrieval-augmented-generation.html
https://mp.weixin.qq.com/s/ETmbEAE7lNligcM_A_GF8A
https://www.xiaohongshu.com/explore/67b422600000000029008c9f?
SpringAI RAGFlow Service - 基于 RAGFlow API 的SpringAI服务实现
继承BaseSpringAIService，提供统一的AI服务接口
AI服务接口
定义所有AI服务的通用方法
SpringAI服务注册表
用于管理和获取不同AI提供商的服务实例
SiliconFlow 聊天配置
腾讯混元大模型聊天配置
https://console.cloud.tencent.com/hunyuan/start#
https://cloud.tencent.com/document/product/1729/111007
Tencent接口
工具调用
https://docs.spring.io/spring-ai/reference/api/tools.html
大模型工具支持情况
https://docs.spring.io/spring-ai/reference/api/chat/comparison.html
火山引擎聊天配置
Volcengine接口
Deprecated.
使用ZhipuaiChatConfig
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
https://docs.spring.io/spring-ai/reference/api/chat/zhipuai-chat.html
ZhiPuAI Chat Configuration
Deprecated.
使用ZhipuaiController
智谱AI接口
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
https://docs.spring.io/spring-ai/reference/api/chat/zhipuai-chat.html
Spring AI ZhiPuAI聊天服务
Deprecated.
使用ZhipuaiEmbeddingConfig
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
https://docs.spring.io/spring-ai/reference/api/embeddings/zhipuai-embeddings.html
https://open.bigmodel.cn/overview
ZhiPuAI Embedding Configuration
Spring AI ZhiPuAI服务
http://127.0.0.1:9003/swagger-ui/index.html?
StatisticToken entity for content categorization and organization
Provides statistic_token functionality for various system entities
Database Table: bytedesk_core_statistic_token
Purpose: Stores statistic_token definitions, colors, and organization settings
AI Token统计事件监听器
监听AiTokenUsageEvent事件并记录token使用情况
https://github.com/alibaba/easyexcel
Response class for hourly AI token statistics
Represents token usage data organized by hour for a specific date
贴纸消息内容类
indicates when the broker becomes available/unavailable
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-stomp-appplication-context-events
https://docs.spring.io/spring-framework/reference/web/websocket/stomp/enable.html
published shortly after a SessionConnectEvent when the broker has sent a
STOMP CONNECTED frame in response to the CONNECT
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-stomp-appplication-context-events
客户端新连接建立通知
published when a new STOMP CONNECT is received indicating the start of a new
client session.
https://docs.spring.io/spring-framework/reference/web/websocket/stomp/handle-annotations.html
published when a STOMP session ends.
published when a new STOMP SUBSCRIBE is received.
published when a new STOMP UNSUBSCRIBE is received.
Swagger 分组和国际化支持配置
Swagger UI 自定义配置，支持国际化标签和描述
语言切换控制器
系统状态监控控制器
系统状态监控服务
用于在线程间传递敏感词过滤相关的上下文
敏感词
Exception thrown when sensitive words are detected
敏感词过滤
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
敏感词过滤
注意：不能在类上注解@Async，否则会获取不到 HttpServletRequest，attributes为空。
Service for handling sensitive word filtering
Tag entity for content categorization and organization
Provides tagging functionality for various system entities
Database Table: bytedesk_core_tag
Purpose: Stores tag definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
Task entity for Kanban board task management
Represents individual tasks within a Kanban board system
Database Table: bytedesk_plugin_kanban_task
Purpose: Stores task information, status, and organization within Kanban boards
https://github.com/alibaba/easyexcel
TelegramBotService 用于初始化和管理Telegram机器人
使用TelegramEntity中的token作为bot token
Telegram客户端配置
提供TelegramClient实例，用于发送Telegram消息
https://github.com/alibaba/easyexcel
Extra configuration for Telegram
Telegram消息服务，处理发送各种类型消息的功能
腾讯云COS对象存储服务工具类
参考
腾讯云COS上传服务实现
elasticsearch 全文检索服务
文本导出Excel实体类
Text向量索引实体类
用于在Elasticsearch中存储Text的向量表示
文本向量搜索结果实体类
用于表示向量相似度检索的结果
Text向量检索服务
用于处理Text的向量存储和相似度搜索
Handles handshakes and messages
坐席离线处理服务
处理所有坐席离线的情况
- 发送离线通知给访客
- 提供替代联系方式
- 结束会话
客服会话完成服务
处理客服会话结束时的总结和归档功能
- 生成会话总结
- 记录会话统计数据
- 归档会话记录
Conversation thread entity for managing chat sessions
Represents a series of related messages arranged chronologically to form a coherent communication thread
Used for online forums, email threads, social media, and customer service conversations
Database Table: bytedesk_core_thread
Purpose: Stores conversation threads, participant information, and message history
Note: Each visitor to agent thread should be unique, with history records stored in thread_log table
客服会话流程执行监听器
监听客服会话流程的执行事件：
- 会话开始
- 会话结束
- 流程节点流转
人工接待访客超时服务
处理访客在人工接待过程中长时间未发送消息的情况
- 记录超时信息
- 发送超时提醒
- 结束会话
人工客服服务
处理客服会话中的人工服务阶段
- 记录服务开始和结束时间
- 监控服务质量和SLA
- 处理人工服务过程中的事件
记录邀请记录：
客服邀请客服
客服邀请访客
客服会话邀请协助服务
处理客服会话中的邀请第三方协助功能
- 记录邀请信息
- 发送邀请给其他坐席
- 处理协助过程
消息事件监听器
当新消息创建时，检查是否需要触发转人工请求
Protobuf type
ThreadProtobuf type
Thread排队等待服务
处理客服会话中的排队机制
- 将访客加入队列
- 计算和更新排队位置
- 判断何时可以分配给客服
满意度双向评价机制之：访客评价客服
会话满意度评价
for agent client
会话管理接口
机器人接待访客超时服务
处理访客在机器人接待过程中长时间未发送消息的情况
- 记录超时信息
- 发送超时提醒
- 结束会话
机器人接待服务
纯机器人类型（THREAD_TYPE_ROBOT）不支持转人工
工作组类型（THREAD_TYPE_WORKGROUP）支持机器人和转人工功能
一对一客服类型（THREAD_TYPE_AGENT）仅支持人工，不应该执行机器人服务
处理客服会话中的机器人自动应答环节
- 接收访客消息
- 调用AI模块进行回复
- 判断是否需要转人工服务
- 仅当访客手动触发时才转人工
线程路由策略相关常量
错误消息常量
默认消息常量
策略Bean名称常量
时间常量
线程路由上下文 - 策略模式实现
客服会话满意度评价服务
处理客服会话结束时的满意度评价功能
- 发送满意度调查
- 收集满意度评价数据
- 处理评价反馈
SLA超时通知服务
处理客服会话中的SLA超时事件
- 记录超时信息
- 通知相关人员
- 处理升级策略
https://github.com/alibaba/easyexcel
客服会话流程任务监听器
监听客服会话任务的生命周期事件：
- 任务创建
- 任务分配
- 任务完成
- 任务删除
记录转接记录：
人工转接人工
机器人转人工
会话转接业务服务类
负责处理会话转接的核心业务逻辑
转接接受上下文
客服会话转接服务
处理客服会话中的转接功能
- 记录转接信息
- 查找合适的转接目标
- 处理转接过程
会话转接超时Redis监听器配置
用于监听Redis key过期事件，自动处理转接超时
会话消息处理服务
处理访客发送的消息，检测是否包含转人工请求
会话类型
Support ticket entity for customer service and issue tracking
Manages customer support requests, assignments, and resolution tracking
Database Table: bytedesk_ticket
Purpose: Stores support tickets, their status, assignments, and resolution history
升级工单
JavaDelegate 用于实现服务任务(Service Task)的业务逻辑，通常用于:
自动化处理
系统集成
外部服务调用
复杂业务规则执行
两种服务任务的区别：
SLA 超时：自动触发，基于时间
工单升级：人工触发，基于状态
用途：实现服务任务的具体业务逻辑
绑定位置：服务任务节点
主要场景：自动化处理、系统集成、规则执行
特点：一次性执行，完成特定业务功能
评估工单优先级
使用 ExecutionListener 处理流程执行和变量相关事件
ExecutionListener (执行监听器):
监听流程执行事件
事件类型：start、end、take
可以绑定到流程、活动、连线上
关注流程执行的生命周期
可以访问和修改流程变量
适合处理流程级别的业务逻辑
用途：监听流程执行的生命周期事件
绑定位置：流程定义、活动节点、连线
主要场景：流程级别的监控和处理
特点：可以访问和修改流程变量
工单表单管理接口
主要功能：
支持内置表单和外部表单
表单属性类型支持：string、long、enum、date等
支持必填校验
支持表单数据的保存和提交
支持动态获取表单定义
支持表单历史数据查询
使用表单的好处：
规范数据录入
方便数据验证
提供统一的表单处理机制
支持表单数据历史记录
工单用户和组管理
使用场景：
用户管理：
同步业务系统用户到 Flowable
管理用户信息和状态
用户认证和授权
组管理：
同步业务系统组织架构
管理工作组和角色
权限分配
关系管理：
维护用户和组的关系
支持多组织架构
灵活的权限控制
这样就能将业务系统的用户和组织架构与 Flowable 的工作流权限体系完美对接。
Ticket message entity for workflow communication
Manages messages and notifications within ticket workflows
Database Table: bytedesk_ticket_message
Purpose: Stores ticket-related messages and workflow notifications
工单流程
SLA超时通知
两种服务任务的区别：
SLA 超时：自动触发，基于时间
工单升级：人工触发，基于状态
TaskListener (任务监听器):
监听任务相关事件
事件类型：create、assignment、complete、delete
只能绑定到用户任务上
关注任务的生命周期
可以访问和修改任务相关信息
适合处理任务级别的业务逻辑
用途：监听用户任务的生命周期事件
绑定位置：只能绑定到用户任务
主要场景：任务级别的监控和处理
特点：可以访问和修改任务相关信息
用于支持工单自定义字段
https://github.com/alibaba/easyexcel
https://github.com/alibaba/easyexcel
Todo list entity for Kanban board management
Represents a column or list in a Kanban board for organizing tasks
Database Table: bytedesk_plugin_kanban_todo_list
Purpose: Stores todo list configurations, task organization, and board structure
https://github.com/alibaba/easyexcel
可用于强制用户重新登录，或者刷新token
access_token or refresh_token
授权验证token时，不只是使用jwt解码验证，还需要跟数据库中进行对比，如果token被禁用或者过期，则拒绝访问
存储第三方access_token，refresh_token，过期时间等，微信，qq等第三方授权登录
简化的工具调用请求类
用于替代 Spring AI MCP 中缺失的 ToolCallRequest
简化的工具调用响应类
用于替代 Spring AI MCP 中缺失的 ToolCallResponse
主题管理接口
Trace entity for content categorization and organization
Provides trace functionality for various system entities
Database Table: bytedesk_core_trace
Purpose: Stores trace definitions, colors, and organization settings
https://github.com/alibaba/easyexcel
日志链路跟踪
https://developer.aliyun.com/article/1581355?
分配在职成员的客户请求
分配离职成员的客户请求
分配在职成员的客户响应
分配离职成员的客户响应
分配在职成员的客户群请求
分配离职成员的客户群请求
分配在职成员的客户群响应
分配离职成员的客户群响应
转人工关键词
https://github.com/alibaba/easyexcel
转人工关键词检测工具类
查询客户接替状态请求
查询客户接替状态请求
查询客户接替状态响应
查询客户接替状态响应
翻译记录
翻译接口
https://fanyi-api.baidu.com/doc/21
https://github.com/wujun234/uid-generator-spring-boot-starter
UID 的自动配置
UidGenerateException
Entity for M_WORKER_NODE
https://github.com/wujun234/uid-generator-spring-boot-starter
Represents a unique id generator.
DAO for M_WORKER_NODE
UID 的配置
https://github.com/wujun234/uid-generator-spring-boot-starter/blob/master/README.md
UidGenerator接口提供了 UID 生成和解析的方法，提供了两种实现:
获取待分配的离职成员列表请求
获取待分配的离职成员列表响应
统一客服入口策略器
File upload entity for managing uploaded files and documents
Handles file metadata, storage information, and upload tracking
Database Table: bytedesk_core_upload
Purpose: Stores file upload records, metadata, and access information
MinIO 文件存储控制器
提供 MinIO 文件上传、下载、删除等 API 接口
MinIO 对象存储服务
用于将图片、音频、视频等文件存储到 MinIO
file upload - 文件上传, https://spring.io/guides/gs/uploading-files
文件上传接口，可匿名访问
文件上传安全配置
文件上传安全日志记录器
上传水印服务
负责处理文件上传时的水印添加逻辑
短链控制器
联系客户统计数据请求模型
联系客户统计数据响应模型
行为数据详情
https://wankhedeshubham.medium.com/spring-boot-security-with-userdetailsservice-and-custom-authentication-provider-3df3a188993f
Exception caused by disabled user.
User entity for system authentication and authorization
Manages user accounts, roles, and organizational relationships
Database Table: bytedesk_core_user
Purpose: Stores user information, authentication details, and role assignments
SmartInitializingSingleton：适用于需要确保在 ApplicationContext 初始化之后再执行的初始化逻辑。
Protobuf type
UserProtobuf type
User所有字段跟user.proto中字段一一对应
https://spring.io/guides/tutorials/react-and-spring-data-rest/
You do NOT want this repository exposed for REST operations!
ValuedEnum defines an enumeration which is bounded to a value, you
may implements this interface when you defines such kind of enumeration, that
you can use EnumUtils to simplify parse and valueOf operation.向量存储配置类
为不同的向量存储服务提供配置
视频消息内容类
filter blocked visitor
visitor no need to login, without login can reduce the press of the database
TODO: 对于平台型app来说，visitor不属于某个org，所有备注信息都应该按照org单独存储，
TODO: 而不是和visitor合并到一起，将备注信息写入到customer表中
访客信息导出Excel实体类
https://github.com/alibaba/easyexcel
分表存储客服消息
同步message中客服消息，包括uid。
TODO: 监听message中客服消息，包括uid。
所有字段跟user.proto中字段一一对应
满意度双向评价机制之：客服评价访客
used for agent client
anonymous api, no need to login
同步thread中客服会话，包括uid。
语音消息内容类
火山引擎API工具类，用于创建适合火山引擎的OpenAiApi实例
水印配置
图片水印服务
水印位置枚举
https://docs.spring.io/spring-ai/reference/api/tools.html#_dynamic_specification_bean
支持消息/客户留资信息秒级同步到企微/lark/飞书/钉钉或者其他CRM系统
https://github.com/alibaba/easyexcel
支持消息/客户留资信息秒级同步到企微/lark/飞书/钉钉或者其他CRM系统-推送记录
https://github.com/alibaba/easyexcel
Webhook消息推送记录仓库
Webhook消息推送记录服务
Webhook类型枚举
网页内容抓取服务
负责从网页URL抓取内容并更新WebpageEntity的content字段
网页全文搜索实体类
用于在Elasticsearch中存储网页文档
网页全文搜索结果类
用于存储和传输搜索结果
Elasticsearch 全文检索服务（网页搜索）
网站导出Excel实体类
网页索引消费者
用于处理网页索引队列中的消息，使用Artemis JMS
网页索引消息
用于在Artemis队列中传递需要索引的网页信息
网页消息服务
使用Artemis JMS将网页索引操作发送到消息队列进行异步处理
网页向量索引实体类
用于在Elasticsearch中存储网页的向量表示
网页向量搜索结果实体类
用于表示向量相似度检索的结果
网页向量检索服务
用于处理网页的向量存储和相似度搜索
WebRTC信令控制器
https://github.com/pengjinning/spring-boot-3-jwt-security
https://github.com/pengjinning/spring-boot-spring-security-jwt-authentication
https://dev.to/jean_claude_van_debug/spring-security-mutliple-authentication-providers-new-spring-boot-3-e1j
网站导出Excel实体类
https://docs.spring.io/spring/docs/current/spring-framework-reference/web.html#websocket-server
微信客服
企业微信-客服账号请求
企业微信-客服账号响应
微信客服接口
企业微信-客服账号服务
WeChat application entity for managing WeChat integration
Handles WeChat Official Account, Mini Program, and Work application configurations
Database Table: bytedesk_channel_wechat_app
Purpose: Stores WeChat app credentials, access tokens, and integration settings
https://github.com/alibaba/easyexcel
微信公众号
客服消息：https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7
小程序-微信访客
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
公众号-客服账号
微信公众号
客服消息：https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7
公众号-标签
微信访客
公众号：直接通过提供URL对接公众号
测试号：https://mp.weixin.qq.com/debug/cgi-bin/sandboxinfo?
对接微信开放平台，授权方式对接, https://open.weixin.qq.com/, 第三方平台
萝卜丝web-配置（萝卜丝公众号）
WeChat payment entity for managing WeChat Pay integration
Handles WeChat Pay configurations and payment processing settings
Database Table: bytedesk_channel_wechat_pay
Purpose: Stores WeChat Pay configurations and payment-related settings
通用响应类，用于简单的成功/失败响应
企业微信常量
事件类型常量
消息类型常量
会话状态变更类型
会话状态
企业微信客户联系相关常量
企业微信-客户联系功能请求
企业微信-客户联系功能响应
企业微信-客户联系功能接口
企业微信-客户联系功能服务
文档地址: https://developer.work.weixin.qq.com/document/path/92113
企业微信外部联系人信息
参考文档：https://developer.work.weixin.qq.com/document/path/92113
企业微信统一额外信息存储类
合并了WeChatWorkVisitorExtra和WeChatWorkThreadExtra的所有字段
用于解析VisitorRequest.extra和Thread.extra字段中的信息
企业微信-客户群管理员
企业微信-客户群信息
企业微信-客户群API常量
企业微信-客户群邀请者
企业微信-客户群成员
企业微信-客户群请求类
企业微信-客户群响应类
客户群列表项
企业微信-客户群API接口
企业微信-客户群服务接口
企业微信-客户群服务实现
最后更新：2025/01/13
企业微信-客服账号响应
企业微信-客服接待人员列表项
企业微信-客服账号请求
企业微信-客服接待人员响应
企业微信-客服接待人员操作结果项
企业微信-客服账号服务
企业微信客服消息服务实现类
https://developer.work.weixin.qq.com/document/path/94670
企业微信客服消息控制器
同步消息请求
企业微信客服消息读取响应
名片消息
日程消息
目前企业微信暂不返回详细消息内容
视频号消息
视频号订单消息
视频号商品消息
事件消息
视频号信息
文件消息
图片消息
链接消息
位置消息
会议消息
目前企业微信暂不返回详细消息内容
聊天记录消息
聊天记录消息项
小程序消息
菜单消息
菜单项
点击类型菜单项
小程序类型菜单项
链接类型菜单项
笔记消息
目前企业微信暂不返回详细消息内容
文本消息
视频消息
语音消息
消息基础类
企业微信客服会话管理服务
https://developer.work.weixin.qq.com/document/path/94669
企业微信客服会话请求类
企业微信客服会话响应类
企业微信客服会话管理REST控制器
企业微信客服会话状态枚举
企业微信敏感词管理控制器
提供敏感词规则的增删改查API
企业微信敏感词管理服务
企业与第三方应用可通过该服务管理聊天敏感词
企业微信标签组
企业微信标签项
企业微信标签请求类
企业微信标签响应类
企业微信-标签服务接口
企业微信-标签服务实现
企业微信模板卡片构建器
用于构建文本通知和图文展示模板卡片
企业微信Token服务
企业微信附件上传控制器
企业微信附件上传响应
企业微信附件上传服务实现
企业微信群机器人客户端
文档: https://developer.work.weixin.qq.com/document/path/91770
企业微信统计数据服务接口
企业微信统计数据服务实现类
https://github.com/alibaba/easyexcel
WhatsApp统一额外信息存储类
用于解析 VisitorRequest.extra 和 ThreadEntity.extra 字段中的信息，特别是当 client/channel 为 WHATSAPP 时
合并了原来的 WhatsAppVisitorExtra 和 WhatsAppThreadExtra 的功能
ngrok http 9003，生成url
https://051e47dbc9f3.ngrok-free.app/whatsapp/webhooks/1690459642527872
Represents a worker id assigner for
DefaultUidGeneratorWorkerNodeType
CONTAINER: Such as Docker
ACTUAL: Actual machine
节点数据基类
参考 WorkflowNodeJSON 接口定义
节点数据类
用于存储节点的表单数据、输入输出配置等
条件项
条件值
边数据基类
参考 WorkflowEdgeJSON 接口定义
边数据类
工作流
工作流使用示例
https://github.com/alibaba/easyexcel
工作流节点工厂类
用于根据节点类型创建相应的节点实例
节点元数据类
参考 FlowNodeMeta 和 WorkflowNodeMeta 接口定义
用于存储节点的位置信息、渲染配置等元数据
内边距信息类
位置信息类
尺寸信息类
工作流节点状态枚举
工作流节点类型枚举
https://github.com/alibaba/easyexcel
工作流文档类
对应JSON中的FlowDocumentJSON结构
工作流状态枚举
工作流线程路由策略
工作流类型枚举
根据业内实践分类
各分类的典型应用场景
CHATBOT: 电商客服机器人、智能助手、FAQ自动回复
SALES: CRM系统、销售线索管理、客户关系维护
MARKETING: 自动化营销、用户触达、转化率优化
ONBOARDING: SaaS产品用户引导、新员工培训
SUPPORT: IT支持、产品技术支持、故障处理
APPROVAL: 企业OA系统、流程审批、权限管理
INTEGRATION: 企业系统集成、数据中台、API管理
ANALYTICS: 商业智能、用户行为分析、决策支持
WORKFLOW: 一般工作流
工作流工具类
工作流变量控制器
工作流变量实体
用于存储工作流执行过程中的变量
工作流变量仓库接口
工作流变量请求DTO
工作流变量响应DTO
工作流变量作用域枚举
工作流变量服务
工作流变量类型枚举
监听客服状态变更事件，清除相关工作组缓存
工作组缓存管理工具类
提供清除和刷新工作组缓存的功能
Workgroup entity for customer service team management
Manages workgroups that support both robot and human agent services
Database Table: bytedesk_service_workgroup
Purpose: Stores workgroup configurations, agent assignments, and service settings
Key differences:
- WorkgroupEntity vs Skills: Organizational structure vs capability labels
- WorkgroupEntity vs Agent: Group support (robot + human) vs individual agent only
- WorkgroupEntity vs Robot: Group with routing vs standalone robot
分表存储技能组客服消息
同步message中客服消息，包括uid。
每种算法都有其适用场景：
轮询：客服能力相近
最小活动数：负载敏感
随机：简单场景
加权随机：重视服务质量
一致性哈希：需要服务连续性
最快响应：重视响应速度
工作组路由服务
根据工作组路由模式选择客服
工作组线程路由策略
https://github.com/alibaba/easyexcel
提供接收和推送给企业微信消息的加解密接口(UTF8编码的字符串).
提供接收和推送给公众平台消息的加解密接口(UTF8编码的字符串).
常量
交易保障
2018/7/3
XMLParse class
提供提取消息格式中的密文及生成回复消息格式的接口.
YCloud 消息基础类
WhatsApp Webhook服务
https://docs.ycloud.com/reference/whatsapp_message-send-directly
WhatsApp消息详情响应（用于获取消息详情）
WhatsApp消息响应
YCloud 消息类型枚举
SMS 入站消息事件
当收到SMS入站消息时触发，即用户回复您的消息
SMS 入站消息
SMS 消息状态更新事件
当SMS消息状态更新时触发，状态变为已送达或未送达
SMS 消息
语音消息状态更新事件
当语音消息状态更新时触发，状态变为已送达或未送达
语音消息
WhatsApp 业务账号删除事件
当WhatsApp Business Account被删除时触发
WhatsApp 业务账号信息
WhatsApp 业务账号更新事件
当发生政策违规、WhatsApp Business Account被禁等情况时触发
限制信息
WhatsApp 业务账号信息
WhatsApp入站消息事件
当接收到WhatsApp入站消息时触发
客户个人资料
WhatsApp入站消息
WhatsApp 消息类型
消息类型：音频消息
消息类型：按钮消息
消息类型：联系人消息
联系人信息
联系人姓名
联系人电话
对话信息
客户资料
消息类型：文档消息
消息类型：图片消息
交互式按钮回复
交互式列表回复
消息类型：交互式消息
消息类型：位置消息
媒体元数据
消息上下文
消息类型：订单消息
订单产品项
消息类型：反应消息
引用信息
引用产品
消息类型：贴纸消息
消息类型：系统消息
模板组件
模板语言
消息类型：模板消息
模板参数
模板参数中的文档
模板参数中的图片
消息类型：文本消息
消息类型：视频消息
Webhook 事件
WhatsApp 入站消息
WhatsApp 出站消息
WhatsApp消息状态更新事件
当WhatsApp外发消息状态更新时触发，状态可能变为失败、已发送、已送达或已读
会话信息
WhatsApp消息
https://github.com/alibaba/easyexcel
智谱AI聊天配置类
使用 oapi-java-sdk 的 ClientV4
统一使用 spring.ai.zhipuai 配置
https://github.com/MetaGLM/zhipuai-sdk-java-v4
智谱AI接口 - 使用 oapi-java-sdk
https://open.bigmodel.cn/dev/api#sdk_install
https://github.com/MetaGLM/zhipuai-sdk-java-v4
智谱AI服务类
使用 oapi-java-sdk 实现聊天功能，继承自BaseSpringAIService
https://github.com/MetaGLM/zhipuai-sdk-java-v4
ZonedDateTime类型的Excel转换器
用于处理ZonedDateTime类型的字段导出到Excel时的转换