auth
认证与登 录
📄️ Introduction
Bytedesk（微语）系统 API 文档，基于 AccessToken 免登与 Bearer Token 鉴权。
📄️ auth
auth
📄️ 取消工单
取消工单
📄️ 修改邮箱
修改邮箱
📄️ 修改手机号
修改手机号
📄️ 用户修改密码
当前用户使用旧密码修改新密码。
📄️ 认领工单
认领工单
📄️ 关闭会话
关闭会话
📄️ 关闭工单
关闭工单
📄️ 扫码确认登录
扫码确认登录
📄️ 创 建会话
创建会话
📄️ 新建工单
覆盖 BaseRestController.create
📄️ 创建用户
创建用户
📄️ 删除消息
删除消息
📄️ 删除会话
删除会话
📄️ 删除工单
覆盖 BaseRestController.delete
📄️ 删除用户
删除用户
📄️ 升级工单
升级工单
📄️ 获取当前用户信息
通过 Bearer Token 获取当前登录用户信息。
📄️ 获取消息详情
获取消息详情
📄️ 获取扫码登录二维码
获取扫码登录二维码
📄️ 轮询扫码状态
轮询扫码状态
📄️ 获取会话详情
获取会话详情
📄️ 根据UID查询工单详情
覆盖 BaseRestController.queryByUid
📄️ 获取用户信息
获取用户信息
📄️ 挂起工单
挂起工单
📄️ 查询会话列表
查询会话列表
📄️ 查询用户列表
查询用户列表
📄️ 使用 AccessToken 登录（管理后台）
使用 AccessToken 免登管理后台，通常返回 302 跳转。
📄️ 使用 AccessToken 登录
通过 accessToken 免登，返回访问令牌与用户信息。
📄️ 邮箱验证码登录
使用邮箱 + 验证码登录。
📄️ 手机号验证码登录
使用手机号 + 短信验证码登录。
📄️ 用户名密码登录
使用用户名与密码登录，返回访问令牌与用户信息。
📄️ 标记消息为已读（迁移到企业版）
已迁移到企业版，请使用 /api/v1/vip/message/{messageUid}/read
📄️ 批量标记会话消息为已读（迁移到企业版）
已迁移到企业版，请使 用 /api/v1/vip/message/thread/{threadUid}/read
📄️ messages
messages
📄️ 待回应工单
待回应工单
📄️ 根据主题查询消息
根据主题查询相关消息
📄️ 根据会话UID查询消息
通过会话唯一标识符查询相关消息
📄️ 查询邀请会话
查询邀请相关的会话
📄️ 根据主题和用户查询会话
通过主题和用户查找相关会话
📄️ 根据主题查询会话
通过主题查找相关会话
📄️ 根据用户UID查询所有会话
通过 userUid 查询用户相关的所有会话
📄️ 查询工单活动历史
查询工单活动历史
📄️ 查询工单流程实例历史
查询工单流程实例历史
📄️ 查询工单任务历史
查询工单任务历史
📄️ 按组织查询工单
覆盖 BaseRestController.queryByOrg
📄️ 根据会话UID查询工单
根据会话UID查询工单
📄️ 根据主题查询工单
根据主题查询工单
📄️ 按用户查询工单
覆盖 BaseRestController.queryByUser
📄️ 查询未读消息（迁移到企业版）
已迁移到企业版，请使用 /api/v1/vip/message/unread
📄️ 刷新 Bearer Token
使用有效的刷新令牌获取新的访问令牌。
📄️ 用户注册
通过短信/邮箱验证码完成注册，返回用户信息。
📄️ 重新打开工单
重新打开工单
📄️ 完成工单
完成工单
📄️ 恢复工单
恢复工单
🗃️ schemas
33 个项目
📄️ 发送邮箱验证码
发送登录或验证用邮箱验证码。
📄️ 发送消息
发送消息
📄️ 发送短信验证码
发送登录或验证用短信验证码。
📄️ 发送离线消息（REST）
当客户端长连接断开时，通过 REST 接口发送 JSON 格式消息
📄️ 开始处理工单
开始处理工单
📄️ threads
threads
📄️ tickets
tickets
📄️ 转派工单
转派工单
📄️ 退回工单
退回工单
📄️ 更新会话折叠状态
更新会话折叠状态
📄️ 更新会话隐藏状态
更新会话隐藏状态
📄️ 更新会话静音状态
更新会话静音状态
📄️ 更新会话备注
更新会话备注
📄️ 更新会话标星状态
更新会话标星状态
📄️ 更新会话标签列表
更新会话标签列表
📄️ 更新会话置顶状态
设置或取消会话置顶
📄️ 更新会话未读状态
标记会话为已读或未读
📄️ 更新会话用户信息
更新会话用户信息
📄️ 更新会话
更新会话
📄️ 更新工单
覆盖 BaseRestController.update
📄️ 更新用户
更新用户
📄️ 用户登出
用户登出
📄️ users
users
📄️ 客户验证工单
客户验证工单