# lwc-cloud-erp-message API 接口文档

- 文档标题：product-message
- 版本：2.0.0
- 描述：LWC Cloud API接口文档
- 数据来源：https://api.leadwaycloud.com/lwc-cloud-erp-message/v3/api-docs
- 生成时间：2026-08-03T22:00:09.977Z
- 接口数量：210
- 分组数量：49
- 模型数量：217

## 服务地址

| 地址 | 说明 |
| --- | --- |
| http://localhost:8080 | 开发环境 |
| https://api.leadwaycloud.com | 测试环境 |

## 接口目录

### OA印章使用记录命令

- [PUT /api/signet/updateUseRecord/{id} - 修改使用记录](#put-api-signet-updateuserecord-id-updateuserecord)
- [PUT /api/signet/registeUseRecord/{id}/{fileId}/{signetId} - 用印登记](#put-api-signet-registeuserecord-id-fileid-signetid-registeuserecord)
- [PUT /api/signet/deleteUseRecord/{id} - 删除使用记录](#put-api-signet-deleteuserecord-id-deleteuserecord)
- [POST /api/signet/addUseRecord - 添加使用记录](#post-api-signet-adduserecord-adduserecord)

### OA印章制作记录命令

- [PUT /api/signet/updateMakeRecord/{id} - 修改制作记录](#put-api-signet-updatemakerecord-id-updatemakerecord)
- [PUT /api/signet/deleteMakeRecord/{id} - 删除制作记录](#put-api-signet-deletemakerecord-id-deletemakerecord)
- [POST /api/signet/addMakeRecord - 添加制作记录](#post-api-signet-addmakerecord-addmakerecord)

### OA印章外借记录命令

- [PUT /api/signet/updateLendOutRecord/{id} - 修改外借记录](#put-api-signet-updatelendoutrecord-id-updatelendoutrecord)
- [PUT /api/signet/deleteLendOutRecord/{id} - 删除外借记录](#put-api-signet-deletelendoutrecord-id-deletelendoutrecord)
- [POST /api/signet/addLendOutRecord - 添加外借记录](#post-api-signet-addlendoutrecord-addlendoutrecord)

### OA印章分类命令

- [PUT /api/signet/updateCategory/{id} - 修改印章分类](#put-api-signet-updatecategory-id-updatecategory)
- [PUT /api/signet/deleteCategory/{id} - 删除印章分类](#put-api-signet-deletecategory-id-deletecategory)
- [POST /api/signet/addCategory - 添加印章分类](#post-api-signet-addcategory-addcategory)

### OA印章命令

- [PUT /api/signet/update/{id} - 修改印章](#put-api-signet-update-id-update)
- [PUT /api/signet/lose/{id} - 印章丢失](#put-api-signet-lose-id-lose)
- [PUT /api/signet/enable/{id} - 印章启用](#put-api-signet-enable-id-enable)
- [POST /api/workflow/callback - 任务回调](#post-api-workflow-callback-callback)
- [POST /api/signet/add - 添加印章](#post-api-signet-add-add)

### 通知命令

- [PUT /api/message/update/status/to-read/{id} - 变更通知状态已读接口](#put-api-message-update-status-to-read-id-update-1)
- [PUT /api/message/update/status/to-read/client-key/{clientKey} - 批量变更客户端通知已读接口](#put-api-message-update-status-to-read-client-key-clientkey-update-2)
- [DELETE /api/message/remove/{id} - 删除通知接口](#delete-api-message-remove-id-remove)
- [DELETE /api/message/remove/client-key/{clientKey} - 批量删除客户端通知接口](#delete-api-message-remove-client-key-clientkey-removebyclientkey)

### 通知模版命令

- [PUT /api/message/template/{id} - 编辑站内信模版接口](#put-api-message-template-id-msgtemplateupdate)
- [PUT /api/email/template/update/{id} - 编辑邮件模版接口](#put-api-email-template-update-id-updateemailtemplate)
- [POST /api/message/query/template - 创建站内信模版接口](#post-api-message-query-template-createinsidetemplate)
- [POST /api/email/template/add - 添加邮件模版接口](#post-api-email-template-add-add-1)
- [DELETE /api/email/template/delete/{id} - 删除邮件模版接口](#delete-api-email-template-delete-id-deletemsgtemplate)

### 通知服务器命令

- [PUT /api/message/server/{id} - 修改通知服务器配置](#put-api-message-server-id-msgserverupdate)
- [POST /api/message/query/server - 创建通知服务器配置](#post-api-message-query-server-msgservercreate)

### IM会议命令

- [PUT /api/meeting/update/meeting-room/{id} - 修改会议室接口](#put-api-meeting-update-meeting-room-id-updatemeetingroom)
- [PUT /api/meeting/update/meeting-room/status/{id}/{newStatus} - 修改会议室状态接口](#put-api-meeting-update-meeting-room-status-id-newstatus-updatemeetingroomstatus)
- [PUT /api/meeting/update/meeting-room-apply/{id} - 修改会议室申请接口](#put-api-meeting-update-meeting-room-apply-id-updatemeetingroomapply)
- [PUT /api/meeting/update/meeting-attachment/{id} - 更新会议附件接口](#put-api-meeting-update-meeting-attachment-id-updatemeetingattachment)
- [PUT /api/meeting/cancel/meeting-room-apply/{id} - 取消会议室申请接口](#put-api-meeting-cancel-meeting-room-apply-id-cancelmeetingroomapply)
- [POST /api/meeting/verify/meeting-room-apply/{id} - 会议室申请审核接口](#post-api-meeting-verify-meeting-room-apply-id-verifymeetingroomapply)
- [POST /api/meeting/notice-join-meeting-user/{id} - 通知会议参与人员接口](#post-api-meeting-notice-join-meeting-user-id-noticejoinmeetinguser)
- [POST /api/meeting/join-meeting-confirm/{id} - 会议参与确认接口](#post-api-meeting-join-meeting-confirm-id-joinmeetingconfirm)
- [POST /api/meeting/apply/meeting-room - 申请会议室接口](#post-api-meeting-apply-meeting-room-applymeetingroom)
- [POST /api/meeting/add/meeting-room - 创建会议室接口](#post-api-meeting-add-meeting-room-createmeetingroom)

### IM消息命令

- [PUT /api/im/message/sort/useful-expression - 常用语排序接口](#put-api-im-message-sort-useful-expression-sortusefulexpression)
- [PUT /api/im/message/revoke/{id} - 消息撤回接口](#put-api-im-message-revoke-id-revokemessage)
- [PUT /api/im/message/rename/collect/tag - 重命名消息收藏标签接口](#put-api-im-message-rename-collect-tag-renamecollectmessagetag)
- [PUT /api/im/message/read-mark - 消息已读标记接口](#put-api-im-message-read-mark-markmessageread)
- [PUT /api/im/message/delete/{id} - 消息删除接口](#put-api-im-message-delete-id-deletemessage)
- [PUT /api/im/message/delete/collect/tag - 删除消息收藏标签接口](#put-api-im-message-delete-collect-tag-deletecollectmessagetag)
- [PUT /api/im/message/delete/batch - 消息批量删除接口](#put-api-im-message-delete-batch-deletemessage-1)
- [POST /api/im/message/collect - 消息收藏接口](#post-api-im-message-collect-collectmessage)
- [POST /api/im/message/api/message/send-im-template-msg - 发送模版消息接口](#post-api-im-message-api-message-send-im-template-msg-sendimmessage-1)
- [POST /api/im/message/api/message/send-im-point-msg - 发送点对点消息接口](#post-api-im-message-api-message-send-im-point-msg-sendimmessage-2)
- [POST /api/im/message/api/message/send-im-group-msg - 发送群组消息接口](#post-api-im-message-api-message-send-im-group-msg-sendimmessage-3)
- [POST /api/im/message/api/message/send-im-forward-msg - 发送转发消息接口](#post-api-im-message-api-message-send-im-forward-msg-sendimmessage-4)
- [POST /api/im/message/add/useful-expression - 添加常用语接口](#post-api-im-message-add-useful-expression-addusefulexpression)
- [POST /api/im/message/add/collect/tag - 添加消息收藏标签接口](#post-api-im-message-add-collect-tag-addcollectmessagetag)
- [DELETE /api/im/message/delete/useful-expression/{id} - 删除常用语接口](#delete-api-im-message-delete-useful-expression-id-deleteusefulexpression-1)
- [DELETE /api/im/message/delete/collect/{id} - 消息取消收藏接口](#delete-api-im-message-delete-collect-id-cancelcollectmessage)

### IM消息群组命令

- [PUT /api/im/group/update/{id} - 修改群组接口](#put-api-im-group-update-id-updategroup)
- [PUT /api/im/group/update/manager/{id} - 更新群组管理员接口](#put-api-im-group-update-manager-id-updategroupmanager)
- [PUT /api/im/group/dismiss/{id} - 解散群组接口](#put-api-im-group-dismiss-id-dismissgroup)
- [POST /api/im/group/add - 添加群组接口](#post-api-im-group-add-addgroup)
- [POST /api/im/group/add/member/{id} - 添加群组成员接口](#post-api-im-group-add-member-id-addgroupmember)
- [DELETE /api/im/group/exit/{id} - 退出群组接口](#delete-api-im-group-exit-id-exitgroup)
- [DELETE /api/im/group/delete/member/{id} - 删除群组成员接口](#delete-api-im-group-delete-member-id-deletegroupmember)

### IM邮件命令

- [PUT /api/im/email/rename/collect/tag - 重命名邮件收藏标签接口](#put-api-im-email-rename-collect-tag-renamecollectemailtag)
- [PUT /api/im/email/read-mark/{id} - 标记邮件已读接口](#put-api-im-email-read-mark-id-emailreadmark)
- [PUT /api/im/email/delete/{id} - 删除邮件接口](#put-api-im-email-delete-id-deleteemail)
- [PUT /api/im/email/delete/collect/tag - 删除邮件收藏标签接口](#put-api-im-email-delete-collect-tag-deletecollectemailtag)
- [PUT /api/im/email/delete/batch - 批量删除邮件接口](#put-api-im-email-delete-batch-deleteemail-1)
- [PUT /api/im/email/cancel-delete/{id} - 取消邮件删除接口](#put-api-im-email-cancel-delete-id-canceldeleteemail)
- [PUT /api/im/email/cancel-delete/batch - 批量取消邮件删除接口](#put-api-im-email-cancel-delete-batch-canceldeleteemail-1)
- [POST /api/im/email/send - 发送邮件接口](#post-api-im-email-send-sendimemail)
- [POST /api/im/email/save - 保存邮件接口](#post-api-im-email-save-saveemail)
- [POST /api/im/email/collect - 邮件收藏接口](#post-api-im-email-collect-collectmessage-1)
- [POST /api/im/email/add/collect/tag - 添加邮件收藏标签接口](#post-api-im-email-add-collect-tag-addcollectemailtag)
- [DELETE /api/im/email/delete/collect/{id} - 邮件取消收藏接口](#delete-api-im-email-delete-collect-id-cancelcollectmessage-1)

### IM业务联系单查询

- [PUT /api/im/business/query/print-data/{id} - 查询业务联系单打印数据接口](#put-api-im-business-query-print-data-id-querybusinessprintdata)
- [GET /api/im/business/query - 查询业务联系单接口](#get-api-im-business-query-querybusiness)
- [GET /api/im/business/query/{id} - 查询业务联系单接口](#get-api-im-business-query-id-querybusiness-1)
- [GET /api/im/business/query/un-process-count - 查询当前用户未处理业务联系单数据条数接口](#get-api-im-business-query-un-process-count-querycurrentuserunprocessbusinesscoun)
- [GET /api/im/business/query/detail/{id} - 查询业务联系单详情接口](#get-api-im-business-query-detail-id-querybusinessdetail)

### IM业务联系单命令

- [PUT /api/im/business/delete/{id} - 删除业务联系单接口](#put-api-im-business-delete-id-deletebusiness)
- [PUT /api/im/business/close/{id} - 关闭业务联系单接口](#put-api-im-business-close-id-closebusiness)
- [POST /api/im/business/create - 创建业务联系单接口](#post-api-im-business-create-createbusiness)
- [POST /api/im/business/confirm - 回复业务联系单接口](#post-api-im-business-confirm-confirmbusiness)

### IM公告命令

- [PUT /api/im/bulletin/update/{id} - 修改公告接口](#put-api-im-bulletin-update-id-updatebulletin)
- [PUT /api/im/bulletin/read-mark/{id} - 标记公告已读接口](#put-api-im-bulletin-read-mark-id-emailreadmark-1)
- [POST /api/im/bulletin/publish/{id} - 发布公告接口](#post-api-im-bulletin-publish-id-publishbulletin)
- [POST /api/im/bulletin/create - 创建公告接口](#post-api-im-bulletin-create-createbulletin)
- [DELETE /api/im/bulletin/delete/{id} - 删除公告接口](#delete-api-im-bulletin-delete-id-deletebulletin)

### IM日历日程命令

- [PUT /api/calendar-schedule/update/custom - 修改自定义日历日程接口](#put-api-calendar-schedule-update-custom-updatecustomcalendartask)
- [PUT /api/calendar-schedule/pause/custom - 暂停自定义日历日程接口](#put-api-calendar-schedule-pause-custom-pausecalendarschedule)
- [PUT /api/calendar-schedule/close/system - 关闭系统日历日程接口](#put-api-calendar-schedule-close-system-closesystemcalendarschedule)
- [PUT /api/calendar-schedule/close/system/{id} - 关闭系统日历日程接口(仅用做关闭系统日历日程)](#put-api-calendar-schedule-close-system-id-closesystemcalendarschedule-1)
- [PUT /api/calendar-schedule/cancel/system - 取消系统日历日程接口](#put-api-calendar-schedule-cancel-system-cancelcalendarschedule)
- [POST /api/calendar-schedule/plush/system - 发布系统日历日程接口](#post-api-calendar-schedule-plush-system-publishsystemcalendarschedule)
- [POST /api/calendar-schedule/plush/custom - 发布自定义日历日程接口](#post-api-calendar-schedule-plush-custom-publishcustomcalendarschedule)
- [DELETE /api/calendar-schedule/delete/custom - 删除自定义日历日程接口](#delete-api-calendar-schedule-delete-custom-deletecalendarschedule)

### 后台任务管理

- [PUT /api/backend-task/task/finish - 主任务完成接口](#put-api-backend-task-task-finish-taskfinish)
- [POST /api/backend-task/sub-task/finish - 子任务完成接口](#post-api-backend-task-sub-task-finish-subtaskfinish-1)
- [POST /api/backend-task/publish-workflow-task - 发布任务接口](#post-api-backend-task-publish-workflow-task-publishworkflowtask-1)

### OA印章作废命令

- [POST /api/signet/addVoidRecord - 添加作废记录](#post-api-signet-addvoidrecord-addvoidrecord)

### OA印章接收记录命令

- [POST /api/signet/addGrantReceiveRecord - 添加交接记录](#post-api-signet-addgrantreceiverecord-addgrantreceiverecord)

### 发送站内信通知接口(v1)

- [POST /api/sent-message-websocket/system-notice - 发送系统通知接口](#post-api-sent-message-websocket-system-notice-sendinside)
- [POST /api/sent-message-websocket/system-announcement - 发送系统公告接口](#post-api-sent-message-websocket-system-announcement-sendinside-1)
- [POST /api/sent-message-websocket/function-callback - 发送功能回调接口](#post-api-sent-message-websocket-function-callback-sendinside-2)
- [POST /api/sent-message-websocket/business-notice - 发送业务提醒接口](#post-api-sent-message-websocket-business-notice-sendinside-3)

### 发送短信通知接口(v1)

- [POST /api/sent-message-sms/verification-code - 发送验证码短信消息接口](#post-api-sent-message-sms-verification-code-sendmessage)

### 发送邮件通知接口(V1)

- [POST /api/sent-message-email/verification-code - 发送邮件验证码接口](#post-api-sent-message-email-verification-code-sendmessage-1)
- [POST /api/sent-message-email/merchant-customize - 发送商户自定义邮件接口](#post-api-sent-message-email-merchant-customize-sendmerchantcustomizeemail)
- [POST /api/sent-message-email/merchant-customize-backend - 发送商户自定义邮件接口-后端](#post-api-sent-message-email-merchant-customize-backend-sendmerchantcustomizeemai)

### 普通任务管理

- [POST /api/normal-task/task/handy/finish - 任务快捷完成接口(关闭主任务以及主任务下面的子任务(状态变更&处理人写入))](#post-api-normal-task-task-handy-finish-handytaskfinish)
- [POST /api/normal-task/task/finish - 主任务完成接口(关闭主任务以及主任务下面的子任务(状态变更))](#post-api-normal-task-task-finish-taskfinish-1)
- [POST /api/normal-task/sub-task/reassignment - 子任务改派接口](#post-api-normal-task-sub-task-reassignment-subtaskreassignment)
- [POST /api/normal-task/sub-task/finish - 子任务完成接口(仅关闭该子任务)](#post-api-normal-task-sub-task-finish-subtaskfinish)
- [POST /api/normal-task/publish-task - 发布任务接口](#post-api-normal-task-publish-task-publishworkflowtask)

### 发送短信通知接口(v2)

- [POST /api/message/send-sms - 发送短信接口](#post-api-message-send-sms-sendsms)

### 发送站内信通知接口(v2)

- [POST /api/message/send-inside/system-notice - 发送系统通知接口](#post-api-message-send-inside-system-notice-sendinside-4)
- [POST /api/message/send-inside/function-callback - 发送功能回调消息接口](#post-api-message-send-inside-function-callback-sendinside-5)
- [POST /api/message/send-inside/business-notice - 发送业务提醒接口](#post-api-message-send-inside-business-notice-sendinside-6)
- [POST /api/message/send-inside/announcement - 发送系统公告接口](#post-api-message-send-inside-announcement-sendinside-7)

### 发送邮件通知接口(V2)

- [POST /api/message/send-email - 发送模版邮件接口](#post-api-message-send-email-sendemail)
- [POST /api/message/send-customer-email - 发送自定义邮件接口](#post-api-message-send-customer-email-sendemail-1)
- [POST /api/message/send-customer-email-attachment - 发送自定义邮件(带附件)接口](#post-api-message-send-customer-email-attachment-sendemail-2)

### IM消息命令(v1)

- [POST /api/im/message/send/template-message - 发送即时通讯模版消息接口](#post-api-im-message-send-template-message-sendimtemplatemessage)
- [POST /api/im/message/send/message - 发送点对点消息接口](#post-api-im-message-send-message-sendimmessage)
- [POST /api/im/message/send/group-message - 发送即时通讯群组消息接口](#post-api-im-message-send-group-message-sendimgroupmessage)
- [POST /api/im/message/forward/message - 转发消息接口(模版消息不可以转发)](#post-api-im-message-forward-message-forwardmessage)

### IM消息查询

- [POST /api/im/message/query/un-read-last-message - 查询用户所有会话最后一条未读消息接口(已经按照时间进行倒序组装数据)](#post-api-im-message-query-un-read-last-message-querylastunreadmessage)
- [GET /api/im/message/query - 查询消息(分页)接口](#get-api-im-message-query-findpage)
- [GET /api/im/message/query/{id} - 查询消息(ID)接口](#get-api-im-message-query-id-querymessage)
- [GET /api/im/message/query/useful-expression - 查询常用语接口](#get-api-im-message-query-useful-expression-deleteusefulexpression)
- [GET /api/im/message/query/read-info/{id} - 查询消息已读记录接口](#get-api-im-message-query-read-info-id-querymessagereadinfo)
- [GET /api/im/message/query/message/read-mark - 消息已读标记查询接口](#get-api-im-message-query-message-read-mark-querymessagereadmark)
- [GET /api/im/message/query/list - 查询消息(列表)接口](#get-api-im-message-query-list-querymessage-1)
- [GET /api/im/message/query/collect - 查询标签下的消息收藏接口](#get-api-im-message-query-collect-querycollectmessage)
- [GET /api/im/message/query/collect-tag - 查询消息收藏标签接口](#get-api-im-message-query-collect-tag-querycollectmessagetag)

### IM审核接口

- [POST /api/goods/wrokflow/callback - Workflow任务回调](#post-api-goods-wrokflow-callback-callback-1)
- [POST /api/goods/verify - 消息审核接口](#post-api-goods-verify-verifyorder)
- [POST /api/goods/verify/result-hand-enter - 审批结果手工录入](#post-api-goods-verify-result-hand-enter-verifyresulthandenter)

### 公共接口管理

- [POST /api/common/query/file - 查询查询文件接口](#post-api-common-query-file-queryfile)
- [GET /api/common/query/department-employee-user - 查询部门员工用户接口](#get-api-common-query-department-employee-user-querycompanyemployeeuser)
- [GET /api/common/get/platform-assistant-client/version-info - 获取消息客户端版本信息接口](#get-api-common-get-platform-assistant-client-version-info-getplatformassistantcl)
- [GET /api/common/download/platform-assistant-client/{type} - 下载消息客户端(安装包)接口](#get-api-common-download-platform-assistant-client-type-downloadplatformassistant)
- [GET /api/common/download/mac/snipaste - 下载Mac版截图工具接口](#get-api-common-download-mac-snipaste-downloadmacsnipaste)

### IM日历日程查询

- [POST /api/calendar-schedule/query - 查询日历日程接口](#post-api-calendar-schedule-query-querycalendarschedule)

### 用户任务管理

- [GET /api/task/query/{id} - 查询主任务(ID)接口](#get-api-task-query-id-query)
- [GET /api/task/query/untreated-count/{principalId} - 查询用户未处理的任务条数接口](#get-api-task-query-untreated-count-principalid-queryuntreatedcount)
- [GET /api/task/query/task/sub-task/{id} - 查询主任务的子任务列表(主任务ID)接口](#get-api-task-query-task-sub-task-id-querytasksubtasklist)
- [GET /api/task/query/sub-task/{subTaskId} - 查询子任务(ID)接口](#get-api-task-query-sub-task-subtaskid-querysubtask)
- [GET /api/task/query-page/principal/{principalId} - 查询需要用户处理的子任务(分页)接口](#get-api-task-query-page-principal-principalid-query-1)
- [GET /api/task/query-page/initiator/{initiatorId} - 查询用户发起的主任务(分页)接口](#get-api-task-query-page-initiator-initiatorid-query-2)

### OA印章查询

- [GET /api/signet/page - 查询印章(分页)](#get-api-signet-page-page)
- [GET /api/signet/list - 查询印章(列表)](#get-api-signet-list-list)
- [GET /api/signet/get/{id} - 查询印章(单个)](#get-api-signet-get-id-get)

### OA印章使用记录查询

- [GET /api/signet/pageUseRecord - 查询使用记录(分页)](#get-api-signet-pageuserecord-pageuserecord)
- [GET /api/signet/listUseRecord - 查询使用记录(列表)](#get-api-signet-listuserecord-listuserecord)
- [GET /api/signet/getUseRecord/{id} - 查询使用记录(单个)](#get-api-signet-getuserecord-id-getuserecord)

### OA印章制作记录查询

- [GET /api/signet/pageMakeRecord - 查询制作记录(分页)](#get-api-signet-pagemakerecord-pagemakerecord)
- [GET /api/signet/listMakeRecord - 查询制作记录(列表)](#get-api-signet-listmakerecord-listmakerecord)
- [GET /api/signet/getMakeRecord/{id} - 查询制作记录(单个)](#get-api-signet-getmakerecord-id-getmakerecord)

### OA印章外借记录查询

- [GET /api/signet/pageLendOutRecord - 查询外借记录(分页)](#get-api-signet-pagelendoutrecord-pagelendoutrecord)
- [GET /api/signet/listLendOutRecord - 查询外借记录(列表)](#get-api-signet-listlendoutrecord-listlendoutrecord)
- [GET /api/signet/getLendOutRecord/{id} - 查询外借记录(单个)](#get-api-signet-getlendoutrecord-id-getlendoutrecord)

### OA印章交接记录查询

- [GET /api/signet/pageGrantReceiveRecord - 查询交接记录(分页)](#get-api-signet-pagegrantreceiverecord-pagegrantreceiverecord)
- [GET /api/signet/listGrantReceiveRecord - 查询交接记录(列表)](#get-api-signet-listgrantreceiverecord-listgrantreceiverecord)
- [GET /api/signet/getGrantReceiveRecord/{id} - 查询交接记录(单个)](#get-api-signet-getgrantreceiverecord-id-getgrantreceiverecord)

### OA印章作废查询

- [GET /api/signet/listVoidRecord - 查询作废记录(列表)](#get-api-signet-listvoidrecord-listvoidrecord)

### OA印章分类查询

- [GET /api/signet/getCategory - 查询印章分类](#get-api-signet-getcategory-getcategory)
- [GET /api/signet/getCategory/{id} - 查询印章分类](#get-api-signet-getcategory-id-getcategory-1)

### 服务监控管理

- [GET /api/monitor/version - 获取服务版本信息](#get-api-monitor-version-version)
- [GET /api/monitor/health - 心跳检查](#get-api-monitor-health-health)

### 通知查询

- [GET /api/message/query/{id} - 查询消息接口](#get-api-message-query-id-query-3)
- [GET /api/message/query/unread-count/{clientKey} - 查询客户端未读消息条数接口](#get-api-message-query-unread-count-clientkey-queryunreadcount)
- [GET /api/message/query/title-unread-count/{clientKey} - 查询客户端各个标题未读消息条数接口](#get-api-message-query-title-unread-count-clientkey-querytitleunreadcount)
- [GET /api/message/query/business-notice/receive-user-list/{businessId} - 查询业务提醒消息接收人列表(列表)接口](#get-api-message-query-business-notice-receive-user-list-businessid-querybusiness)
- [GET /api/message/query-page - 查询客户端消息(分页)接口](#get-api-message-query-page-query-4)

### 通知模版

- [GET /api/message/page-query/template - 查询站内信模版列表](#get-api-message-page-query-template-findinsidetemplatepage)
- [GET /api/email/template/page - 查询邮件模版列表](#get-api-email-template-page-findemailtemplatepage)
- [GET /api/email/template/get/{id} - 查询邮件模版详情](#get-api-email-template-get-id-findemailtemplate)

### 通知服务器

- [GET /api/message/page-query/server - 查询消息服务器配置](#get-api-message-page-query-server-msgserverquery)

### IM会议查询

- [GET /api/meeting/query/{id} - 查询会议接口(单个)](#get-api-meeting-query-id-querymeeting)
- [GET /api/meeting/query/verify-meeting-room-apply - 查询我审核的会议申请接口](#get-api-meeting-query-verify-meeting-room-apply-queryverifymeetingroomapply)
- [GET /api/meeting/query/meeting-room - 查询会议室接口](#get-api-meeting-query-meeting-room-querymeetingroom)
- [GET /api/meeting/query/meeting-room/{id} - 查询会议室接口](#get-api-meeting-query-meeting-room-id-querymeetingroom-1)
- [GET /api/meeting/query/meeting-Room-Un-Start-Meeting/{id} - 查询会议室尚未开始的会议接口](#get-api-meeting-query-meeting-room-un-start-meeting-id-querymeetingroomunstartme)
- [GET /api/meeting/query/list - 查询会议接口(列表)](#get-api-meeting-query-list-querymeeting-1)
- [GET /api/meeting/query/join-meeting - 查询我参与的会议接口](#get-api-meeting-query-join-meeting-queryjoinmeeting)
- [GET /api/meeting/query/join-meeting-un-start - 查询我参与的尚未开始的会议接口](#get-api-meeting-query-join-meeting-un-start-queryjoinmeetingunstart)
- [GET /api/meeting/query/commit-meeting-room-apply - 查询我发起的会议申请接口](#get-api-meeting-query-commit-meeting-room-apply-querycommitmeetingroomapply)

### IM消息群组查询

- [GET /api/im/group/query - 查询群组列表接口](#get-api-im-group-query-querygroup)
- [GET /api/im/group/query/{id} - 查询群组详情接口](#get-api-im-group-query-id-querygroup-1)
- [GET /api/im/group/query/user/{id} - 查询群组用户接口](#get-api-im-group-query-user-id-querygroupuser)
- [GET /api/im/group/query/member/{id} - 查询群组成员接口](#get-api-im-group-query-member-id-querygroupmember)

### IM邮件查询

- [GET /api/im/email/query - 查询邮件接口](#get-api-im-email-query-queryemail)
- [GET /api/im/email/query/{id} - 查询邮件接口](#get-api-im-email-query-id-queryemail-1)
- [GET /api/im/email/query/user - 查询用户接口](#get-api-im-email-query-user-queryuser)
- [GET /api/im/email/query/un-read-count/{type} - 查询未读邮件条数接口](#get-api-im-email-query-un-read-count-type-queryunreademailcount)
- [GET /api/im/email/query/read-info/{id} - 查询邮件已读记录接口](#get-api-im-email-query-read-info-id-querymessagereadinfo-1)
- [GET /api/im/email/query/collect - 查询邮件收藏接口](#get-api-im-email-query-collect-querycollectmessage-1)
- [GET /api/im/email/query/collect-tag - 查询邮件收藏标签接口](#get-api-im-email-query-collect-tag-querycollectmessagetag-1)

### IM公告查询

- [GET /api/im/bulletin/query - 查询公告接口](#get-api-im-bulletin-query-querybulletin)
- [GET /api/im/bulletin/query/{id} - 查询公告接口](#get-api-im-bulletin-query-id-querybulletin-1)
- [GET /api/im/bulletin/query-published - 查询已发布的公告接口](#get-api-im-bulletin-query-published-querypushedbulletin)

### IM管理接口

- [GET /api/common/query/im-unread-msg-count - 查询及时通讯未读信息条数(消息、邮件、公告)接口](#get-api-common-query-im-unread-msg-count-queryimunreadmsgcount)

### main-site-error-handler

- [GET /error ](#get-error-handleerror)
- [POST /error ](#post-error-handleerror-1)
- [PUT /error ](#put-error-handleerror-2)
- [DELETE /error ](#delete-error-handleerror-3)
- [PATCH /error ](#patch-error-handleerror-4)
- [OPTIONS /error ](#options-error-handleerror-6)
- [HEAD /error ](#head-error-handleerror-5)


## 接口详情

<a id="put-api-signet-updateuserecord-id-updateuserecord"></a>

### PUT /api/signet/updateUseRecord/{id}

- 分组：OA印章使用记录命令
- 名称：修改使用记录
- OperationId：updateUseRecord

#### 调用方法

`PUT /api/signet/updateUseRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 使用记录ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SignetUseRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetUseRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| useUserId | integer(int64) | 是 | 用印人ID |  |
| attachmentList | SignetAttachmentInfoDTO[] | 是 | 附件列表 |  |
| useDate | string | 是 | 用印日期 |  |
| useCount | integer(int32) | 是 | 用印份数 |  |
| reason | string | 是 | 理由 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 否 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetUseRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-registeuserecord-id-fileid-signetid-registeuserecord"></a>

### PUT /api/signet/registeUseRecord/{id}/{fileId}/{signetId}

- 分组：OA印章使用记录命令
- 名称：用印登记
- OperationId：registeUseRecord

#### 调用方法

`PUT /api/signet/registeUseRecord/{id}/{fileId}/{signetId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 使用记录ID | 1 |
| fileId | path | 是 | string | 附件ID | 1 |
| signetId | path | 是 | integer(int64) | 印章ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-deleteuserecord-id-deleteuserecord"></a>

### PUT /api/signet/deleteUseRecord/{id}

- 分组：OA印章使用记录命令
- 名称：删除使用记录
- OperationId：deleteUseRecord
- 描述：逻辑删除

#### 调用方法

`PUT /api/signet/deleteUseRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 使用记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-adduserecord-adduserecord"></a>

### POST /api/signet/addUseRecord

- 分组：OA印章使用记录命令
- 名称：添加使用记录
- OperationId：addUseRecord

#### 调用方法

`POST /api/signet/addUseRecord`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SignetUseRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetUseRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| useUserId | integer(int64) | 是 | 用印人ID |  |
| attachmentList | SignetAttachmentInfoDTO[] | 是 | 附件列表 |  |
| useDate | string | 是 | 用印日期 |  |
| useCount | integer(int32) | 是 | 用印份数 |  |
| reason | string | 是 | 理由 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 否 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetUseRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-updatemakerecord-id-updatemakerecord"></a>

### PUT /api/signet/updateMakeRecord/{id}

- 分组：OA印章制作记录命令
- 名称：修改制作记录
- OperationId：updateMakeRecord

#### 调用方法

`PUT /api/signet/updateMakeRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 制作记录ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SignetMakeRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetMakeRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 否 | 名称 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| makeDepartmentId | integer(int64) | 是 | 制作部门ID |  |
| operator | integer(int64) | 是 | 经办人ID |  |
| signetCategoryId | integer(int64) | 是 | 印章类型ID |  |
| signetName | string | 是 | 印章名称 |  |
| signetImage | string | 否 | 印章图片 |  |
| purpose | string | 否 | 用途 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetMakeRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-deletemakerecord-id-deletemakerecord"></a>

### PUT /api/signet/deleteMakeRecord/{id}

- 分组：OA印章制作记录命令
- 名称：删除制作记录
- OperationId：deleteMakeRecord
- 描述：逻辑删除

#### 调用方法

`PUT /api/signet/deleteMakeRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 制作记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-addmakerecord-addmakerecord"></a>

### POST /api/signet/addMakeRecord

- 分组：OA印章制作记录命令
- 名称：添加制作记录
- OperationId：addMakeRecord

#### 调用方法

`POST /api/signet/addMakeRecord`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SignetMakeRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetMakeRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 否 | 名称 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| makeDepartmentId | integer(int64) | 是 | 制作部门ID |  |
| operator | integer(int64) | 是 | 经办人ID |  |
| signetCategoryId | integer(int64) | 是 | 印章类型ID |  |
| signetName | string | 是 | 印章名称 |  |
| signetImage | string | 否 | 印章图片 |  |
| purpose | string | 否 | 用途 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetMakeRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-updatelendoutrecord-id-updatelendoutrecord"></a>

### PUT /api/signet/updateLendOutRecord/{id}

- 分组：OA印章外借记录命令
- 名称：修改外借记录
- OperationId：updateLendOutRecord

#### 调用方法

`PUT /api/signet/updateLendOutRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 外借记录ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetLendOutRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetLendOutRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| useUserList | integer(int64) | 是 | 携带人ID集合 |  |
| startTime | string | 是 | 开始时间 | "2025-01-02 12:34:56" |
| endTime | string | 是 | 结束时间 | "2025-01-02 12:34:56" |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetLendOutRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-deletelendoutrecord-id-deletelendoutrecord"></a>

### PUT /api/signet/deleteLendOutRecord/{id}

- 分组：OA印章外借记录命令
- 名称：删除外借记录
- OperationId：deleteLendOutRecord
- 描述：逻辑删除

#### 调用方法

`PUT /api/signet/deleteLendOutRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 外借记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-addlendoutrecord-addlendoutrecord"></a>

### POST /api/signet/addLendOutRecord

- 分组：OA印章外借记录命令
- 名称：添加外借记录
- OperationId：addLendOutRecord

#### 调用方法

`POST /api/signet/addLendOutRecord`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetLendOutRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetLendOutRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| useUserList | integer(int64) | 是 | 携带人ID集合 |  |
| startTime | string | 是 | 开始时间 | "2025-01-02 12:34:56" |
| endTime | string | 是 | 结束时间 | "2025-01-02 12:34:56" |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetLendOutRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-updatecategory-id-updatecategory"></a>

### PUT /api/signet/updateCategory/{id}

- 分组：OA印章分类命令
- 名称：修改印章分类
- OperationId：updateCategory

#### 调用方法

`PUT /api/signet/updateCategory/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章分类ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateSignetCategoryRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.UpdateSignetCategoryRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| parentId | integer(int64) | 否 | 父级分类ID |  |
| useApproveForCompany | boolean | 否 | 用印是否需要公司审批 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetCategoryResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-deletecategory-id-deletecategory"></a>

### PUT /api/signet/deleteCategory/{id}

- 分组：OA印章分类命令
- 名称：删除印章分类
- OperationId：deleteCategory
- 描述：逻辑删除

#### 调用方法

`PUT /api/signet/deleteCategory/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章分类ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-addcategory-addcategory"></a>

### POST /api/signet/addCategory

- 分组：OA印章分类命令
- 名称：添加印章分类
- OperationId：addCategory

#### 调用方法

`POST /api/signet/addCategory`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetCategoryRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetCategoryRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| parentId | integer(int64) | 否 | 父级分类ID |  |
| useApproveForCompany | boolean | 否 | 用印是否需要公司审批 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetCategoryResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-update-id-update"></a>

### PUT /api/signet/update/{id}

- 分组：OA印章命令
- 名称：修改印章
- OperationId：update

#### 调用方法

`PUT /api/signet/update/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateSignetRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.UpdateSignetRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| image | string | 否 | 图片 |  |
| supportLendOut | boolean | 是 | 是否可外借 |  |
| inHouse | boolean | 是 | 是否在库 |  |
| categoryId | integer(int64) | 是 | 类型ID |  |
| saveDepartmentId | integer(int64) | 是 | 保管部门ID |  |
| saveUserList | integer(int64)[] | 是 | 保管人ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-lose-id-lose"></a>

### PUT /api/signet/lose/{id}

- 分组：OA印章命令
- 名称：印章丢失
- OperationId：lose

#### 调用方法

`PUT /api/signet/lose/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-signet-enable-id-enable"></a>

### PUT /api/signet/enable/{id}

- 分组：OA印章命令
- 名称：印章启用
- OperationId：enable

#### 调用方法

`PUT /api/signet/enable/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-workflow-callback-callback"></a>

### POST /api/workflow/callback

- 分组：OA印章命令
- 名称：任务回调
- OperationId：callback

#### 调用方法

`POST /api/workflow/callback`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：WorkflowCallBackRequest（com.leadwaycloud.message.system.support.adapter.dto.request.WorkflowCallBackRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID |  |
| submitBy | string | 否 | 当前 审批人/操作人 |  |
| businessTypeKey | string | 是 | 业务唯一key |  |
| businessId | string | 是 | 业务ID |  |
| taskId | string | 否 | 节点实例任务ID |  |
| serviceName | string | 否 | 回调服务名 |  |
| function | string | 是 | 具体执行方法（自定义配置，可缺省） |  |
| businessData | object | 否 | 业务数据（发起时业务、审批中特有变量 并集） |  |
| instanceState | string | 是 | 实例状态（pass, reject, terminate） |  |
| terminationRemark | string | 否 | 消息 |  |
| body | object | 否 | 自定义配置数据 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-add-add"></a>

### POST /api/signet/add

- 分组：OA印章命令
- 名称：添加印章
- OperationId：add

#### 调用方法

`POST /api/signet/add`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| image | string | 否 | 图片 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| supportLendOut | boolean | 是 | 是否可外借 |  |
| inHouse | boolean | 是 | 是否在库 |  |
| categoryId | integer(int64) | 是 | 类型ID |  |
| saveDepartmentId | integer(int64) | 是 | 保管部门ID |  |
| saveUserList | integer(int64)[] | 是 | 保管人ID集合 |  |
| status | string | 否 | 状态  【 DELETE : 删除   UN_ENABLE : 制作中   ENABLE : 启用   LOSE : 丢失   ENCASE : 封存   DESTROY : 销毁   】 | "ENABLE" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-message-update-status-to-read-id-update-1"></a>

### PUT /api/message/update/status/to-read/{id}

- 分组：通知命令
- 名称：变更通知状态已读接口
- OperationId：update_1

#### 调用方法

`PUT /api/message/update/status/to-read/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 通知ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-message-update-status-to-read-client-key-clientkey-update-2"></a>

### PUT /api/message/update/status/to-read/client-key/{clientKey}

- 分组：通知命令
- 名称：批量变更客户端通知已读接口
- OperationId：update_2

#### 调用方法

`PUT /api/message/update/status/to-read/client-key/{clientKey}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| clientKey | path | 是 | string | 客户端连接符 | "UUID" |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BatchOperationMsgRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.BatchOperationMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| batch | string | 否 | 批次(发送消息时产生) | "UUID" |
| type | string | 否 | 消息类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 否 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| status | string | 否 | 消息状态  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| sentSuccess | boolean | 否 | 是否发送成功 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-message-remove-id-remove"></a>

### DELETE /api/message/remove/{id}

- 分组：通知命令
- 名称：删除通知接口
- OperationId：remove
- 描述：物理删除

#### 调用方法

`DELETE /api/message/remove/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 通知ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-message-remove-client-key-clientkey-removebyclientkey"></a>

### DELETE /api/message/remove/client-key/{clientKey}

- 分组：通知命令
- 名称：批量删除客户端通知接口
- OperationId：removeByClientKey
- 描述：物理删除

#### 调用方法

`DELETE /api/message/remove/client-key/{clientKey}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| clientKey | path | 是 | string | 客户端连接符 | "UUID" |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：BatchOperationMsgRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.BatchOperationMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| batch | string | 否 | 批次(发送消息时产生) | "UUID" |
| type | string | 否 | 消息类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 否 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| status | string | 否 | 消息状态  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| sentSuccess | boolean | 否 | 是否发送成功 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-message-template-id-msgtemplateupdate"></a>

### PUT /api/message/template/{id}

- 分组：通知模版命令
- 名称：编辑站内信模版接口
- OperationId：msgTemplateUpdate

#### 调用方法

`PUT /api/message/template/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息模版ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateIInsideTemplateRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateIInsideTemplateRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| config | string | 否 | 信息模版配置 | "{}" |
| subject | string | 否 | 主题 |  |
| template | string | 否 | 信息模版内容 | "<html>" |
| active | boolean | 否 | 是否启用 | true |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：InsideTemplateResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | InsideTemplateResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-email-template-update-id-updateemailtemplate"></a>

### PUT /api/email/template/update/{id}

- 分组：通知模版命令
- 名称：编辑邮件模版接口
- OperationId：updateEmailTemplate

#### 调用方法

`PUT /api/email/template/update/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | ID |  |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateEmailTemplateRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateEmailTemplateRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| title | string | 否 | 标题 | "1" |
| status | string | 否 | 状态 | "1" |
| content | string | 否 | 内容 | "1" |
| ccRole | string | 否 | 抄送角色 | "11111111,2222222" |
| ccUser | string | 否 | 抄送用户ID集合 | "11111111,2222222" |
| addresseeUser | string | 否 | 收件用户ID集合 | "11111111,2222222" |
| notifySupplier | boolean | 否 | 通知供应商 | false |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-query-template-createinsidetemplate"></a>

### POST /api/message/query/template

- 分组：通知模版命令
- 名称：创建站内信模版接口
- OperationId：createInsideTemplate

#### 调用方法

`POST /api/message/query/template`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CreateInsideTemplateRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateInsideTemplateRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID |  |
| name | string | 是 | 消息模版名称 | "提醒信息" |
| type | string | 是 | 消息模版类型(验证码消息code(EMAIL_VERIFICATION_CODE)/各业务类型code(BK_xxx)) | "EMAIL_VERIFICATION_CODE" |
| config | string | 是 | 信息模版配置 | "{}" |
| subject | string | 是 | 主题 |  |
| template | string | 是 | 信息模版内容 | "<html>" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：InsideTemplateResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | InsideTemplateResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-email-template-add-add-1"></a>

### POST /api/email/template/add

- 分组：通知模版命令
- 名称：添加邮件模版接口
- OperationId：add_1

#### 调用方法

`POST /api/email/template/add`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CreateEmailTemplateRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateEmailTemplateRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID | 1 |
| title | string | 是 | 标题 | "1" |
| status | string | 是 | 状态 | "1" |
| type | string | 是 | 类型 | "1" |
| content | string | 是 | 内容 | "1" |
| ccRole | string | 否 | 抄送角色ID集合 | "11111,2222222" |
| ccUser | string | 否 | 抄送用户ID集合 | "11111,2222222" |
| addresseeUser | string | 否 | 收件用户ID集合 | "11111,2222222" |
| notifySupplier | boolean | 否 | 通知供应商 | false |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-email-template-delete-id-deletemsgtemplate"></a>

### DELETE /api/email/template/delete/{id}

- 分组：通知模版命令
- 名称：删除邮件模版接口
- OperationId：deleteMsgTemplate

#### 调用方法

`DELETE /api/email/template/delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-message-server-id-msgserverupdate"></a>

### PUT /api/message/server/{id}

- 分组：通知服务器命令
- 名称：修改通知服务器配置
- OperationId：msgServerUpdate

#### 调用方法

`PUT /api/message/server/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 通知服务器配置ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateMsgServerRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateMsgServerRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| config | MsgServerConfigDTO | 是 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgServerResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgServerResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-query-server-msgservercreate"></a>

### POST /api/message/query/server

- 分组：通知服务器命令
- 名称：创建通知服务器配置
- OperationId：msgServerCreate

#### 调用方法

`POST /api/message/query/server`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CreateMsgServerRequest（com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateMsgServerRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 否 | 公司ID |  |
| name | string | 是 | 服务配置名称 | "MAILSERVER" |
| type | string | 是 | 服务类型(比如:EMAIL,SMS)  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEBSOCKET" |
| config | MsgServerConfigDTO | 是 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgServerResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgServerResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-meeting-update-meeting-room-id-updatemeetingroom"></a>

### PUT /api/meeting/update/meeting-room/{id}

- 分组：IM会议命令
- 名称：修改会议室接口
- OperationId：updateMeetingRoom

#### 调用方法

`PUT /api/meeting/update/meeting-room/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议室ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateMeetingRoomRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.UpdateMeetingRoomRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| image | string | 否 | 照片 |  |
| openStartTime | string | 是 | 开始时间 | "08:00:00" |
| openEndTime | string | 是 | 结束时间 | "18:30:00" |
| peopleCount | string | 是 | 容纳人数 |  |
| supportMeetingType | string[] | 是 | 支持会议类型(从sys_properties中取MEETING_TYPE组) |  |
| firstManager | integer(int64) | 是 | 第一责任人ID |  |
| secondManager | integer(int64) | 是 | 第二责任人ID |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingRoomResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-meeting-update-meeting-room-status-id-newstatus-updatemeetingroomstatus"></a>

### PUT /api/meeting/update/meeting-room/status/{id}/{newStatus}

- 分组：IM会议命令
- 名称：修改会议室状态接口
- OperationId：updateMeetingRoomStatus

#### 调用方法

`PUT /api/meeting/update/meeting-room/status/{id}/{newStatus}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议室ID | 1 |
| newStatus | path | 是 | string | 新的状态 | "CLOSE" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-meeting-update-meeting-room-apply-id-updatemeetingroomapply"></a>

### PUT /api/meeting/update/meeting-room-apply/{id}

- 分组：IM会议命令
- 名称：修改会议室申请接口
- OperationId：updateMeetingRoomApply

#### 调用方法

`PUT /api/meeting/update/meeting-room-apply/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateMeetingRoomApplyRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.UpdateMeetingRoomApplyRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型 |  |
| meetingDate | string | 否 | 会议日期 | "2024-07-02" |
| startTime | string | 否 | 开始时间 | "13:09:11" |
| endTime | string | 否 | 结束时间 | "13:09:11" |
| compere | integer(int64) | 是 | 主持人ID |  |
| subject | string | 是 | 主题 |  |
| agenda | string | 否 | 议程 |  |
| peopleCount | string | 是 | 预计人数 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| notes | string | 否 | 备注 |  |
| meetingRoomId | integer(int64) | 是 | 会议室ID |  |
| meetingMemberList | integer(int64)[] | 是 | 参会成员 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-meeting-update-meeting-attachment-id-updatemeetingattachment"></a>

### PUT /api/meeting/update/meeting-attachment/{id}

- 分组：IM会议命令
- 名称：更新会议附件接口
- OperationId：updateMeetingAttachment

#### 调用方法

`PUT /api/meeting/update/meeting-attachment/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AttachmentInfoDTO[]（com.leadwaycloud.message.system.support.application.dto.AttachmentInfoDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | AttachmentInfoDTO[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-meeting-cancel-meeting-room-apply-id-cancelmeetingroomapply"></a>

### PUT /api/meeting/cancel/meeting-room-apply/{id}

- 分组：IM会议命令
- 名称：取消会议室申请接口
- OperationId：cancelMeetingRoomApply

#### 调用方法

`PUT /api/meeting/cancel/meeting-room-apply/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-meeting-verify-meeting-room-apply-id-verifymeetingroomapply"></a>

### POST /api/meeting/verify/meeting-room-apply/{id}

- 分组：IM会议命令
- 名称：会议室申请审核接口
- OperationId：verifyMeetingRoomApply

#### 调用方法

`POST /api/meeting/verify/meeting-room-apply/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：VerifyMeetingRoomApplyRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.VerifyMeetingRoomApplyRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pass | boolean | 是 | 是否通过 |  |
| reason | string | 是 | 理由 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-meeting-notice-join-meeting-user-id-noticejoinmeetinguser"></a>

### POST /api/meeting/notice-join-meeting-user/{id}

- 分组：IM会议命令
- 名称：通知会议参与人员接口
- OperationId：noticeJoinMeetingUser

#### 调用方法

`POST /api/meeting/notice-join-meeting-user/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-meeting-join-meeting-confirm-id-joinmeetingconfirm"></a>

### POST /api/meeting/join-meeting-confirm/{id}

- 分组：IM会议命令
- 名称：会议参与确认接口
- OperationId：joinMeetingConfirm

#### 调用方法

`POST /api/meeting/join-meeting-confirm/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：JoinMeetingConfirmRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.JoinMeetingConfirmRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| join | boolean | 是 | 是否参与 |  |
| reason | string | 是 | 理由 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-meeting-apply-meeting-room-applymeetingroom"></a>

### POST /api/meeting/apply/meeting-room

- 分组：IM会议命令
- 名称：申请会议室接口
- OperationId：applyMeetingRoom

#### 调用方法

`POST /api/meeting/apply/meeting-room`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ApplyMeetingRoomRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.ApplyMeetingRoomRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型 |  |
| meetingDate | string | 否 | 会议日期 | "2024-07-02" |
| startTime | string | 否 | 开始时间 | "13:09:11" |
| endTime | string | 否 | 结束时间 | "13:09:11" |
| compere | integer(int64) | 是 | 主持人ID |  |
| subject | string | 是 | 主题 |  |
| agenda | string | 否 | 议程 |  |
| peopleCount | string | 是 | 预计人数 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| notes | string | 否 | 备注 |  |
| meetingRoomId | integer(int64) | 是 | 会议室ID |  |
| meetingMemberList | integer(int64)[] | 是 | 参会成员 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-meeting-add-meeting-room-createmeetingroom"></a>

### POST /api/meeting/add/meeting-room

- 分组：IM会议命令
- 名称：创建会议室接口
- OperationId：createMeetingRoom

#### 调用方法

`POST /api/meeting/add/meeting-room`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CreateMeetingRoomRequest（com.leadwaycloud.message.oa.meeting.adapter.dto.request.CreateMeetingRoomRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| image | string | 否 | 照片 |  |
| openStartTime | string | 是 | 开始时间 | "08:00:00" |
| openEndTime | string | 是 | 结束时间 | "18:30:00" |
| peopleCount | string | 是 | 容纳人数 |  |
| supportMeetingType | string[] | 是 | 支持会议类型(从sys_properties中取MEETING_TYPE组) |  |
| firstManager | integer(int64) | 是 | 第一责任人ID |  |
| secondManager | integer(int64) | 是 | 第二责任人ID |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingRoomResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-sort-useful-expression-sortusefulexpression"></a>

### PUT /api/im/message/sort/useful-expression

- 分组：IM消息命令
- 名称：常用语排序接口
- OperationId：sortUsefulExpression

#### 调用方法

`PUT /api/im/message/sort/useful-expression`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SortIMUsefulExpressionRequest[]（com.leadwaycloud.message.im.message.adapter.dto.request.SortIMUsefulExpressionRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | SortIMUsefulExpressionRequest[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UsefulExpressionResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UsefulExpressionResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-revoke-id-revokemessage"></a>

### PUT /api/im/message/revoke/{id}

- 分组：IM消息命令
- 名称：消息撤回接口
- OperationId：revokeMessage

#### 调用方法

`PUT /api/im/message/revoke/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-rename-collect-tag-renamecollectmessagetag"></a>

### PUT /api/im/message/rename/collect/tag

- 分组：IM消息命令
- 名称：重命名消息收藏标签接口
- OperationId：renameCollectMessageTag

#### 调用方法

`PUT /api/im/message/rename/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：RenameCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.RenameCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |
| newName | string | 是 | 新标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-read-mark-markmessageread"></a>

### PUT /api/im/message/read-mark

- 分组：IM消息命令
- 名称：消息已读标记接口
- OperationId：markMessageRead

#### 调用方法

`PUT /api/im/message/read-mark`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：MessageReadMarkRequest（com.leadwaycloud.message.im.message.adapter.dto.request.MessageReadMarkRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| groupId | integer(int64) | 否 | 群组ID(二选一,只标记群组消息全部已读) |  |
| userId | integer(int64) | 否 | 用户ID(二选一,只标记此用户一对一消息全部已读) | 593997290568452 |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-delete-id-deletemessage"></a>

### PUT /api/im/message/delete/{id}

- 分组：IM消息命令
- 名称：消息删除接口
- OperationId：deleteMessage

#### 调用方法

`PUT /api/im/message/delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-delete-collect-tag-deletecollectmessagetag"></a>

### PUT /api/im/message/delete/collect/tag

- 分组：IM消息命令
- 名称：删除消息收藏标签接口
- OperationId：deleteCollectMessageTag

#### 调用方法

`PUT /api/im/message/delete/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：DeleteCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.DeleteCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-message-delete-batch-deletemessage-1"></a>

### PUT /api/im/message/delete/batch

- 分组：IM消息命令
- 名称：消息批量删除接口
- OperationId：deleteMessage_1

#### 调用方法

`PUT /api/im/message/delete/batch`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-collect-collectmessage"></a>

### POST /api/im/message/collect

- 分组：IM消息命令
- 名称：消息收藏接口
- OperationId：collectMessage

#### 调用方法

`POST /api/im/message/collect`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CollectIMMessageRequest（com.leadwaycloud.message.im.message.adapter.dto.request.CollectIMMessageRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID |  |
| tagList | string[] | 否 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-api-message-send-im-template-msg-sendimmessage-1"></a>

### POST /api/im/message/api/message/send-im-template-msg

- 分组：IM消息命令
- 名称：发送模版消息接口
- OperationId：sendIMMessage_1

#### 调用方法

`POST /api/im/message/api/message/send-im-template-msg`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendTemplateMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendTemplateMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| imMsgTemplateCode | string | 是 | 模版消息唯一键(从sys_properties中取IM_MSG_TEMPLATE_CODE组) | "0454cb83a79b477db32570eb58bbc5bb" |
| paramMap | object | 是 | 消息参数 |  |
| receiveList | integer(int64) | 是 | 接收人列表(用户ID) |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-api-message-send-im-point-msg-sendimmessage-2"></a>

### POST /api/im/message/api/message/send-im-point-msg

- 分组：IM消息命令
- 名称：发送点对点消息接口
- OperationId：sendIMMessage_2

#### 调用方法

`POST /api/im/message/api/message/send-im-point-msg`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendP2PMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendP2PMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID | 1 |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| receiver | integer(int64) | 是 | 接收人(用户ID) | 600412495355845 |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| isSystem | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SendMsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SendMsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-api-message-send-im-group-msg-sendimmessage-3"></a>

### POST /api/im/message/api/message/send-im-group-msg

- 分组：IM消息命令
- 名称：发送群组消息接口
- OperationId：sendIMMessage_3

#### 调用方法

`POST /api/im/message/api/message/send-im-group-msg`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendGroupMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendGroupMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| groupId | integer(int64) | 是 | 群组ID | 1 |
| memberList | integer(int64)[] | 否 | 接收的群组成员,全部成员可不传(用户ID) | [1] |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SendMsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SendMsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-api-message-send-im-forward-msg-sendimmessage-4"></a>

### POST /api/im/message/api/message/send-im-forward-msg

- 分组：IM消息命令
- 名称：发送转发消息接口
- OperationId：sendIMMessage_4

#### 调用方法

`POST /api/im/message/api/message/send-im-forward-msg`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ForwardMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.ForwardMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| messageList | integer(int64)[] | 是 | 消息列表 | [1] |
| mergeForward | boolean | 否 | 是否合并转发 | false |
| receiverList | integer(int64)[] | 否 | 接收人列表(用户ID) | [600412495355845] |
| groupList | integer(int64)[] | 否 | 群组列表(群组ID) | [1] |
| leaveMessage | string | 否 | 留言 | "xxx" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SendMsgResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SendMsgResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-add-useful-expression-addusefulexpression"></a>

### POST /api/im/message/add/useful-expression

- 分组：IM消息命令
- 名称：添加常用语接口
- OperationId：addUsefulExpression

#### 调用方法

`POST /api/im/message/add/useful-expression`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddIMUsefulExpressionRequest（com.leadwaycloud.message.im.message.adapter.dto.request.AddIMUsefulExpressionRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| content | string | 是 | 常用语内容 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UsefulExpressionResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UsefulExpressionResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-add-collect-tag-addcollectmessagetag"></a>

### POST /api/im/message/add/collect/tag

- 分组：IM消息命令
- 名称：添加消息收藏标签接口
- OperationId：addCollectMessageTag

#### 调用方法

`POST /api/im/message/add/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.AddCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-message-delete-useful-expression-id-deleteusefulexpression-1"></a>

### DELETE /api/im/message/delete/useful-expression/{id}

- 分组：IM消息命令
- 名称：删除常用语接口
- OperationId：deleteUsefulExpression_1

#### 调用方法

`DELETE /api/im/message/delete/useful-expression/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 常用语ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-message-delete-collect-id-cancelcollectmessage"></a>

### DELETE /api/im/message/delete/collect/{id}

- 分组：IM消息命令
- 名称：消息取消收藏接口
- OperationId：cancelCollectMessage

#### 调用方法

`DELETE /api/im/message/delete/collect/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-group-update-id-updategroup"></a>

### PUT /api/im/group/update/{id}

- 分组：IM消息群组命令
- 名称：修改群组接口
- OperationId：updateGroup

#### 调用方法

`PUT /api/im/group/update/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateIMGroupRequest（com.leadwaycloud.message.im.message.adapter.dto.request.UpdateIMGroupRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 群组名称 |  |
| owner | integer(int64) | 否 | 群主 |  |
| announcement | string | 否 | 群公告 |  |
| onlyManagerAddMember | boolean | 否 | 仅管理员添加成员 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ImGroupResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-group-update-manager-id-updategroupmanager"></a>

### PUT /api/im/group/update/manager/{id}

- 分组：IM消息群组命令
- 名称：更新群组管理员接口
- OperationId：updateGroupManager

#### 调用方法

`PUT /api/im/group/update/manager/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-group-dismiss-id-dismissgroup"></a>

### PUT /api/im/group/dismiss/{id}

- 分组：IM消息群组命令
- 名称：解散群组接口
- OperationId：dismissGroup

#### 调用方法

`PUT /api/im/group/dismiss/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-group-add-addgroup"></a>

### POST /api/im/group/add

- 分组：IM消息群组命令
- 名称：添加群组接口
- OperationId：addGroup

#### 调用方法

`POST /api/im/group/add`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddIMGroupRequest（com.leadwaycloud.message.im.message.adapter.dto.request.AddIMGroupRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 群组名称 |  |
| owner | integer(int64) | 是 | 群主 |  |
| announcement | string | 否 | 群公告 |  |
| memberList | string | 否 | 群成员(用户ID) |  |
| onlyManagerAddMember | boolean | 否 | 仅管理员添加成员 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ImGroupResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-group-add-member-id-addgroupmember"></a>

### POST /api/im/group/add/member/{id}

- 分组：IM消息群组命令
- 名称：添加群组成员接口
- OperationId：addGroupMember

#### 调用方法

`POST /api/im/group/add/member/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-group-exit-id-exitgroup"></a>

### DELETE /api/im/group/exit/{id}

- 分组：IM消息群组命令
- 名称：退出群组接口
- OperationId：exitGroup
- 描述：物理删除

#### 调用方法

`DELETE /api/im/group/exit/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-group-delete-member-id-deletegroupmember"></a>

### DELETE /api/im/group/delete/member/{id}

- 分组：IM消息群组命令
- 名称：删除群组成员接口
- OperationId：deleteGroupMember
- 描述：物理删除

#### 调用方法

`DELETE /api/im/group/delete/member/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-rename-collect-tag-renamecollectemailtag"></a>

### PUT /api/im/email/rename/collect/tag

- 分组：IM邮件命令
- 名称：重命名邮件收藏标签接口
- OperationId：renameCollectEmailTag

#### 调用方法

`PUT /api/im/email/rename/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：RenameCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.RenameCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |
| newName | string | 是 | 新标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-read-mark-id-emailreadmark"></a>

### PUT /api/im/email/read-mark/{id}

- 分组：IM邮件命令
- 名称：标记邮件已读接口
- OperationId：emailReadMark

#### 调用方法

`PUT /api/im/email/read-mark/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-delete-id-deleteemail"></a>

### PUT /api/im/email/delete/{id}

- 分组：IM邮件命令
- 名称：删除邮件接口
- OperationId：deleteEmail
- 描述：草稿邮件和已删除邮件做物理删除,其它做逻辑删除

#### 调用方法

`PUT /api/im/email/delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-delete-collect-tag-deletecollectemailtag"></a>

### PUT /api/im/email/delete/collect/tag

- 分组：IM邮件命令
- 名称：删除邮件收藏标签接口
- OperationId：deleteCollectEmailTag

#### 调用方法

`PUT /api/im/email/delete/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：DeleteCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.DeleteCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-delete-batch-deleteemail-1"></a>

### PUT /api/im/email/delete/batch

- 分组：IM邮件命令
- 名称：批量删除邮件接口
- OperationId：deleteEmail_1
- 描述：草稿邮件和已删除邮件做物理删除,其它做逻辑删除

#### 调用方法

`PUT /api/im/email/delete/batch`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-cancel-delete-id-canceldeleteemail"></a>

### PUT /api/im/email/cancel-delete/{id}

- 分组：IM邮件命令
- 名称：取消邮件删除接口
- OperationId：cancelDeleteEmail
- 描述：放回发件箱/收件箱

#### 调用方法

`PUT /api/im/email/cancel-delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-email-cancel-delete-batch-canceldeleteemail-1"></a>

### PUT /api/im/email/cancel-delete/batch

- 分组：IM邮件命令
- 名称：批量取消邮件删除接口
- OperationId：cancelDeleteEmail_1
- 描述：放回发件箱/收件箱

#### 调用方法

`PUT /api/im/email/cancel-delete/batch`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：integer(int64)[]

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | integer(int64)[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-email-send-sendimemail"></a>

### POST /api/im/email/send

- 分组：IM邮件命令
- 名称：发送邮件接口
- OperationId：sendIMEmail

#### 调用方法

`POST /api/im/email/send`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：IMEmailRequest（com.leadwaycloud.message.im.email.adapter.dto.request.IMEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 否 | 消息ID(草稿邮件ID) |  |
| type | string | 是 | 类型 EMAIL:邮件 | "EMAIL" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试邮件消息" |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMEmailResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-email-save-saveemail"></a>

### POST /api/im/email/save

- 分组：IM邮件命令
- 名称：保存邮件接口
- OperationId：saveEmail

#### 调用方法

`POST /api/im/email/save`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：IMEmailRequest（com.leadwaycloud.message.im.email.adapter.dto.request.IMEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 否 | 消息ID(草稿邮件ID) |  |
| type | string | 是 | 类型 EMAIL:邮件 | "EMAIL" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试邮件消息" |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMEmailResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-email-collect-collectmessage-1"></a>

### POST /api/im/email/collect

- 分组：IM邮件命令
- 名称：邮件收藏接口
- OperationId：collectMessage_1

#### 调用方法

`POST /api/im/email/collect`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：IMCollectEmailRequest（com.leadwaycloud.message.im.email.adapter.dto.request.IMCollectEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID |  |
| tagList | string[] | 否 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-email-add-collect-tag-addcollectemailtag"></a>

### POST /api/im/email/add/collect/tag

- 分组：IM邮件命令
- 名称：添加邮件收藏标签接口
- OperationId：addCollectEmailTag

#### 调用方法

`POST /api/im/email/add/collect/tag`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddCollectTagRequest（com.leadwaycloud.message.im.message.adapter.dto.request.AddCollectTagRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-email-delete-collect-id-cancelcollectmessage-1"></a>

### DELETE /api/im/email/delete/collect/{id}

- 分组：IM邮件命令
- 名称：邮件取消收藏接口
- OperationId：cancelCollectMessage_1

#### 调用方法

`DELETE /api/im/email/delete/collect/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-business-query-print-data-id-querybusinessprintdata"></a>

### PUT /api/im/business/query/print-data/{id}

- 分组：IM业务联系单查询
- 名称：查询业务联系单打印数据接口
- OperationId：queryBusinessPrintData

#### 调用方法

`PUT /api/im/business/query/print-data/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 业务联系单ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBusinessPrintResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessPrintResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessPrintResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-business-query-querybusiness"></a>

### GET /api/im/business/query

- 分组：IM业务联系单查询
- 名称：查询业务联系单接口
- OperationId：queryBusiness

#### 调用方法

`GET /api/im/business/query`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| type | query | 是 | string | 查询类型 |  |
| status | query | 是 | string | 查询状态 |  |
| str | query | 否 | string | 内容(编号/主题) | "xxx" |
| startDate | query | 否 | string | 提出日(开始) | "2020-10-11" |
| endDate | query | 否 | string | 提出日(结束) | "2020-10-11" |
| sender | query | 否 | long | 提出人 | 600 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBusinessResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-business-query-id-querybusiness-1"></a>

### GET /api/im/business/query/{id}

- 分组：IM业务联系单查询
- 名称：查询业务联系单接口
- OperationId：queryBusiness_1

#### 调用方法

`GET /api/im/business/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 业务联系单ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBusinessResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-business-query-un-process-count-querycurrentuserunprocessbusinesscoun"></a>

### GET /api/im/business/query/un-process-count

- 分组：IM业务联系单查询
- 名称：查询当前用户未处理业务联系单数据条数接口
- OperationId：queryCurrentUserUnProcessBusinessCount

#### 调用方法

`GET /api/im/business/query/un-process-count`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-business-query-detail-id-querybusinessdetail"></a>

### GET /api/im/business/query/detail/{id}

- 分组：IM业务联系单查询
- 名称：查询业务联系单详情接口
- OperationId：queryBusinessDetail

#### 调用方法

`GET /api/im/business/query/detail/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 业务联系单ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBusinessDetailResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessDetailResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessDetailResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-business-delete-id-deletebusiness"></a>

### PUT /api/im/business/delete/{id}

- 分组：IM业务联系单命令
- 名称：删除业务联系单接口
- OperationId：deleteBusiness
- 描述：草稿状态物理删除,有效状态逻辑删除

#### 调用方法

`PUT /api/im/business/delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 业务联系单ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-business-close-id-closebusiness"></a>

### PUT /api/im/business/close/{id}

- 分组：IM业务联系单命令
- 名称：关闭业务联系单接口
- OperationId：closeBusiness

#### 调用方法

`PUT /api/im/business/close/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 业务联系单ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-business-create-createbusiness"></a>

### POST /api/im/business/create

- 分组：IM业务联系单命令
- 名称：创建业务联系单接口
- OperationId：createBusiness
- 描述：存在则修改，否则新增

#### 调用方法

`POST /api/im/business/create`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CreateImBusinessRequest（com.leadwaycloud.message.im.business.adapter.dto.request.CreateImBusinessRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 否 | 业务联系单ID |  |
| type | string | 是 | 类型 BUSINESS:业务联系单 | "BUSINESS" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试业务联系单消息" |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| departmentId | integer(int64) | 否 | 业务联系单提出部门ID | 1 |
| departmentName | string | 否 | 业务联系单提出部门名称 | "xxx" |
| approvalUserId | integer(int64) | 否 | 业务联系单审核人ID | 1 |
| approvalUserName | string | 否 | 业务联系单审核人名称 | "xxx" |
| lastConfirmTime | string | 否 | 要求反馈时间 | "2024-01-01 12:00:00" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBusinessResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-business-confirm-confirmbusiness"></a>

### POST /api/im/business/confirm

- 分组：IM业务联系单命令
- 名称：回复业务联系单接口
- OperationId：confirmBusiness

#### 调用方法

`POST /api/im/business/confirm`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ConfirmImBusinessRequest（com.leadwaycloud.message.im.business.adapter.dto.request.ConfirmImBusinessRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| content | string | 是 | 内容 | "测试消息" |
| linkId | integer(int64) | 是 | 关联消息ID |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-bulletin-update-id-updatebulletin"></a>

### PUT /api/im/bulletin/update/{id}

- 分组：IM公告命令
- 名称：修改公告接口
- OperationId：updateBulletin

#### 调用方法

`PUT /api/im/bulletin/update/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 公告ID | 1 |

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：IMBulletinRequest（com.leadwaycloud.message.im.bulletin.adapter.dto.request.IMBulletinRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pushTypeList | string | 否 | 投放类型(未提供则默认投放商户下所有用户)  【 MERCHANT : 系统用户   MEMBER : 商城用户   SUPPLIER : 供应商   】 | "[]" |
| type | string | 否 | 公告类型(从sys_properties中取MSG_BULLETIN组) |  |
| subject | string | 是 | 标题 |  |
| content | string | 是 | 内容 |  |
| pushStartTime | string | 否 | 公告发布时间 |  |
| pushEndTime | string | 否 | 公告发布终止时间 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBulletinResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-im-bulletin-read-mark-id-emailreadmark-1"></a>

### PUT /api/im/bulletin/read-mark/{id}

- 分组：IM公告命令
- 名称：标记公告已读接口
- OperationId：emailReadMark_1

#### 调用方法

`PUT /api/im/bulletin/read-mark/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-bulletin-publish-id-publishbulletin"></a>

### POST /api/im/bulletin/publish/{id}

- 分组：IM公告命令
- 名称：发布公告接口
- OperationId：publishBulletin

#### 调用方法

`POST /api/im/bulletin/publish/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 公告ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-bulletin-create-createbulletin"></a>

### POST /api/im/bulletin/create

- 分组：IM公告命令
- 名称：创建公告接口
- OperationId：createBulletin

#### 调用方法

`POST /api/im/bulletin/create`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：IMBulletinRequest（com.leadwaycloud.message.im.bulletin.adapter.dto.request.IMBulletinRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pushTypeList | string | 否 | 投放类型(未提供则默认投放商户下所有用户)  【 MERCHANT : 系统用户   MEMBER : 商城用户   SUPPLIER : 供应商   】 | "[]" |
| type | string | 否 | 公告类型(从sys_properties中取MSG_BULLETIN组) |  |
| subject | string | 是 | 标题 |  |
| content | string | 是 | 内容 |  |
| pushStartTime | string | 否 | 公告发布时间 |  |
| pushEndTime | string | 否 | 公告发布终止时间 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBulletinResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-im-bulletin-delete-id-deletebulletin"></a>

### DELETE /api/im/bulletin/delete/{id}

- 分组：IM公告命令
- 名称：删除公告接口
- OperationId：deleteBulletin
- 描述：物理删除

#### 调用方法

`DELETE /api/im/bulletin/delete/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 公告ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-calendar-schedule-update-custom-updatecustomcalendartask"></a>

### PUT /api/calendar-schedule/update/custom

- 分组：IM日历日程命令
- 名称：修改自定义日历日程接口
- OperationId：updateCustomCalendarTask

#### 调用方法

`PUT /api/calendar-schedule/update/custom`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：UpdateCalendarScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.UpdateCalendarScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |
| type | string | 否 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 否 | 日程内容 |  |
| newScheduleConfig | string | 否 | 日程排程数据,需要像创建时一样的提供(如果有提供数据,之前任务的计划将被全部重置) |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-calendar-schedule-pause-custom-pausecalendarschedule"></a>

### PUT /api/calendar-schedule/pause/custom

- 分组：IM日历日程命令
- 名称：暂停自定义日历日程接口
- OperationId：pauseCalendarSchedule

#### 调用方法

`PUT /api/calendar-schedule/pause/custom`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：PauseCalendarScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PauseCalendarScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-calendar-schedule-close-system-closesystemcalendarschedule"></a>

### PUT /api/calendar-schedule/close/system

- 分组：IM日历日程命令
- 名称：关闭系统日历日程接口
- OperationId：closeSystemCalendarSchedule
- 描述：异步接口,提供给其它模块调用

#### 调用方法

`PUT /api/calendar-schedule/close/system`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CloseSystemScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.CloseSystemScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| attachmentKey | string | 是 | 自定义数据key |  |
| userList | integer(int64)[] | 否 | 用户ID(未提供则关闭所有跟自定义数据key相关的日历日程) |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-calendar-schedule-close-system-id-closesystemcalendarschedule-1"></a>

### PUT /api/calendar-schedule/close/system/{id}

- 分组：IM日历日程命令
- 名称：关闭系统日历日程接口(仅用做关闭系统日历日程)
- OperationId：closeSystemCalendarSchedule_1

#### 调用方法

`PUT /api/calendar-schedule/close/system/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 日历日程ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-calendar-schedule-cancel-system-cancelcalendarschedule"></a>

### PUT /api/calendar-schedule/cancel/system

- 分组：IM日历日程命令
- 名称：取消系统日历日程接口
- OperationId：cancelCalendarSchedule
- 描述：异步接口,提供给其它模块调用

#### 调用方法

`PUT /api/calendar-schedule/cancel/system`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：CancelSystemScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.CancelSystemScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| attachmentKey | string | 是 | 自定义数据key |  |
| userList | integer(int64)[] | 否 | 用户ID(未提供则取消所有跟自定义数据key相关的日历日程) |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-calendar-schedule-plush-system-publishsystemcalendarschedule"></a>

### POST /api/calendar-schedule/plush/system

- 分组：IM日历日程命令
- 名称：发布系统日历日程接口
- OperationId：publishSystemCalendarSchedule
- 描述：异步接口,提供给其它模块调用

#### 调用方法

`POST /api/calendar-schedule/plush/system`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：PublishSystemScheduleRequest[]（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PublishSystemScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| (array) | PublishSystemScheduleRequest[] |  |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-calendar-schedule-plush-custom-publishcustomcalendarschedule"></a>

### POST /api/calendar-schedule/plush/custom

- 分组：IM日历日程命令
- 名称：发布自定义日历日程接口
- OperationId：publishCustomCalendarSchedule

#### 调用方法

`POST /api/calendar-schedule/plush/custom`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：PublishCalendarScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PublishCalendarScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 是 | 日程内容 |  |
| priority | integer(int32) | 否 | 优先级 | 0 |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |
| attachment | string | 否 | 自定义数据(json格式) |  |
| startDate | string | 是 | 开始日期 | "2020-10-11" |
| endDate | string | 否 | 结束日期 | "2020-10-11" |
| startTime | string | 是 | 日程开始时间 | "08:00:00" |
| endTime | string | 否 | 日程结束时间 | "09:00:00" |
| repeat | string | 是 | 重复类型  【 NONE : 无 DAY   DAY : 每天   WEEK : 每周   MONTH : 每月   YEAR : 每年   】 | "NONE" |
| weekDay | integer(int32) | 否 | 每周周几(1,2,3,4,5,6,7) | 1 |
| monthDay | integer(int32) | 否 | 每月几号(1,2,3...31) | 1 |
| yearDay | string | 否 | 每年的几月几号(01-01) | "01-01" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-api-calendar-schedule-delete-custom-deletecalendarschedule"></a>

### DELETE /api/calendar-schedule/delete/custom

- 分组：IM日历日程命令
- 名称：删除自定义日历日程接口
- OperationId：deleteCalendarSchedule

#### 调用方法

`DELETE /api/calendar-schedule/delete/custom`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：DeleteCalendarScheduleRequest（com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.DeleteCalendarScheduleRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |
| scheduleDate | string | 否 | 日程日期(未提供则删除全部，搭配current) | "2020-10-11" |
| current | boolean | 否 | 是否仅删除当前日程(未提供或者false则删除指定任务日期之后的全部任务) | true |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-api-backend-task-task-finish-taskfinish"></a>

### PUT /api/backend-task/task/finish

- 分组：后台任务管理
- 名称：主任务完成接口
- OperationId：taskFinish
- 状态：已废弃

#### 调用方法

`PUT /api/backend-task/task/finish`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：TaskFinishRequest（com.leadwaycloud.message.task.adapter.dto.request.TaskFinishRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-backend-task-sub-task-finish-subtaskfinish-1"></a>

### POST /api/backend-task/sub-task/finish

- 分组：后台任务管理
- 名称：子任务完成接口
- OperationId：subTaskFinish_1
- 状态：已废弃

#### 调用方法

`POST /api/backend-task/sub-task/finish`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SubTaskFinishRequest（com.leadwaycloud.message.task.adapter.dto.request.SubTaskFinishRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_) | "Activity_1l676zu" |
| principalId | integer(int64) | 是 | 任务处理人ID(如果不是第一次发起任务创建则必须提供) | 1 |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |
| processedNotice | boolean | 是 | 处理完成是否通知发起人 | false |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-backend-task-publish-workflow-task-publishworkflowtask-1"></a>

### POST /api/backend-task/publish-workflow-task

- 分组：后台任务管理
- 名称：发布任务接口
- OperationId：publishWorkflowTask_1
- 状态：已废弃

#### 调用方法

`POST /api/backend-task/publish-workflow-task`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：PublishWorkflowTaskRequest（com.leadwaycloud.message.task.adapter.dto.request.PublishWorkflowTaskRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessType | string | 否 | 业务类型 |  |
| businessId | integer(int64) | 否 | 业户数据ID |  |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_, 普通任务传UUID) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_, 普通任务传UUID) | "Activity_1l676zu" |
| name | string | 是 | 名称 | "审核任务" |
| type | string | 是 | 子任务类型  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】 | "TASK_VERIFY" |
| initiatorId | integer(int64) | 是 | 发起人ID | 1 |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |
| businessData | object | 是 | 任务业务数据 | {"id":1,"type":"inventory","code":"AD2021062100011","name":"xxx 盘点单"} |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| messageData | BusinessNoticeRequest | 是 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgSubTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-addvoidrecord-addvoidrecord"></a>

### POST /api/signet/addVoidRecord

- 分组：OA印章作废命令
- 名称：添加作废记录
- OperationId：addVoidRecord

#### 调用方法

`POST /api/signet/addVoidRecord`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetVoidRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetVoidRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| type | string | 是 | 类型  【 ENCASE : 封存   DESTROY : 销毁   】 | "ENCASE" |
| voidDate | string | 是 | 封存/销毁日期 |  |
| encaseEndDate | string | 否 | 封存截止日期(type=ENCASE时必须提供) |  |
| reason | string | 是 | 理由 |  |
| supervisorList | integer(int64)[] | 是 | 监督人ID集合 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetVoidRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetVoidRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetVoidRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-signet-addgrantreceiverecord-addgrantreceiverecord"></a>

### POST /api/signet/addGrantReceiveRecord

- 分组：OA印章接收记录命令
- 名称：添加交接记录
- OperationId：addGrantReceiveRecord

#### 调用方法

`POST /api/signet/addGrantReceiveRecord`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：AddSignetGrantReceiveRecordRequest（com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetGrantReceiveRecordRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| grantDepartmentId | integer(int64) | 是 | 发出部门ID |  |
| grantUserList | integer(int64) | 是 | 发出人ID集合(直接从印章保管人中提取) |  |
| receiveDepartmentId | integer(int64) | 是 | 接收部门ID |  |
| receiveUserList | integer(int64) | 是 | 接收人ID集合(外借发出时直接从外借申请携带人中提取,其他情况可自由选择) |  |
| supervisorList | integer(int64)[] | 是 | 监督人ID集合 |  |
| type | string | 是 | 类型  【 LEND_OUT_GRANT : 外借发出   LEND_OUT_RECEIVE : 外借退回   RECEIVE : 领取   TAKE_BACK : 收回   OTHER : 其他   】 | "RECEIVE" |
| businessId | integer(int64) | 否 | 业务ID(type=LEND_OUT_GRANT/LEND_OUT_RECEIVE时必须提供外借申请ID) |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-websocket-system-notice-sendinside"></a>

### POST /api/sent-message-websocket/system-notice

- 分组：发送站内信通知接口(v1)
- 名称：发送系统通知接口
- OperationId：sendInside

#### 调用方法

`POST /api/sent-message-websocket/system-notice`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendSysNoticeRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysNoticeRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 系统通知内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-websocket-system-announcement-sendinside-1"></a>

### POST /api/sent-message-websocket/system-announcement

- 分组：发送站内信通知接口(v1)
- 名称：发送系统公告接口
- OperationId：sendInside_1

#### 调用方法

`POST /api/sent-message-websocket/system-announcement`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendSysAnnouncementRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysAnnouncementRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 公告消息内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-websocket-function-callback-sendinside-2"></a>

### POST /api/sent-message-websocket/function-callback

- 分组：发送站内信通知接口(v1)
- 名称：发送功能回调接口
- OperationId：sendInside_2

#### 调用方法

`POST /api/sent-message-websocket/function-callback`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendFunctionCallbackRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendFunctionCallbackRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 否 | 消息业务对象 |  |
| date | string | 否 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-websocket-business-notice-sendinside-3"></a>

### POST /api/sent-message-websocket/business-notice

- 分组：发送站内信通知接口(v1)
- 名称：发送业务提醒接口
- OperationId：sendInside_3

#### 调用方法

`POST /api/sent-message-websocket/business-notice`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendBusinessNoticeRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendBusinessNoticeRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 否 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 是 | 消息业务对象 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-sms-verification-code-sendmessage"></a>

### POST /api/sent-message-sms/verification-code

- 分组：发送短信通知接口(v1)
- 名称：发送验证码短信消息接口
- OperationId：sendMessage

#### 调用方法

`POST /api/sent-message-sms/verification-code`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendVerificationCodeSmsRequest（com.leadwaycloud.message.notice.sms.adapter.dto.request.v1.SendVerificationCodeSmsRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| mobilePhone | string | 是 | 手机 | "13800000000" |
| redisKey | string | 是 | 验证码存放的redis key | "xxx:xxx:xxx:xxx:xxx" |
| validTime | integer(int32) | 是 | 验证码存放有效时间(秒) | 60 |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-email-verification-code-sendmessage-1"></a>

### POST /api/sent-message-email/verification-code

- 分组：发送邮件通知接口(V1)
- 名称：发送邮件验证码接口
- OperationId：sendMessage_1

#### 调用方法

`POST /api/sent-message-email/verification-code`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendVerificationCodeEmailRequest（com.leadwaycloud.message.notice.email.adapter.dto.request.v1.SendVerificationCodeEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| email | string | 是 | 邮箱 | "kunliang.zeng@leadwaycloud.com" |
| redisKey | string | 是 | 验证码存放的redis key | "xxx:xxx:xxx:xxx:xxx" |
| validTime | integer(int32) | 是 | 验证码存放有效时间(秒) | 60 |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-email-merchant-customize-sendmerchantcustomizeemail"></a>

### POST /api/sent-message-email/merchant-customize

- 分组：发送邮件通知接口(V1)
- 名称：发送商户自定义邮件接口
- OperationId：sendMerchantCustomizeEmail

#### 调用方法

`POST /api/sent-message-email/merchant-customize`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| attachments | query | 否 | string(binary)[] |  |  |

#### 请求体


- Content-Type：`multipart/form-data`
- 必填：否
- 类型：object

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| arg0 | SendCustomerEmailRequest | 是 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-sent-message-email-merchant-customize-backend-sendmerchantcustomizeemai"></a>

### POST /api/sent-message-email/merchant-customize-backend

- 分组：发送邮件通知接口(V1)
- 名称：发送商户自定义邮件接口-后端
- OperationId：sendMerchantCustomizeEmailBackend

#### 调用方法

`POST /api/sent-message-email/merchant-customize-backend`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendCustomerEmailForBackendRequest（com.leadwaycloud.message.notice.email.adapter.dto.request.v1.SendCustomerEmailForBackendRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| subject | string | 是 | 标题 | "xxx订货单" |
| content | string | 是 | 邮件内容 |  |
| sendName | string | 是 | 发件人别名 | "立威云科" |
| to | string[] | 是 | 收件人 | ["kunliang.zeng@leadwaycloud.com"] |
| cc | string[] | 否 | 抄送人 | ["kunliang.zeng@leadwaycloud.com"] |
| bcc | string[] | 否 | 密送人 | ["kunliang.zeng@leadwaycloud.com"] |
| html | boolean | 否 | 是否是html格式的邮件内容 | false |
| fileName | string | 否 | 文件名称 | "立威云科.pdf" |
| fileBase64 | string | 否 | fileBase64 | "立威云科" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-normal-task-task-handy-finish-handytaskfinish"></a>

### POST /api/normal-task/task/handy/finish

- 分组：普通任务管理
- 名称：任务快捷完成接口(关闭主任务以及主任务下面的子任务(状态变更&处理人写入))
- OperationId：handyTaskFinish

#### 调用方法

`POST /api/normal-task/task/handy/finish`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：TaskHandyFinishRequest（com.leadwaycloud.message.task.adapter.dto.request.TaskHandyFinishRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |
| principalId | integer(int64) | 是 | 任务处理人ID | 1 |
| processedNotice | boolean | 是 | 处理完成是否通知发起人 | false |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-normal-task-task-finish-taskfinish-1"></a>

### POST /api/normal-task/task/finish

- 分组：普通任务管理
- 名称：主任务完成接口(关闭主任务以及主任务下面的子任务(状态变更))
- OperationId：taskFinish_1

#### 调用方法

`POST /api/normal-task/task/finish`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：TaskFinishRequest（com.leadwaycloud.message.task.adapter.dto.request.TaskFinishRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-normal-task-sub-task-reassignment-subtaskreassignment"></a>

### POST /api/normal-task/sub-task/reassignment

- 分组：普通任务管理
- 名称：子任务改派接口
- OperationId：subTaskReassignment

#### 调用方法

`POST /api/normal-task/sub-task/reassignment`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SubTaskReassignmentRequest（com.leadwaycloud.message.task.adapter.dto.request.SubTaskReassignmentRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_) | "Activity_1l676zu" |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-normal-task-sub-task-finish-subtaskfinish"></a>

### POST /api/normal-task/sub-task/finish

- 分组：普通任务管理
- 名称：子任务完成接口(仅关闭该子任务)
- OperationId：subTaskFinish

#### 调用方法

`POST /api/normal-task/sub-task/finish`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SubTaskFinishRequest（com.leadwaycloud.message.task.adapter.dto.request.SubTaskFinishRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_) | "Activity_1l676zu" |
| principalId | integer(int64) | 是 | 任务处理人ID(如果不是第一次发起任务创建则必须提供) | 1 |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |
| processedNotice | boolean | 是 | 处理完成是否通知发起人 | false |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-normal-task-publish-task-publishworkflowtask"></a>

### POST /api/normal-task/publish-task

- 分组：普通任务管理
- 名称：发布任务接口
- OperationId：publishWorkflowTask

#### 调用方法

`POST /api/normal-task/publish-task`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：PublishNormalTaskRequest（com.leadwaycloud.message.task.adapter.dto.request.PublishNormalTaskRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessType | string | 否 | 业务类型 |  |
| businessId | integer(int64) | 否 | 业户数据ID |  |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_, 普通任务传UUID) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_, 普通任务传UUID) | "Activity_1l676zu" |
| name | string | 是 | 名称 | "审核任务" |
| type | string | 是 | 子任务类型  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】 | "TASK_VERIFY" |
| initiatorId | integer(int64) | 是 | 发起人ID | 1 |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |
| businessData | object | 是 | 任务业务数据 | {"id":1,"type":"inventory","code":"AD2021062100011","name":"xxx 盘点单"} |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| messageData | BusinessNoticeRequest | 是 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgSubTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-sms-sendsms"></a>

### POST /api/message/send-sms

- 分组：发送短信通知接口(v2)
- 名称：发送短信接口
- OperationId：sendSMS

#### 调用方法

`POST /api/message/send-sms`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendSMSRequest（com.leadwaycloud.message.notice.sms.adapter.dto.request.v2.SendSMSRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| businessType | string | 是 | 业务类型  【 CAPTCHA : 验证码   MALL_USER_REGISTER_CAPTCHA : 商城用户注册验证码   MALL_USER_LOGIN_CAPTCHA : 商城用户登陆验证码   MALL_USER_PASSWORD_RESET_CAPTCHA : 商城用户密码重置验证码   MALL_USER_DESTORY_CAPTCHA : 商城用户注销验证码   MALL_USER_UNBIND_COMPANY_CAPTCHA : 商城用户与企业解绑验证码   MALL_USER_CHANGE_PHONE_CAPTCHA : 商城用户变更手机号验证码   MALL_USER_REGISTER_SUCCESS_CAPTCHA : 商城用户注册成功通知   MALL_COMPANY_AUTHENTICATION_SUCCESS_CAPTCHA : 商城企业认证成功通知   】 | "CAPTCHA" |
| mobilePhoneList | string[] | 是 | 需要发送短信的手机号 | [] |
| paramMap | object | 否 | 业务类型发送短信需要提供的参数 | {} |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-inside-system-notice-sendinside-4"></a>

### POST /api/message/send-inside/system-notice

- 分组：发送站内信通知接口(v2)
- 名称：发送系统通知接口
- OperationId：sendInside_4

#### 调用方法

`POST /api/message/send-inside/system-notice`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendSysNoticeRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysNoticeRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 系统通知内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-inside-function-callback-sendinside-5"></a>

### POST /api/message/send-inside/function-callback

- 分组：发送站内信通知接口(v2)
- 名称：发送功能回调消息接口
- OperationId：sendInside_5

#### 调用方法

`POST /api/message/send-inside/function-callback`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendFunctionCallbackRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendFunctionCallbackRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 否 | 消息业务对象 |  |
| date | string | 否 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-inside-business-notice-sendinside-6"></a>

### POST /api/message/send-inside/business-notice

- 分组：发送站内信通知接口(v2)
- 名称：发送业务提醒接口
- OperationId：sendInside_6

#### 调用方法

`POST /api/message/send-inside/business-notice`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendBusinessNoticeRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendBusinessNoticeRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 否 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 是 | 消息业务对象 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-inside-announcement-sendinside-7"></a>

### POST /api/message/send-inside/announcement

- 分组：发送站内信通知接口(v2)
- 名称：发送系统公告接口
- OperationId：sendInside_7

#### 调用方法

`POST /api/message/send-inside/announcement`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendSysAnnouncementRequest（com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysAnnouncementRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 公告消息内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-email-sendemail"></a>

### POST /api/message/send-email

- 分组：发送邮件通知接口(V2)
- 名称：发送模版邮件接口
- OperationId：sendEmail

#### 调用方法

`POST /api/message/send-email`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendTemplateEmailRequest（com.leadwaycloud.message.notice.email.adapter.dto.request.v2.SendTemplateEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| businessType | string | 是 | 邮件业务类型  【 CAPTCHA : 立威云科Email验证码   】 | "CAPTCHA" |
| toEmailList | string[] | 是 | 收件人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| ccEmailList | string[] | 否 | 抄送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| bccEmailList | string[] | 否 | 密送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| paramJsonMap | object | 否 | 业务类型发送需要提供的参数 | {"code":"123456"} |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-customer-email-sendemail-1"></a>

### POST /api/message/send-customer-email

- 分组：发送邮件通知接口(V2)
- 名称：发送自定义邮件接口
- OperationId：sendEmail_1

#### 调用方法

`POST /api/message/send-customer-email`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendCustomerEmailRequest（com.leadwaycloud.message.notice.email.adapter.dto.request.v2.SendCustomerEmailRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| subject | string | 是 | 标题 |  |
| emailContent | string | 是 | 邮件内容 |  |
| toEmailList | string[] | 是 | 收件人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| ccEmailList | string[] | 否 | 抄送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| bccEmailList | string[] | 否 | 密送人邮箱 | ["kunliang.zeng@leadwaycloud"] |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-message-send-customer-email-attachment-sendemail-2"></a>

### POST /api/message/send-customer-email-attachment

- 分组：发送邮件通知接口(V2)
- 名称：发送自定义邮件(带附件)接口
- OperationId：sendEmail_2

#### 调用方法

`POST /api/message/send-customer-email-attachment`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| merchantId | query | 是 | integer(int64) | 商户ID | 1 |
| subject | query | 是 | string | 邮件标题 |  |
| emailContent | query | 是 | string | 邮件内容 |  |
| toEmail | query | 是 | string | 收件人邮箱(json字符串[String]) | ["kunliang.zeng@leadwaycloud"] |
| ccEmail | query | 否 | string | 抄送人邮箱(json字符串[String]) | ["kunliang.zeng@leadwaycloud"] |
| bccEmail | query | 否 | string | 密送人邮箱(json字符串[String]) | ["kunliang.zeng@leadwaycloud"] |
| attachments | query | 是 | string(binary) | 附件 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-send-template-message-sendimtemplatemessage"></a>

### POST /api/im/message/send/template-message

- 分组：IM消息命令(v1)
- 名称：发送即时通讯模版消息接口
- OperationId：sendIMTemplateMessage

#### 调用方法

`POST /api/im/message/send/template-message`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendTemplateMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendTemplateMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| imMsgTemplateCode | string | 是 | 模版消息唯一键(从sys_properties中取IM_MSG_TEMPLATE_CODE组) | "0454cb83a79b477db32570eb58bbc5bb" |
| paramMap | object | 是 | 消息参数 |  |
| receiveList | integer(int64) | 是 | 接收人列表(用户ID) |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-send-message-sendimmessage"></a>

### POST /api/im/message/send/message

- 分组：IM消息命令(v1)
- 名称：发送点对点消息接口
- OperationId：sendIMMessage

#### 调用方法

`POST /api/im/message/send/message`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendP2PMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendP2PMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID | 1 |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| receiver | integer(int64) | 是 | 接收人(用户ID) | 600412495355845 |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| isSystem | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-send-group-message-sendimgroupmessage"></a>

### POST /api/im/message/send/group-message

- 分组：IM消息命令(v1)
- 名称：发送即时通讯群组消息接口
- OperationId：sendIMGroupMessage

#### 调用方法

`POST /api/im/message/send/group-message`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：SendGroupMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.SendGroupMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| groupId | integer(int64) | 是 | 群组ID | 1 |
| memberList | integer(int64)[] | 否 | 接收的群组成员,全部成员可不传(用户ID) | [1] |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-forward-message-forwardmessage"></a>

### POST /api/im/message/forward/message

- 分组：IM消息命令(v1)
- 名称：转发消息接口(模版消息不可以转发)
- OperationId：forwardMessage

#### 调用方法

`POST /api/im/message/forward/message`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ForwardMsgRequest（com.leadwaycloud.message.im.message.adapter.dto.request.ForwardMsgRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| messageList | integer(int64)[] | 是 | 消息列表 | [1] |
| mergeForward | boolean | 否 | 是否合并转发 | false |
| receiverList | integer(int64)[] | 否 | 接收人列表(用户ID) | [600412495355845] |
| groupList | integer(int64)[] | 否 | 群组列表(群组ID) | [1] |
| leaveMessage | string | 否 | 留言 | "xxx" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-im-message-query-un-read-last-message-querylastunreadmessage"></a>

### POST /api/im/message/query/un-read-last-message

- 分组：IM消息查询
- 名称：查询用户所有会话最后一条未读消息接口(已经按照时间进行倒序组装数据)
- OperationId：queryLastUnReadMessage

#### 调用方法

`POST /api/im/message/query/un-read-last-message`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：QueryUnReadMessageCount（com.leadwaycloud.message.im.message.application.query.QueryUnReadMessageCount）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pointTime | string | 是 | 小于指定时间点的未读消息条数 | "2024-07-11 10:09:11.222" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：LastUnReadMessageResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.LastUnReadMessageResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LastUnReadMessageResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-findpage"></a>

### GET /api/im/message/query

- 分组：IM消息查询
- 名称：查询消息(分页)接口
- OperationId：findPage

#### 调用方法

`GET /api/im/message/query`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| groupId | query | 否 | long | 群组ID(查询群组消息) |  |
| userId | query | 否 | long | 用户ID(查询用户消息) |  |
| template | query | 否 | boolean | 模版消息 |  |
| type | query | 否 | string | 类型(未提供内容则查询全部) TEXT:文本 FILE:文件 IMG:图片 VIDEO:视频 | "TEXT" |
| txt | query | 否 | string | 查询内容(查询content类容) | "你" |
| read | query | 否 | boolean | 是否已读 | false |
| sortMsgByTimeline | query | 否 | boolean | 是否根据时间线排序 | false |
| pointDate | query | 否 | string | 指定日期的消息 | "2024-07-11" |
| loeTime | query | 否 | string | 小于等于指定时间点的消息 | "2024-07-11 10:09:11.222" |
| goeTime | query | 否 | string | 大于等于指定时间点的消息 | "2024-07-11 10:09:11.222" |
| system | query | 否 | boolean | 是否系统消息 | false |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-id-querymessage"></a>

### GET /api/im/message/query/{id}

- 分组：IM消息查询
- 名称：查询消息(ID)接口
- OperationId：queryMessage

#### 调用方法

`GET /api/im/message/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-useful-expression-deleteusefulexpression"></a>

### GET /api/im/message/query/useful-expression

- 分组：IM消息查询
- 名称：查询常用语接口
- OperationId：deleteUsefulExpression

#### 调用方法

`GET /api/im/message/query/useful-expression`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UsefulExpressionResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UsefulExpressionResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-read-info-id-querymessagereadinfo"></a>

### GET /api/im/message/query/read-info/{id}

- 分组：IM消息查询
- 名称：查询消息已读记录接口
- OperationId：queryMessageReadInfo

#### 调用方法

`GET /api/im/message/query/read-info/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MessageReadInfoResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.MessageReadInfoResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MessageReadInfoResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-message-read-mark-querymessagereadmark"></a>

### GET /api/im/message/query/message/read-mark

- 分组：IM消息查询
- 名称：消息已读标记查询接口
- OperationId：queryMessageReadMark

#### 调用方法

`GET /api/im/message/query/message/read-mark`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| groupId | query | 否 | long | 群组ID(二选一,只标记群组消息全部已读) |  |
| userId | query | 否 | long | 用户ID(二选一,只标记此用户一对一消息全部已读) | 593997290568452 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：String（com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.String）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-list-querymessage-1"></a>

### GET /api/im/message/query/list

- 分组：IM消息查询
- 名称：查询消息(列表)接口
- OperationId：queryMessage_1

#### 调用方法

`GET /api/im/message/query/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| messageList | query | 是 | integer(int64)[] |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-collect-querycollectmessage"></a>

### GET /api/im/message/query/collect

- 分组：IM消息查询
- 名称：查询标签下的消息收藏接口
- OperationId：queryCollectMessage

#### 调用方法

`GET /api/im/message/query/collect`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tag | query | 否 | string | 标签 | "你" |
| txt | query | 否 | string | 查询内容(查询content类容) | "你" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：CollectMsgResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.CollectMsgResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CollectMsgResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-message-query-collect-tag-querycollectmessagetag"></a>

### GET /api/im/message/query/collect-tag

- 分组：IM消息查询
- 名称：查询消息收藏标签接口
- OperationId：queryCollectMessageTag

#### 调用方法

`GET /api/im/message/query/collect-tag`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：String（com.leadwaycloud.core.model.RJava.util.ListJava.lang.String）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-goods-wrokflow-callback-callback-1"></a>

### POST /api/goods/wrokflow/callback

- 分组：IM审核接口
- 名称：Workflow任务回调
- OperationId：callback_1

#### 调用方法

`POST /api/goods/wrokflow/callback`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：WorkflowCallBackRequest（com.leadwaycloud.message.system.support.adapter.dto.request.WorkflowCallBackRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID |  |
| submitBy | string | 否 | 当前 审批人/操作人 |  |
| businessTypeKey | string | 是 | 业务唯一key |  |
| businessId | string | 是 | 业务ID |  |
| taskId | string | 否 | 节点实例任务ID |  |
| serviceName | string | 否 | 回调服务名 |  |
| function | string | 是 | 具体执行方法（自定义配置，可缺省） |  |
| businessData | object | 否 | 业务数据（发起时业务、审批中特有变量 并集） |  |
| instanceState | string | 是 | 实例状态（pass, reject, terminate） |  |
| terminationRemark | string | 否 | 消息 |  |
| body | object | 否 | 自定义配置数据 |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-goods-verify-verifyorder"></a>

### POST /api/goods/verify

- 分组：IM审核接口
- 名称：消息审核接口
- OperationId：verifyOrder

#### 调用方法

`POST /api/goods/verify`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ImVerifyRequest（com.leadwaycloud.message.im.verify.adapter.dto.request.ImVerifyRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID | 1 |
| verifyType | string | 是 | 审核类别  【 BULLETIN : 公告发布审批   】  【 BULLETIN : 公告发布审批   】 | "BARCODE_ON_SHELF" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Boolean（com.leadwaycloud.core.model.RJava.lang.Boolean）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-goods-verify-result-hand-enter-verifyresulthandenter"></a>

### POST /api/goods/verify/result-hand-enter

- 分组：IM审核接口
- 名称：审批结果手工录入
- OperationId：verifyResultHandEnter

#### 调用方法

`POST /api/goods/verify/result-hand-enter`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：ImVerifyResultRequest（com.leadwaycloud.message.im.verify.adapter.dto.request.ImVerifyResultRequest）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID | 1 |
| businessKey | string | 是 | 业务类型 | "xxx" |
| pass | boolean | 是 | 是否通过 | false |
| notice | string | 否 | 审核结果描述 | "xxx" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-common-query-file-queryfile"></a>

### POST /api/common/query/file

- 分组：公共接口管理
- 名称：查询查询文件接口
- OperationId：queryFile

#### 调用方法

`POST /api/common/query/file`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：QueryFile（com.leadwaycloud.message.system.support.adapter.dto.request.QueryFile）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 | "demo" |
| folderId | string | 否 | 文件夹ID(查询某个文件夹下含子文件夹的文件) | "1242797390784131" |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：List（com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.util.List）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-common-query-department-employee-user-querycompanyemployeeuser"></a>

### GET /api/common/query/department-employee-user

- 分组：公共接口管理
- 名称：查询部门员工用户接口
- OperationId：queryCompanyEmployeeUser

#### 调用方法

`GET /api/common/query/department-employee-user`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | query | 否 | integer(int64) | 公司ID | 574533689957252 |
| str | query | 否 | string | 账号/名称 | "xxx" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：DepartmentUserResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.adapter.dto.response.DepartmentUserResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DepartmentUserResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-common-get-platform-assistant-client-version-info-getplatformassistantcl"></a>

### GET /api/common/get/platform-assistant-client/version-info

- 分组：公共接口管理
- 名称：获取消息客户端版本信息接口
- OperationId：getPlatformAssistantClientVersionInfo

#### 调用方法

`GET /api/common/get/platform-assistant-client/version-info`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：PlatformAssistantClientVersion（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.adapter.dto.response.PlatformAssistantClientVersion）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PlatformAssistantClientVersion[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-common-download-platform-assistant-client-type-downloadplatformassistant"></a>

### GET /api/common/download/platform-assistant-client/{type}

- 分组：公共接口管理
- 名称：下载消息客户端(安装包)接口
- OperationId：downloadPlatformAssistantClient

#### 调用方法

`GET /api/common/download/platform-assistant-client/{type}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | path | 是 | string | 类型 WIN32:windows32位 WIN64:windows64位 MAC:苹果系统 | "WIN32" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK

无

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-common-download-mac-snipaste-downloadmacsnipaste"></a>

### GET /api/common/download/mac/snipaste

- 分组：公共接口管理
- 名称：下载Mac版截图工具接口
- OperationId：downloadMacSnipaste

#### 调用方法

`GET /api/common/download/mac/snipaste`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK

无

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-api-calendar-schedule-query-querycalendarschedule"></a>

### POST /api/calendar-schedule/query

- 分组：IM日历日程查询
- 名称：查询日历日程接口
- OperationId：queryCalendarSchedule

#### 调用方法

`POST /api/calendar-schedule/query`

#### 参数

无

#### 请求体


- Content-Type：`application/json`
- 必填：是
- 类型：QueryCalendarSchedule（com.leadwaycloud.message.oa.calendar.schedule.application.query.QueryCalendarSchedule）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| startDate | string | 是 | 开始日期(时间区间不能超过31天) | "2020-01-01" |
| endDate | string | 是 | 结束日期(时间区间不能超过31天) | "2020-12-30" |
| statusList | string | 否 | 状态  【 START : 启动   PAUSE : 暂停   CLOSE : 关闭   CANCEL : 取消   】 |  |
| typeList | string | 否 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 否 | 内容 |  |
| priority | integer(int32) | 否 | 优先级 | 0 |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：CalendarScheduleResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.calendar.schedule.adapter.dto.response.CalendarScheduleResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CalendarScheduleResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-id-query"></a>

### GET /api/task/query/{id}

- 分组：用户任务管理
- 名称：查询主任务(ID)接口
- OperationId：query

#### 调用方法

`GET /api/task/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 主任务ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-untreated-count-principalid-queryuntreatedcount"></a>

### GET /api/task/query/untreated-count/{principalId}

- 分组：用户任务管理
- 名称：查询用户未处理的任务条数接口
- OperationId：queryUntreatedCount

#### 调用方法

`GET /api/task/query/untreated-count/{principalId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| principalId | path | 是 | integer(int64) | 处理人ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-task-sub-task-id-querytasksubtasklist"></a>

### GET /api/task/query/task/sub-task/{id}

- 分组：用户任务管理
- 名称：查询主任务的子任务列表(主任务ID)接口
- OperationId：queryTaskSubTaskList

#### 调用方法

`GET /api/task/query/task/sub-task/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 主任务ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgSubTaskResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-sub-task-subtaskid-querysubtask"></a>

### GET /api/task/query/sub-task/{subTaskId}

- 分组：用户任务管理
- 名称：查询子任务(ID)接口
- OperationId：querySubTask

#### 调用方法

`GET /api/task/query/sub-task/{subTaskId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| subTaskId | path | 是 | integer(int64) | 子任务ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgSubTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-page-principal-principalid-query-1"></a>

### GET /api/task/query-page/principal/{principalId}

- 分组：用户任务管理
- 名称：查询需要用户处理的子任务(分页)接口
- OperationId：query_1

#### 调用方法

`GET /api/task/query-page/principal/{principalId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| principalId | path | 是 | integer(int64) | 处理人ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| taskId | query | 否 | long | 主任务ID | 1 |
| businessType | query | 否 | string | 业务类型 |  |
| name | query | 否 | string | 名称 | "审核任务" |
| type | query | 否 | string | 类型 | "TASK_VERIFY" |
| status | query | 否 | string | 状态 | "UNTREATED" |
| startTime | query | 否 | string | 开始时间 | "2020-10-11 13:09:11" |
| endTime | query | 否 | string | 结束时间 | "2020-10-11 13:09:11" |
| businessData | query | 否 | string | 业务数据 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgSubTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-task-query-page-initiator-initiatorid-query-2"></a>

### GET /api/task/query-page/initiator/{initiatorId}

- 分组：用户任务管理
- 名称：查询用户发起的主任务(分页)接口
- OperationId：query_2

#### 调用方法

`GET /api/task/query-page/initiator/{initiatorId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| initiatorId | path | 是 | integer(int64) | 发起人ID | 1 |
| page | query | 是 | integer(int32) | 查询页码 | 0 |
| size | query | 是 | integer(int32) | 查询页行数 | 10 |
| name | query | 否 | string | 名称 | "审核任务" |
| businessType | query | 否 | string | 业务类型 |  |
| businessCode | query | 否 | string | 业务编号(例:如果针对订单审核可以放入订单ID/编号) | "UUID" |
| status | query | 否 | string | 状态 | "PROCESSING" |
| startTime | query | 否 | string | 开始时间 | "2020-10-11 13:09:11" |
| endTime | query | 否 | string | 结束时间 | "2020-10-11 13:09:11" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgTaskResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgTaskResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-page-page"></a>

### GET /api/signet/page

- 分组：OA印章查询
- 名称：查询印章(分页)
- OperationId：page

#### 调用方法

`GET /api/signet/page`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| companyId | query | 否 | long | 公司ID |  |
| dataList | query | 否 | list | 印章ID列表 |  |
| nameOrCode | query | 否 | string | 名称/编号 |  |
| type | query | 否 | string | 类别 | "M" |
| status | query | 否 | string | 状态 | "ENABLE" |
| categoryId | query | 否 | long | 印章类型ID |  |
| inHouse | query | 否 | boolean | 是否在库 |  |
| saveDepartmentNameOrCode | query | 否 | string | 保管部门名称/编号 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-list-list"></a>

### GET /api/signet/list

- 分组：OA印章查询
- 名称：查询印章(列表)
- OperationId：list

#### 调用方法

`GET /api/signet/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| arg0 | query | 是 | QueryListSignet |  |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-get-id-get"></a>

### GET /api/signet/get/{id}

- 分组：OA印章查询
- 名称：查询印章(单个)
- OperationId：get

#### 调用方法

`GET /api/signet/get/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-pageuserecord-pageuserecord"></a>

### GET /api/signet/pageUseRecord

- 分组：OA印章使用记录查询
- 名称：查询使用记录(分页)
- OperationId：pageUseRecord

#### 调用方法

`GET /api/signet/pageUseRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| name | query | 否 | string | 名称 |  |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| status | query | 否 | string | 状态 | "VOID" |
| isRegister | query | 否 | boolean | 是否已登记 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetUseRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-listuserecord-listuserecord"></a>

### GET /api/signet/listUseRecord

- 分组：OA印章使用记录查询
- 名称：查询使用记录(列表)
- OperationId：listUseRecord

#### 调用方法

`GET /api/signet/listUseRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名称 |  |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| status | query | 否 | string | 状态 | "VOID" |
| isRegister | query | 否 | boolean | 是否已登记 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetUseRecordResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getuserecord-id-getuserecord"></a>

### GET /api/signet/getUseRecord/{id}

- 分组：OA印章使用记录查询
- 名称：查询使用记录(单个)
- OperationId：getUseRecord

#### 调用方法

`GET /api/signet/getUseRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 使用记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetUseRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-pagemakerecord-pagemakerecord"></a>

### GET /api/signet/pageMakeRecord

- 分组：OA印章制作记录查询
- 名称：查询制作记录(分页)
- OperationId：pageMakeRecord

#### 调用方法

`GET /api/signet/pageMakeRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| name | query | 否 | string | 名称 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| status | query | 否 | string | 状态 | "VOID" |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| signetCategoryId | query | 否 | long | 印章类型ID |  |
| approvalResult | query | 否 | boolean | 审批结果(审批通过:true 审批未通过:false) |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetMakeRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-listmakerecord-listmakerecord"></a>

### GET /api/signet/listMakeRecord

- 分组：OA印章制作记录查询
- 名称：查询制作记录(列表)
- OperationId：listMakeRecord

#### 调用方法

`GET /api/signet/listMakeRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名称 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| status | query | 否 | string | 状态 | "VOID" |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| signetCategoryId | query | 否 | long | 印章类型ID |  |
| approvalResult | query | 否 | boolean | 审批结果(审批通过:true 审批未通过:false) |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetMakeRecordResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getmakerecord-id-getmakerecord"></a>

### GET /api/signet/getMakeRecord/{id}

- 分组：OA印章制作记录查询
- 名称：查询制作记录(单个)
- OperationId：getMakeRecord

#### 调用方法

`GET /api/signet/getMakeRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 制作记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetMakeRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-pagelendoutrecord-pagelendoutrecord"></a>

### GET /api/signet/pageLendOutRecord

- 分组：OA印章外借记录查询
- 名称：查询外借记录(分页)
- OperationId：pageLendOutRecord

#### 调用方法

`GET /api/signet/pageLendOutRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| name | query | 否 | string | 名称 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| status | query | 否 | string | 状态 | "VOID" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetLendOutRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-listlendoutrecord-listlendoutrecord"></a>

### GET /api/signet/listLendOutRecord

- 分组：OA印章外借记录查询
- 名称：查询外借记录(列表)
- OperationId：listLendOutRecord

#### 调用方法

`GET /api/signet/listLendOutRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名称 |  |
| applyDepartmentNameOrCode | query | 否 | string | 申请部门名称/编号 |  |
| applyUser | query | 否 | string | 申请人名称/账号 |  |
| signetId | query | 否 | long | 印章ID |  |
| signetNameOrCode | query | 否 | string | 印章名称/编号 |  |
| status | query | 否 | string | 状态 | "VOID" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetLendOutRecordResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getlendoutrecord-id-getlendoutrecord"></a>

### GET /api/signet/getLendOutRecord/{id}

- 分组：OA印章外借记录查询
- 名称：查询外借记录(单个)
- OperationId：getLendOutRecord

#### 调用方法

`GET /api/signet/getLendOutRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 外借记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetLendOutRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-pagegrantreceiverecord-pagegrantreceiverecord"></a>

### GET /api/signet/pageGrantReceiveRecord

- 分组：OA印章交接记录查询
- 名称：查询交接记录(分页)
- OperationId：pageGrantReceiveRecord

#### 调用方法

`GET /api/signet/pageGrantReceiveRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| signetId | query | 是 | long | 印章 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetGrantReceiveRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-listgrantreceiverecord-listgrantreceiverecord"></a>

### GET /api/signet/listGrantReceiveRecord

- 分组：OA印章交接记录查询
- 名称：查询交接记录(列表)
- OperationId：listGrantReceiveRecord

#### 调用方法

`GET /api/signet/listGrantReceiveRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| signetId | query | 是 | long | 印章ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetGrantReceiveRecordResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getgrantreceiverecord-id-getgrantreceiverecord"></a>

### GET /api/signet/getGrantReceiveRecord/{id}

- 分组：OA印章交接记录查询
- 名称：查询交接记录(单个)
- OperationId：getGrantReceiveRecord

#### 调用方法

`GET /api/signet/getGrantReceiveRecord/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 交接记录ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetGrantReceiveRecordResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-listvoidrecord-listvoidrecord"></a>

### GET /api/signet/listVoidRecord

- 分组：OA印章作废查询
- 名称：查询作废记录(列表)
- OperationId：listVoidRecord

#### 调用方法

`GET /api/signet/listVoidRecord`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| signetId | query | 是 | long | 印章ID |  |
| type | query | 否 | string | 类型 | "M" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetVoidRecordResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetVoidRecordResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetVoidRecordResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getcategory-getcategory"></a>

### GET /api/signet/getCategory

- 分组：OA印章分类查询
- 名称：查询印章分类
- OperationId：getCategory

#### 调用方法

`GET /api/signet/getCategory`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 名称 |  |
| code | query | 否 | string | 名称 |  |
| useApproveForCompany | query | 否 | boolean | 用印是否需要公司审批 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetCategoryResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-signet-getcategory-id-getcategory-1"></a>

### GET /api/signet/getCategory/{id}

- 分组：OA印章分类查询
- 名称：查询印章分类
- OperationId：getCategory_1

#### 调用方法

`GET /api/signet/getCategory/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 印章分类ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：SignetCategoryResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-monitor-version-version"></a>

### GET /api/monitor/version

- 分组：服务监控管理
- 名称：获取服务版本信息
- OperationId：version

#### 调用方法

`GET /api/monitor/version`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Object（com.leadwaycloud.core.model.RJava.lang.Object）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-monitor-health-health"></a>

### GET /api/monitor/health

- 分组：服务监控管理
- 名称：心跳检查
- OperationId：health

#### 调用方法

`GET /api/monitor/health`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Object（com.leadwaycloud.core.model.RJava.lang.Object）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-query-id-query-3"></a>

### GET /api/message/query/{id}

- 分组：通知查询
- 名称：查询消息接口
- OperationId：query_3

#### 调用方法

`GET /api/message/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 消息ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgMessageResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgMessageResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-query-unread-count-clientkey-queryunreadcount"></a>

### GET /api/message/query/unread-count/{clientKey}

- 分组：通知查询
- 名称：查询客户端未读消息条数接口
- OperationId：queryUnreadCount

#### 调用方法

`GET /api/message/query/unread-count/{clientKey}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| clientKey | path | 是 | string | 客户端连接符 | "UUID" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-query-title-unread-count-clientkey-querytitleunreadcount"></a>

### GET /api/message/query/title-unread-count/{clientKey}

- 分组：通知查询
- 名称：查询客户端各个标题未读消息条数接口
- OperationId：queryTitleUnreadCount

#### 调用方法

`GET /api/message/query/title-unread-count/{clientKey}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| clientKey | path | 是 | string | 客户端连接符 | "UUID" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-query-business-notice-receive-user-list-businessid-querybusiness"></a>

### GET /api/message/query/business-notice/receive-user-list/{businessId}

- 分组：通知查询
- 名称：查询业务提醒消息接收人列表(列表)接口
- OperationId：queryBusinessNoticeReceiveUserList

#### 调用方法

`GET /api/message/query/business-notice/receive-user-list/{businessId}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| businessId | path | 是 | integer(int64) | 业务数据ID | 0 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UserDTO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.application.dto.UserDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UserDTO[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-query-page-query-4"></a>

### GET /api/message/query-page

- 分组：通知查询
- 名称：查询客户端消息(分页)接口
- OperationId：query_4

#### 调用方法

`GET /api/message/query-page`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| batch | query | 否 | string | 批次(发送消息时产生) | "UUID" |
| type | query | 否 | string | 消息类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | query | 否 | string | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| status | query | 否 | string | 状态  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| title | query | 否 | string | 标题 |  |
| clientKey | query | 否 | string | 客户端连接符 | "xxxID" |
| sentSuccess | query | 否 | boolean | 是否发送成功 |  |
| startTime | query | 否 | string | 开始时间 | "2020-10-11 13:09:11" |
| endTime | query | 否 | string | 结束时间 | "2020-10-11 13:09:11" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgMessageResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgMessageResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-page-query-template-findinsidetemplatepage"></a>

### GET /api/message/page-query/template

- 分组：通知模版
- 名称：查询站内信模版列表
- OperationId：findInsideTemplatePage

#### 调用方法

`GET /api/message/page-query/template`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 否 | int | 页码(从0开始) | 0 |
| size | query | 否 | int | 每页行数 | 20 |
| search | query | 否 | string | 查询串 | "merchantId==1;type==WEBSOCKET" |
| sort | query | 否 | string | 排序方式 | "createTime,desc" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：InsideTemplateResponse（com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | InsideTemplateResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-email-template-page-findemailtemplatepage"></a>

### GET /api/email/template/page

- 分组：通知模版
- 名称：查询邮件模版列表
- OperationId：findEmailTemplatePage

#### 调用方法

`GET /api/email/template/page`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| merchantId | query | 是 | long | 商户号ID | 1 |
| title | query | 否 | string | 标题 | 1 |
| status | query | 否 | string | 模版状态 | 1 |
| type | query | 否 | string | 模版类型 | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：EmailTemplateResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EmailTemplateResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-email-template-get-id-findemailtemplate"></a>

### GET /api/email/template/get/{id}

- 分组：通知模版
- 名称：查询邮件模版详情
- OperationId：findEmailTemplate

#### 调用方法

`GET /api/email/template/get/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件模版ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：EmailTemplateResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EmailTemplateResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-message-page-query-server-msgserverquery"></a>

### GET /api/message/page-query/server

- 分组：通知服务器
- 名称：查询消息服务器配置
- OperationId：msgServerQuery

#### 调用方法

`GET /api/message/page-query/server`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 否 | int | 页码(从0开始) | 0 |
| size | query | 否 | int | 每页行数 | 20 |
| search | query | 否 | string | 查询串 | "merchantId==1;type==WEBSOCKET" |
| sort | query | 否 | string | 排序方式 | "createTime,desc" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MsgServerResponse（com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgServerResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-id-querymeeting"></a>

### GET /api/meeting/query/{id}

- 分组：IM会议查询
- 名称：查询会议接口(单个)
- OperationId：queryMeeting

#### 调用方法

`GET /api/meeting/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-verify-meeting-room-apply-queryverifymeetingroomapply"></a>

### GET /api/meeting/query/verify-meeting-room-apply

- 分组：IM会议查询
- 名称：查询我审核的会议申请接口
- OperationId：queryVerifyMeetingRoomApply

#### 调用方法

`GET /api/meeting/query/verify-meeting-room-apply`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| meetingDate | query | 否 | string | 会议日期 | "2020-10-11" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-meeting-room-querymeetingroom"></a>

### GET /api/meeting/query/meeting-room

- 分组：IM会议查询
- 名称：查询会议室接口
- OperationId：queryMeetingRoom

#### 调用方法

`GET /api/meeting/query/meeting-room`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| companyId | query | 否 | long | 公司ID |  |
| name | query | 否 | string | 名称 |  |
| supportMeetingType | query | 否 | string | 支持会议类型 |  |
| manager | query | 否 | long | 第一责任人ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingRoomResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-meeting-room-id-querymeetingroom-1"></a>

### GET /api/meeting/query/meeting-room/{id}

- 分组：IM会议查询
- 名称：查询会议室接口
- OperationId：queryMeetingRoom_1

#### 调用方法

`GET /api/meeting/query/meeting-room/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议室ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingRoomResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-meeting-room-un-start-meeting-id-querymeetingroomunstartme"></a>

### GET /api/meeting/query/meeting-Room-Un-Start-Meeting/{id}

- 分组：IM会议查询
- 名称：查询会议室尚未开始的会议接口
- OperationId：queryMeetingRoomUnStartMeeting

#### 调用方法

`GET /api/meeting/query/meeting-Room-Un-Start-Meeting/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 会议ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-list-querymeeting-1"></a>

### GET /api/meeting/query/list

- 分组：IM会议查询
- 名称：查询会议接口(列表)
- OperationId：queryMeeting_1

#### 调用方法

`GET /api/meeting/query/list`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| companyId | query | 否 | long | 公司ID |  |
| meetingDate | query | 否 | string | 会议日期 | "2020-10-11" |
| meetingRoomId | query | 否 | long | 会议室ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-join-meeting-queryjoinmeeting"></a>

### GET /api/meeting/query/join-meeting

- 分组：IM会议查询
- 名称：查询我参与的会议接口
- OperationId：queryJoinMeeting

#### 调用方法

`GET /api/meeting/query/join-meeting`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| txt | query | 否 | string | 查询内容(主题/议程/会议室名称) |  |
| meetingRoomId | query | 否 | long | 会议室ID |  |
| meetingDate | query | 否 | string | 会议日期 | "2020-10-11" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-join-meeting-un-start-queryjoinmeetingunstart"></a>

### GET /api/meeting/query/join-meeting-un-start

- 分组：IM会议查询
- 名称：查询我参与的尚未开始的会议接口
- OperationId：queryJoinMeetingUnStart

#### 调用方法

`GET /api/meeting/query/join-meeting-un-start`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-meeting-query-commit-meeting-room-apply-querycommitmeetingroomapply"></a>

### GET /api/meeting/query/commit-meeting-room-apply

- 分组：IM会议查询
- 名称：查询我发起的会议申请接口
- OperationId：queryCommitMeetingRoomApply

#### 调用方法

`GET /api/meeting/query/commit-meeting-room-apply`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| meetingDate | query | 否 | string | 会议日期 | "2020-10-11" |
| meetingRoomId | query | 否 | long | 会议室ID |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：MeetingResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-group-query-querygroup"></a>

### GET /api/im/group/query

- 分组：IM消息群组查询
- 名称：查询群组列表接口
- OperationId：queryGroup

#### 调用方法

`GET /api/im/group/query`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 否 | string | 群组名称 |  |
| owner | query | 否 | long | 群主 |  |
| member | query | 否 | long | 成员 |  |
| status | query | 否 | string | 状态 | "OPEN" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ImGroupResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-group-query-id-querygroup-1"></a>

### GET /api/im/group/query/{id}

- 分组：IM消息群组查询
- 名称：查询群组详情接口
- OperationId：queryGroup_1

#### 调用方法

`GET /api/im/group/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ImGroupResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-group-query-user-id-querygroupuser"></a>

### GET /api/im/group/query/user/{id}

- 分组：IM消息群组查询
- 名称：查询群组用户接口
- OperationId：queryGroupUser

#### 调用方法

`GET /api/im/group/query/user/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UserDTO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.application.dto.UserDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UserDTO[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-group-query-member-id-querygroupmember"></a>

### GET /api/im/group/query/member/{id}

- 分组：IM消息群组查询
- 名称：查询群组成员接口
- OperationId：queryGroupMember

#### 调用方法

`GET /api/im/group/query/member/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 群组ID | 1 |
| name | query | 否 | string | 用户名称/账号 |  |
| role | query | 否 | string | 角色 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：ImGroupMemberResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupMemberResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupMemberResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-queryemail"></a>

### GET /api/im/email/query

- 分组：IM邮件查询
- 名称：查询邮件接口
- OperationId：queryEmail

#### 调用方法

`GET /api/im/email/query`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| type | query | 是 | string | 类型 | "DRAFT" |
| sendDate | query | 否 | string | 发送日 | "2020-10-11" |
| str | query | 否 | string | 内容(发件人/主题/内容) | "xxx" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：P（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.P）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | P | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-id-queryemail-1"></a>

### GET /api/im/email/query/{id}

- 分组：IM邮件查询
- 名称：查询邮件接口
- OperationId：queryEmail_1

#### 调用方法

`GET /api/im/email/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMEmailResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-user-queryuser"></a>

### GET /api/im/email/query/user

- 分组：IM邮件查询
- 名称：查询用户接口
- OperationId：queryUser

#### 调用方法

`GET /api/im/email/query/user`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| name | query | 是 | string | 用户名称 | "张三" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：UserDTO（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.application.dto.UserDTO）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UserDTO[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-un-read-count-type-queryunreademailcount"></a>

### GET /api/im/email/query/un-read-count/{type}

- 分组：IM邮件查询
- 名称：查询未读邮件条数接口
- OperationId：queryUnReadEmailCount

#### 调用方法

`GET /api/im/email/query/un-read-count/{type}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| type | path | 是 | string | 类型(RECEIVE:已接收 DELETE:已删除) | "RECEIVE" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-read-info-id-querymessagereadinfo-1"></a>

### GET /api/im/email/query/read-info/{id}

- 分组：IM邮件查询
- 名称：查询邮件已读记录接口
- OperationId：queryMessageReadInfo_1

#### 调用方法

`GET /api/im/email/query/read-info/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 邮件ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMEmailReadResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailReadResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailReadResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-collect-querycollectmessage-1"></a>

### GET /api/im/email/query/collect

- 分组：IM邮件查询
- 名称：查询邮件收藏接口
- OperationId：queryCollectMessage_1

#### 调用方法

`GET /api/im/email/query/collect`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| tag | query | 否 | string | 标签 | "你" |
| txt | query | 否 | string | 查询内容(查询content类容) | "你" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMCollectEmailResponse（com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.email.adapter.dto.response.IMCollectEmailResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMCollectEmailResponse[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-email-query-collect-tag-querycollectmessagetag-1"></a>

### GET /api/im/email/query/collect-tag

- 分组：IM邮件查询
- 名称：查询邮件收藏标签接口
- OperationId：queryCollectMessageTag_1

#### 调用方法

`GET /api/im/email/query/collect-tag`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：String（com.leadwaycloud.core.model.RJava.util.ListJava.lang.String）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string[] | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-bulletin-query-querybulletin"></a>

### GET /api/im/bulletin/query

- 分组：IM公告查询
- 名称：查询公告接口
- OperationId：queryBulletin

#### 调用方法

`GET /api/im/bulletin/query`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| merchantId | query | 是 | long | 商户ID | 1 |
| status | query | 是 | string | 状态 |  |
| subject | query | 否 | string | 标题 |  |
| pushType | query | 否 | string | 投放类型 | "MERCHANT" |
| type | query | 否 | string | 公告类型(从sys_properties中取MSG_BULLETIN组) |  |
| keyword | query | 否 | string | 关键字 |  |
| startDate | query | 否 | string | 开始日期 | "2020-10-10" |
| endDate | query | 否 | string | 结束日期 | "2020-10-10" |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBulletinResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-bulletin-query-id-querybulletin-1"></a>

### GET /api/im/bulletin/query/{id}

- 分组：IM公告查询
- 名称：查询公告接口
- OperationId：queryBulletin_1

#### 调用方法

`GET /api/im/bulletin/query/{id}`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| id | path | 是 | integer(int64) | 公告ID | 1 |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBulletinResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-im-bulletin-query-published-querypushedbulletin"></a>

### GET /api/im/bulletin/query-published

- 分组：IM公告查询
- 名称：查询已发布的公告接口
- OperationId：queryPushedBulletin

#### 调用方法

`GET /api/im/bulletin/query-published`

#### 参数

| 名称 | 位置 | 必填 | 类型 | 说明 | 示例 |
| --- | --- | --- | --- | --- | --- |
| page | query | 是 | int | 页码(从0开始) | 0 |
| size | query | 是 | int | 每页行数 | 20 |
| merchantId | query | 是 | long | 商户ID | 1 |
| subject | query | 否 | string | 标题 |  |
| pushType | query | 否 | string | 投放类型 |  |
| type | query | 否 | string | 公告类型(从sys_properties中取MSG_BULLETIN组) |  |
| keyword | query | 否 | string | 关键字 |  |

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：IMBulletinResponse（com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-api-common-query-im-unread-msg-count-queryimunreadmsgcount"></a>

### GET /api/common/query/im-unread-msg-count

- 分组：IM管理接口
- 名称：查询及时通讯未读信息条数(消息、邮件、公告)接口
- OperationId：queryIMUnReadMsgCount

#### 调用方法

`GET /api/common/query/im-unread-msg-count`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：Long（com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Long）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`401`
- 说明：Unauthorized
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="get-error-handleerror"></a>

### GET /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError

#### 调用方法

`GET /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="post-error-handleerror-1"></a>

### POST /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_1

#### 调用方法

`POST /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="put-error-handleerror-2"></a>

### PUT /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_2

#### 调用方法

`PUT /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="delete-error-handleerror-3"></a>

### DELETE /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_3

#### 调用方法

`DELETE /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="patch-error-handleerror-4"></a>

### PATCH /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_4

#### 调用方法

`PATCH /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="options-error-handleerror-6"></a>

### OPTIONS /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_6

#### 调用方法

`OPTIONS /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

<a id="head-error-handleerror-5"></a>

### HEAD /error

- 分组：main-site-error-handler
- 名称：-
- OperationId：handleError_5

#### 调用方法

`HEAD /error`

#### 参数

无

#### 请求体

无

#### 响应


- 状态码：`200`
- 说明：OK
- Content-Type：`*/*`
- 类型：R（com.leadwaycloud.core.model.R）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`400`
- 说明：Bad Request
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`404`
- 说明：Not Found
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`409`
- 说明：Conflict
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`500`
- 说明：Internal Server Error
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

- 状态码：`501`
- 说明：Not Implemented
- Content-Type：`*/*`
- 类型：Void（com.leadwaycloud.core.model.RJava.lang.Void）

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |


## 模型定义

### com.leadwaycloud.core.model.RJava.lang.Void

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetAttachmentInfoDTO

附件列表

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 文件名称 | "xx" |
| type | string | 是 | 文件类型 | "xx" |
| fileId | string | 是 | 文件服务的文件ID | "xxx" |
| userId | integer(int64) | 否 | 上传的用户ID | 1 |
| userName | string | 否 | 上传的用户名称 | "1" |
| uploadTime | string | 否 | 上传时间 | "2020-10-11 13:09:11" |
| signetList | SignetAttachmentInfoDTO$UseSignetDTO[] | 是 | 印章 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetAttachmentInfoDTO$UseSignetDTO

印章

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | string | 是 | 印章ID |  |
| name | string | 是 | 印章名称 |  |
| useCount | integer(int32) | 是 | 用印份数 |  |
| register | integer(int64) | 否 | 登记人 |  |
| registerName | string | 否 | 登记人名称 |  |
| registeTime | string | 否 | 登记时间 | "2025-02-01 11:20:12" |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetUseRecordRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| useUserId | integer(int64) | 是 | 用印人ID |  |
| attachmentList | SignetAttachmentInfoDTO[] | 是 | 附件列表 |  |
| useDate | string | 是 | 用印日期 |  |
| useCount | integer(int32) | 是 | 用印份数 |  |
| reason | string | 是 | 理由 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 否 | 公司审批领导ID集合 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetBusinessResponse

印章业务

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| type | string | 是 | 类型  【 MAKE : 印章制作   GRANT_RECEIVE : 印章交接   LEND_OUT : 印章外借   USE : 印章使用   ENCASE : 印章封存   DESTROY : 印章封存/销毁   】  【 MAKE : 印章制作   GRANT_RECEIVE : 印章交接   LEND_OUT : 印章外借   USE : 印章使用   ENCASE : 印章封存   DESTROY : 印章封存/销毁   】 |  |
| businessId | integer(int64) | 是 | 业务ID |  |
| signetId | integer(int64) | 是 | 印章ID |  |
| signet | SignetResponse | 否 |  |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 | "2025-01-02 12:34:56" |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 | "2025-01-02 12:34:56" |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse

印章分类

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 名称 |  |
| parentId | integer(int64) | 否 | 父级分类 |  |
| idChain | string | 是 | 完整的组织结构 |  |
| active | boolean | 是 | 是否可用 |  |
| useApproveForCompany | boolean | 否 | 用印是否需要公司审批 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse

印章

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| image | string | 否 | 图片 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】  【 E : 电子印章   M : 实物章   】 |  |
| supportLendOut | string | 是 | 是否可外借 |  |
| inHouse | string | 是 | 是否在库 |  |
| status | string | 是 | 状态  【 DELETE : 删除   UN_ENABLE : 制作中   ENABLE : 启用   LOSE : 丢失   ENCASE : 封存   DESTROY : 销毁   】  【 DELETE : 删除   UN_ENABLE : 制作中   ENABLE : 启用   LOSE : 丢失   ENCASE : 封存   DESTROY : 销毁   】 |  |
| categoryId | integer(int64) | 否 | 类型ID |  |
| saveDepartmentId | integer(int64) | 否 | 保管部门ID |  |
| saveUserArray | integer(int64)[] | 否 | 保管人 |  |
| enableDate | string | 否 | 启用日期 | "2025-01-01" |
| loseDate | string | 否 | 丢失日期 | "2025-01-01" |
| encaseStartDate | string | 否 | 封存日期 | "2025-01-01" |
| encaseEndDate | string | 否 | 封存截止日期 | "2025-01-01" |
| destroyDate | string | 否 | 销毁日期 | "2025-01-01" |
| signetCategory | SignetCategoryResponse | 否 |  |  |
| saveDepartment | DepartmentResponse | 否 |  |  |
| saveUserStr | string | 否 | 保管人 |  |
| saveUserList | UserDTO[] | 否 | 保管人 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| name | string | 否 | 名称 |  |
| code | string | 是 | 编号 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门 |  |
| applyUserId | integer(int64) | 是 | 申请人 |  |
| applyDate | string | 否 | 申请日期 | "2025-01-01" |
| useUserId | integer(int64) | 是 | 用印人 |  |
| useDate | string | 否 | 用印日期 | "2025-01-01" |
| useCount | integer(int32) | 是 | 用印份数 |  |
| reason | string | 是 | 理由 |  |
| attachment | SignetAttachmentInfoDTO[] | 否 | 附件 |  |
| departmentManagerArray | integer(int64)[] | 是 | 业务部门审批领导 |  |
| companyManagerArray | integer(int64)[] | 否 | 公司审批领导 |  |
| status | string | 是 | 状态  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】 |  |
| registerStatus | string | 否 | 登记状态  【 NONE : 未登记   SOME : 部分登记   FULL : 已登记   】  【 NONE : 未登记   SOME : 部分登记   FULL : 已登记   】 |  |
| approvalResult | boolean | 否 | 审批结果(审批通过:true 审批未通过:false) |  |
| reviewer | string | 否 | 审核人 |  |
| applyDepartment | DepartmentResponse | 否 |  |  |
| applyUser | UserDTO | 否 |  |  |
| useUser | UserDTO | 否 |  |  |
| signetBusinessList | SignetBusinessResponse[] | 否 | 印章业务 |  |
| departmentManagerStr | string | 否 | 业务部门审批领导 |  |
| companyManagerStr | string | 否 | 公司审批领导 |  |
| departmentManagerList | UserDTO[] | 否 | 业务部门审批领导 |  |
| companyManagerList | UserDTO[] | 否 | 公司审批领导 |  |
| signCategoryNameStr | string | 否 | 印章分类名称及用印份数 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.system.support.adapter.dto.response.DepartmentResponse

保管部门

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| idChain | string | 是 | 完整的组织架构值 |  |

### com.leadwaycloud.message.system.support.application.dto.UserDTO

公司审批领导

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 用户ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 是 | 公司ID |  |
| userName | string | 是 | 账号 |  |
| name | string | 是 | 名称 |  |
| status | string | 是 | 状态  【 TO_BE_ACTIVE : 待激活的   ACTIVE : 活跃的   BLOCK : 锁定的   DELETE : 被删除的   INACTIVATED : 被禁用的   】  【 TO_BE_ACTIVE : 待激活的   ACTIVE : 活跃的   BLOCK : 锁定的   DELETE : 被删除的   INACTIVATED : 被禁用的   】 |  |
| language | string | 是 | 语言 |  |
| image | string | 否 | 图片 |  |
| partnerId | integer(int64) | 是 | 关联关系ID |  |
| sign | string | 否 | 签名 |  |
| contactId | string | 是 | 地址ID |  |
| contact | UserDTO$ContactDTO | 否 |  |  |
| idaasId | string | 否 | IDaas用户ID |  |
| externalCode | string | 否 | 外部编号 |  |

### com.leadwaycloud.message.system.support.application.dto.UserDTO$ContactDTO

地址

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| email | string | 是 | 邮箱 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.SignetMakeRecordRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 否 | 名称 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| makeDepartmentId | integer(int64) | 是 | 制作部门ID |  |
| operator | integer(int64) | 是 | 经办人ID |  |
| signetCategoryId | integer(int64) | 是 | 印章类型ID |  |
| signetName | string | 是 | 印章名称 |  |
| signetImage | string | 否 | 印章图片 |  |
| purpose | string | 否 | 用途 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

### com.leadwaycloud.message.system.support.application.dto.AttachmentInfoDTO

附件

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 文件名称 | "example.txt" |
| type | string | 是 | 文件类型 | "txt" |
| fileId | string | 是 | 文件ID | "1234567890" |
| userId | integer(int64) | 否 | 上传的用户ID | 1234567890 |
| userName | string | 否 | 上传的用户名称 | "JohnDoe" |
| uploadTime | string(date-time) | 否 | 上传时间 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| name | string | 否 | 名称 |  |
| code | string | 是 | 编号 |  |
| type | string | 是 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门 |  |
| applyUserId | integer(int64) | 是 | 申请人 |  |
| applyDate | string(date) | 是 | 申请日期 | "2025-01-02" |
| makeDepartmentId | integer(int64) | 是 | 制作部门 |  |
| operator | integer(int64) | 是 | 经办人 |  |
| signetCategoryId | integer(int64) | 是 | 印章类型 |  |
| signetName | string | 是 | 印章名称 |  |
| signetImage | string | 否 | 印章图片 |  |
| purpose | string | 否 | 用途 |  |
| reason | string | 否 | 理由 |  |
| attachment | AttachmentInfo[] | 否 | 附件 |  |
| departmentManagerArray | integer(int64)[] | 是 | 业务部门审批领导 |  |
| companyManagerArray | integer(int64)[] | 是 | 公司审批领导 |  |
| status | string | 是 | 状态  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】 |  |
| approvalResult | boolean | 否 | 审批结果(审批通过:true 审批未通过:false) |  |
| reviewer | string | 否 | 审核人 |  |
| signetId | integer(int64) | 否 | 印章ID |  |
| applyDepartment | DepartmentResponse | 否 |  |  |
| applyUser | UserDTO | 否 |  |  |
| makeDepartment | DepartmentResponse | 否 |  |  |
| signetCategory | SignetCategoryResponse | 否 |  |  |
| signet | SignetResponse | 否 |  |  |
| departmentManagerStr | string | 否 | 业务部门审批领导 |  |
| companyManagerStr | string | 否 | 公司审批领导 |  |
| departmentManagerList | UserDTO[] | 否 | 业务部门审批领导 |  |
| companyManagerList | UserDTO[] | 否 | 公司审批领导 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.system.support.domain.model.AttachmentInfo

附件

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 |  |  |
| type | string | 是 |  |  |
| fileId | string | 是 |  |  |
| userId | integer(int64) | 否 |  |  |
| userName | string | 否 |  |  |
| uploadTime | string(date-time) | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetLendOutRecordRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门ID |  |
| applyUserId | integer(int64) | 是 | 申请人ID |  |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| reason | string | 是 | 理由 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |
| useUserList | integer(int64) | 是 | 携带人ID集合 |  |
| startTime | string | 是 | 开始时间 | "2025-01-02 12:34:56" |
| endTime | string | 是 | 结束时间 | "2025-01-02 12:34:56" |
| departmentManagerList | integer(int64) | 是 | 业务部门审批领导ID集合 |  |
| companyManagerList | integer(int64) | 是 | 公司审批领导ID集合 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse

印章交接记录

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| name | string | 否 | 名称 |  |
| code | string | 是 | 编号 |  |
| type | string | 是 | 类型  【 LEND_OUT_GRANT : 外借发出   LEND_OUT_RECEIVE : 外借退回   RECEIVE : 领取   TAKE_BACK : 收回   OTHER : 其他   】  【 LEND_OUT_GRANT : 外借发出   LEND_OUT_RECEIVE : 外借退回   RECEIVE : 领取   TAKE_BACK : 收回   OTHER : 其他   】 |  |
| grantDepartmentId | string | 是 | 交印部门 |  |
| grantUserArray | integer(int64)[] | 是 | 交印人 |  |
| receiveDepartmentId | integer(int64) | 是 | 接印部门 |  |
| receiveUserArray | integer(int64)[] | 是 | 接印人 |  |
| supervisorArray | integer(int64)[] | 是 | 监督人 |  |
| businessId | integer(int64) | 否 | 业务ID |  |
| grantDepartment | DepartmentResponse | 否 |  |  |
| grantUserStr | string | 否 | 交印人 |  |
| receiveDepartment | DepartmentResponse | 否 |  |  |
| receiveUserStr | string | 否 | 接印人 |  |
| supervisorStr | string | 否 | 监督人 |  |
| signetBusinessList | SignetBusinessResponse[] | 否 | 印章业务 |  |
| supervisorList | UserDTO[] | 否 | 监督人 |  |
| grantUserList | ResUser[] | 否 | 交印人 |  |
| receiveUserList | ResUser[] | 否 | 接印人 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 | "2025-01-02 03:04:05" |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 | "2025-01-02 03:04:05" |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| name | string | 否 | 名称 |  |
| code | string | 是 | 编号 |  |
| applyDepartmentId | integer(int64) | 是 | 申请部门 |  |
| applyUserId | integer(int64) | 是 | 申请人 |  |
| applyDate | string | 否 | 申请日期 | "2024-01-01" |
| reason | string | 是 | 理由 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| useUserArray | integer(int64)[] | 否 | 携带人 |  |
| startTime | string | 否 | 开始时间 | "2024-01-01 00:00:00" |
| endTime | string | 否 | 结束时间 | "2024-01-01 00:00:00" |
| departmentManagerArray | integer(int64)[] | 否 | 业务部门审批领导 |  |
| companyManagerArray | integer(int64)[] | 否 | 公司审批领导 |  |
| status | string | 否 | 状态  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】  【 DELETE : 删除   DRAFT : 草稿   APPROVAL : 审批中   FINISH : 审批完成   】 |  |
| approvalResult | boolean | 否 | 审批结果(审批通过:true 审批未通过:false) |  |
| reviewer | string | 否 | 审核人 |  |
| back | boolean | 否 | 是否已经归还(未外借:null 已外借:false 已归还:true) |  |
| applyDepartment | DepartmentResponse | 否 |  |  |
| applyUser | UserDTO | 否 |  |  |
| useUserStr | string | 否 | 携带人 |  |
| signetBusinessList | SignetBusinessResponse[] | 否 | 印章业务 |  |
| signetGrantReceiveRecordList | SignetGrantReceiveRecordResponse[] | 否 | 印章交接记录 |  |
| departmentManagerStr | string | 否 | 业务部门审批领导 |  |
| companyManagerStr | string | 否 | 公司审批领导 |  |
| useUserList | UserDTO[] | 否 | 携带人 |  |
| departmentManagerList | UserDTO[] | 否 | 业务部门审批领导 |  |
| companyManagerList | UserDTO[] | 否 | 公司审批领导 |  |
| signCategoryNameStr | string | 否 | 印章分类名称 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 | "2024-01-01 00:00:00" |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 | "2024-01-01 00:00:00" |

### com.leadwaycloud.message.system.support.domain.entity.ResContact

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| email | string | 否 |  |  |

### com.leadwaycloud.message.system.support.domain.entity.ResUser

接印人

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 否 |  |  |
| merchantId | integer(int64) | 否 |  |  |
| companyId | integer(int64) | 否 |  |  |
| userName | string | 否 |  |  |
| name | string | 否 |  |  |
| status | string | 否 |   【 TO_BE_ACTIVE : 待激活的   ACTIVE : 活跃的   BLOCK : 锁定的   DELETE : 被删除的   INACTIVATED : 被禁用的   】 |  |
| language | string | 否 |  |  |
| image | string | 否 |  |  |
| partnerId | integer(int64) | 否 |  |  |
| sign | string | 否 |  |  |
| contactId | integer(int64) | 否 |  |  |
| contact | ResContact | 否 |  |  |
| idaasId | string | 否 |  |  |
| externalCode | string | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.UpdateSignetCategoryRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| parentId | integer(int64) | 否 | 父级分类ID |  |
| useApproveForCompany | boolean | 否 | 用印是否需要公司审批 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.UpdateSignetRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| image | string | 否 | 图片 |  |
| supportLendOut | boolean | 是 | 是否可外借 |  |
| inHouse | boolean | 是 | 是否在库 |  |
| categoryId | integer(int64) | 是 | 类型ID |  |
| saveDepartmentId | integer(int64) | 是 | 保管部门ID |  |
| saveUserList | integer(int64)[] | 是 | 保管人ID集合 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.lang.Boolean

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | boolean | 否 | 返回数据 |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.BatchOperationMsgRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| batch | string | 否 | 批次(发送消息时产生) | "UUID" |
| type | string | 否 | 消息类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 否 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| status | string | 否 | 消息状态  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| sentSuccess | boolean | 否 | 是否发送成功 |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateIInsideTemplateRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| config | string | 否 | 信息模版配置 | "{}" |
| subject | string | 否 | 主题 |  |
| template | string | 否 | 信息模版内容 | "<html>" |
| active | boolean | 否 | 是否启用 | true |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | InsideTemplateResponse | 否 |  |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| batch | string | 是 | 批次号(发送消息时产生) | "UUID" |
| type | string | 是 | 类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 是 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKey | string | 是 | 客户端连接符 | "xxxID" |
| status | string | 是 | 状态  【 UNREAD : 未读   HAVE_READ : 已读   】  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| title | string | 是 | 消息标题 |  |
| message | string | 是 | 消息内容 |  |
| messageData | string | 否 | 消息数据 |  |
| sentSuccess | boolean | 是 | 是否发送成功 | false |
| taskId | integer(int64) | 否 | 主任务ID | 1 |
| subTaskId | integer(int64) | 否 | 子任务ID | 1 |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| expireTime | string | 否 | 过期时间 | "2020-10-11 13:09:11" |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| readTime | string | 否 | 读取时间 | "2020-10-11 13:09:11" |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.notice.manager.adapter.dto.MsgServerConfigDTO

服务器配置

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| host | string | 是 | 服务地址 |  |
| port | string | 是 | 服务端口 |  |
| username | string | 是 | 账号 |  |
| password | string | 是 | 密码 |  |
| sendFrom | string | 是 | 发送者 |  |
| sendAsName | string | 是 | 发送者别名 |  |
| subject | string | 是 | 主题 |  |
| smtpAuth | boolean | 否 | 是否需要SMTP身份验证 |  |
| smtpSsl | boolean | 否 | 是否开启ssl |  |
| starttlsEnable | boolean | 否 | 是否允许使用STARTTLS命令 |  |
| starttlsRequired | boolean | 否 | 是否必须使用STARTTLS命令 |  |
| connectionTimeout | integer(int64) | 否 | 连接超时时间(毫秒) |  |
| timeout | integer(int64) | 否 | 读超时时间(毫秒) |  |
| writeTimeout | integer(int64) | 否 | 写超时时间(毫秒) |  |
| headerMessageKey | string | 否 | 消息头部key |  |
| headerMessageValuePrefix | string | 否 | 消息头部value值前缀 |  |
| headerMessageValueTimeFormat | string | 否 | 消息头部value值时间戳格式 |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateMsgServerRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| config | MsgServerConfigDTO | 是 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgServerResponse | 否 |  |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 否 | 公司ID |  |
| name | string | 是 | 服务配置名 | "MAILSERVER" |
| type | string | 是 | 服务类型(比如:EMAIL,SMS)  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEBSOCKET" |
| active | string | 是 | 是否启用 | "MAILSERVER" |
| config | MsgServerConfigDTO | 是 |  |  |
| createBy | integer(int64) | 否 | 创建人 | 1 |
| createTime | string(date-time) | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人 | 1 |
| updateTime | string(date-time) | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.UpdateMeetingRoomRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| image | string | 否 | 照片 |  |
| openStartTime | string | 是 | 开始时间 | "08:00:00" |
| openEndTime | string | 是 | 结束时间 | "18:30:00" |
| peopleCount | string | 是 | 容纳人数 |  |
| supportMeetingType | string[] | 是 | 支持会议类型(从sys_properties中取MEETING_TYPE组) |  |
| firstManager | integer(int64) | 是 | 第一责任人ID |  |
| secondManager | integer(int64) | 是 | 第二责任人ID |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse | 否 |  |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| image | string | 否 | 照片 |  |
| openStartTime | string | 是 | 开始时间 | "23:00:00" |
| openEndTime | string | 是 | 结束时间 | "23:00:00" |
| peopleCount | integer(int32) | 是 | 容纳人数 |  |
| supportMeetingType | string[] | 否 | 支持会议类型 |  |
| firstManager | integer(int64) | 是 | 第一责任人ID |  |
| secondManager | integer(int64) | 是 | 第二责任人ID |  |
| status | string | 是 | 状态  【 OPEN : 开放   CLOSE : 关闭   DELETE : 删除   】 |  |
| supportMeetingTypeStr | string | 是 | 支持会议类型 |  |
| firstManagerUser | UserDTO | 否 |  |  |
| secondManagerUser | UserDTO | 否 |  |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.UpdateMeetingRoomApplyRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型 |  |
| meetingDate | string | 否 | 会议日期 | "2024-07-02" |
| startTime | string | 否 | 开始时间 | "13:09:11" |
| endTime | string | 否 | 结束时间 | "13:09:11" |
| compere | integer(int64) | 是 | 主持人ID |  |
| subject | string | 是 | 主题 |  |
| agenda | string | 否 | 议程 |  |
| peopleCount | string | 是 | 预计人数 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| notes | string | 否 | 备注 |  |
| meetingRoomId | integer(int64) | 是 | 会议室ID |  |
| meetingMemberList | integer(int64)[] | 是 | 参会成员 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingMemberResponse

参会成员

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| meetingId | integer(int64) | 是 | 会议ID |  |
| userId | integer(int64) | 是 | 用户ID |  |
| join | boolean | 否 | 是否参与会议 |  |
| confirmTime | string | 否 | 确认时间 | "2024-01-01 12:00:00" |
| confirmMsg | string | 否 | 确认理由 |  |
| user | UserDTO | 否 |  |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| applicant | integer(int64) | 是 | 申请人ID |  |
| type | string | 是 | 会议类型 |  |
| meetingDate | string | 是 | 会议日期 | "2024-01-01" |
| startTime | string | 是 | 开始时间 | "10:00" |
| endTime | string | 是 | 结束时间 | "12:00" |
| compere | integer(int64) | 是 | 主持人ID |  |
| subject | string | 是 | 主题 |  |
| agenda | string | 否 | 议程 |  |
| peopleCount | integer(int32) | 是 | 预计人数 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| notes | string | 否 | 备注 |  |
| status | string | 是 | 状态  【 CANCEL : 取消   AUDIT : 待审核   REJECT : 未通过   PASS : 已通过   】 |  |
| meetingRoomId | integer(int64) | 是 | 会议室ID |  |
| reviewer | integer(int64) | 否 | 审核人ID |  |
| verifyMsg | string | 否 | 审核理由 |  |
| notice | boolean | 否 | 是否已经通知参会人员 |  |
| meetingMemberList | MeetingMemberResponse[] | 否 | 参会成员 |  |
| applicantUser | UserDTO | 否 |  |  |
| compereUser | UserDTO | 否 |  |  |
| meetingRoom | MeetingRoomResponse | 否 |  |  |
| reviewerUser | UserDTO | 否 |  |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.SortIMUsefulExpressionRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| usefulExpressionId | integer(int64) | 是 | 常用语ID |  |
| sortIndex | integer(int32) | 是 | 排序下标 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UsefulExpressionResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| userId | integer(int64) | 是 | 用户ID |  |
| content | string | 是 | 常用语内容 |  |
| sortIndex | integer(int32) | 是 | 排序下标 |  |
| createBy | integer(int64) | 否 | 创建人 | 1 |
| createTime | string(date-time) | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人 | 1 |
| updateTime | string(date-time) | 否 | 修改时间 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.RenameCollectTagRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |
| newName | string | 是 | 新标签 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.MessageReadMarkRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| groupId | integer(int64) | 否 | 群组ID(二选一,只标记群组消息全部已读) |  |
| userId | integer(int64) | 否 | 用户ID(二选一,只标记此用户一对一消息全部已读) | 593997290568452 |

### com.leadwaycloud.message.im.message.adapter.dto.request.DeleteCollectTagRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.UpdateIMGroupRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 群组名称 |  |
| owner | integer(int64) | 否 | 群主 |  |
| announcement | string | 否 | 群公告 |  |
| onlyManagerAddMember | boolean | 否 | 仅管理员添加成员 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.ImGroupMemberResponse

群组用户

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| groupId | integer(int64) | 是 | 群组ID |  |
| userId | integer(int64) | 是 | 用户ID |  |
| member | UserDTO | 是 |  |  |
| role | string | 是 | 角色  【 OWNER : 群主   MANAGER : 管理员   MEMBER : 成员   】  【 OWNER : 群主   MANAGER : 管理员   MEMBER : 成员   】 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| name | string | 是 | 群组名称 |  |
| owner | integer(int64) | 是 | 群主用户ID |  |
| ownerUser | UserDTO | 是 |  |  |
| announcement | string | 否 | 群公告 |  |
| status | string | 是 | 群状态  【 OPEN : 开放   DISMISS : 解散   】  【 OPEN : 开放   DISMISS : 解散   】 |  |
| onlyManagerAddMember | boolean | 否 | 仅管理员可添加成员 |  |
| groupMemberList | ImGroupMemberResponse[] | 否 | 群组用户 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessPrintResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessPrintResponse | 否 |  |  |

### com.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessPrintDetailResponse

接收人明细

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| submitUserId | integer(int64) | 是 | 接收人ID |  |
| sign | string | 否 | 接收人签名文件ID |  |
| submitUserName | string | 是 | 接收名称 |  |
| confirmContent | string | 否 | 确认内容 |  |
| confirmTime | string(date-time) | 否 | 确认时间 |  |

### com.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessPrintResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| code | string | 是 | 编号 |  |
| submitTime | string(date-time) | 是 | 发起时间 |  |
| lastConfirmTime | string(date-time) | 否 | 要求反馈时间 |  |
| submitUserId | integer(int64) | 是 | 发起人ID |  |
| submitUserName | string | 是 | 发起人名称 |  |
| departmentId | integer(int64) | 是 | 提出部门ID | 1 |
| departmentName | string | 是 | 提出部门名称 | "xxx" |
| approvalUserId | integer(int64) | 否 | 审核人ID | 1 |
| approvalUserName | string | 否 | 审核人名称 | "xxx" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试邮件消息" |
| detailList | IMBusinessPrintDetailResponse[] | 是 | 接收人明细 |  |

### com.leadwaycloud.message.im.bulletin.adapter.dto.request.IMBulletinRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pushTypeList | string | 否 | 投放类型(未提供则默认投放商户下所有用户)  【 MERCHANT : 系统用户   MEMBER : 商城用户   SUPPLIER : 供应商   】 | "[]" |
| type | string | 否 | 公告类型(从sys_properties中取MSG_BULLETIN组) |  |
| subject | string | 是 | 标题 |  |
| content | string | 是 | 内容 |  |
| pushStartTime | string | 否 | 公告发布时间 |  |
| pushEndTime | string | 否 | 公告发布终止时间 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

### com.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| senderUser | UserDTO | 否 |  |  |
| read | boolean | 否 | 是否已读(仅公告分页查询中有数据回传) |  |

### com.leadwaycloud.message.im.message.adapter.dto.ReserveConfigDTO

消息备用参数

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pointReceiver | integer(int64)[] | 否 | 重点通知的接收人(例如：@xxx) |  |
| revokeMessage | boolean | 否 | 是否属于撤回消息 |  |
| emailReceiveInfo | boolean | 否 | 邮件接收人信息(KEY-> COM:收件人 CC:抄送 BCC:密送) |  |
| businessReceiveInfo | boolean | 否 | 业务联系单接收人信息 |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.UpdateEmailTemplateRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| title | string | 否 | 标题 | "1" |
| status | string | 否 | 状态 | "1" |
| content | string | 否 | 内容 | "1" |
| ccRole | string | 否 | 抄送角色 | "11111111,2222222" |
| ccUser | string | 否 | 抄送用户ID集合 | "11111111,2222222" |
| addresseeUser | string | 否 | 收件用户ID集合 | "11111111,2222222" |
| notifySupplier | boolean | 否 | 通知供应商 | false |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.UpdateCalendarScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |
| type | string | 否 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 否 | 日程内容 |  |
| newScheduleConfig | string | 否 | 日程排程数据,需要像创建时一样的提供(如果有提供数据,之前任务的计划将被全部重置) |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PauseCalendarScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.CloseSystemScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| attachmentKey | string | 是 | 自定义数据key |  |
| userList | integer(int64)[] | 否 | 用户ID(未提供则关闭所有跟自定义数据key相关的日历日程) |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.CancelSystemScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| attachmentKey | string | 是 | 自定义数据key |  |
| userList | integer(int64)[] | 否 | 用户ID(未提供则取消所有跟自定义数据key相关的日历日程) |  |

### com.leadwaycloud.message.task.adapter.dto.request.TaskFinishRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.system.support.adapter.dto.request.WorkflowCallBackRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID |  |
| submitBy | string | 否 | 当前 审批人/操作人 |  |
| businessTypeKey | string | 是 | 业务唯一key |  |
| businessId | string | 是 | 业务ID |  |
| taskId | string | 否 | 节点实例任务ID |  |
| serviceName | string | 否 | 回调服务名 |  |
| function | string | 是 | 具体执行方法（自定义配置，可缺省） |  |
| businessData | object | 否 | 业务数据（发起时业务、审批中特有变量 并集） |  |
| instanceState | string | 是 | 实例状态（pass, reject, terminate） |  |
| terminationRemark | string | 否 | 消息 |  |
| body | object | 否 | 自定义配置数据 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| image | string | 否 | 图片 |  |
| type | string | 是 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| supportLendOut | boolean | 是 | 是否可外借 |  |
| inHouse | boolean | 是 | 是否在库 |  |
| categoryId | integer(int64) | 是 | 类型ID |  |
| saveDepartmentId | integer(int64) | 是 | 保管部门ID |  |
| saveUserList | integer(int64)[] | 是 | 保管人ID集合 |  |
| status | string | 否 | 状态  【 DELETE : 删除   UN_ENABLE : 制作中   ENABLE : 启用   LOSE : 丢失   ENCASE : 封存   DESTROY : 销毁   】 | "ENABLE" |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetVoidRecordRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| type | string | 是 | 类型  【 ENCASE : 封存   DESTROY : 销毁   】 | "ENCASE" |
| voidDate | string | 是 | 封存/销毁日期 |  |
| encaseEndDate | string | 否 | 封存截止日期(type=ENCASE时必须提供) |  |
| reason | string | 是 | 理由 |  |
| supervisorList | integer(int64)[] | 是 | 监督人ID集合 |  |
| attachmentList | AttachmentInfoDTO[] | 否 | 附件 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetVoidRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetVoidRecordResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.response.SignetVoidRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| type | string | 是 | 类型  【 ENCASE : 封存   DESTROY : 销毁   】  【 ENCASE : 封存   DESTROY : 销毁   】 |  |
| code | string | 是 | 编号 |  |
| voidDate | string | 是 | 封存/销毁日期 | "2025-01-01" |
| encaseEndDate | string | 否 | 封存截止日期 | "2025-01-01" |
| reason | string | 是 | 理由 |  |
| supervisorArray | integer(int64)[] | 是 | 监督人 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| supervisorStr | string | 否 | 监督人 |  |
| signetBusinessList | SignetBusinessResponse[] | 否 | 印章业务 |  |
| supervisorList | UserDTO[] | 否 | 监督人 |  |
| signCategoryNameStr | string | 否 | 印章分类名称 |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetGrantReceiveRecordRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 否 | 名称 |  |
| signetList | integer(int64)[] | 是 | 印章ID集合 |  |
| grantDepartmentId | integer(int64) | 是 | 发出部门ID |  |
| grantUserList | integer(int64) | 是 | 发出人ID集合(直接从印章保管人中提取) |  |
| receiveDepartmentId | integer(int64) | 是 | 接收部门ID |  |
| receiveUserList | integer(int64) | 是 | 接收人ID集合(外借发出时直接从外借申请携带人中提取,其他情况可自由选择) |  |
| supervisorList | integer(int64)[] | 是 | 监督人ID集合 |  |
| type | string | 是 | 类型  【 LEND_OUT_GRANT : 外借发出   LEND_OUT_RECEIVE : 外借退回   RECEIVE : 领取   TAKE_BACK : 收回   OTHER : 其他   】 | "RECEIVE" |
| businessId | integer(int64) | 否 | 业务ID(type=LEND_OUT_GRANT/LEND_OUT_RECEIVE时必须提供外借申请ID) |  |

### com.leadwaycloud.message.oa.signet.adapter.dto.request.AddSignetCategoryRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID |  |
| name | string | 是 | 名称 |  |
| code | string | 是 | 编号 |  |
| parentId | integer(int64) | 否 | 父级分类ID |  |
| useApproveForCompany | boolean | 否 | 用印是否需要公司审批 |  |

### com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysNoticeRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 系统通知内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.notice.inside.adapter.dto.request.SendSysAnnouncementRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 公告消息内容 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.notice.inside.adapter.dto.request.SendFunctionCallbackRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 否 | 消息业务对象 |  |
| date | string | 否 | 发布时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.notice.inside.adapter.dto.request.SendBusinessNoticeRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKeyList | string[] | 是 | 客户端连接符列表(clientKeyType可发送所有,则可通过*发送所有客户端) | ["*"] |
| expireTime | string | 否 | 过期时间(clientKeyType可发送所有,且通过*发送所有客户端时必须设置。其他情况会被忽略) | "2020-10-11 13:09:11" |
| businessId | integer(int64) | 否 | 业务数据ID |  |
| businessType | string | 否 | 业务类型 |  |
| title | string | 否 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 是 | 消息业务对象 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.notice.sms.adapter.dto.request.v1.SendVerificationCodeSmsRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| mobilePhone | string | 是 | 手机 | "13800000000" |
| redisKey | string | 是 | 验证码存放的redis key | "xxx:xxx:xxx:xxx:xxx" |
| validTime | integer(int32) | 是 | 验证码存放有效时间(秒) | 60 |

### com.leadwaycloud.message.notice.email.adapter.dto.request.v1.SendVerificationCodeEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| email | string | 是 | 邮箱 | "kunliang.zeng@leadwaycloud.com" |
| redisKey | string | 是 | 验证码存放的redis key | "xxx:xxx:xxx:xxx:xxx" |
| validTime | integer(int32) | 是 | 验证码存放有效时间(秒) | 60 |

### com.leadwaycloud.message.notice.email.adapter.dto.request.v1.SendCustomerEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| subject | string | 是 | 标题 | "xxx订货单" |
| content | string | 是 | 邮件内容 |  |
| sendName | string | 是 | 发件人别名 | "立威云科" |
| to | string[] | 是 | 收件人 | ["kunliang.zeng@leadwaycloud.com"] |
| cc | string[] | 否 | 抄送人 | ["kunliang.zeng@leadwaycloud.com"] |
| bcc | string[] | 否 | 密送人 | ["kunliang.zeng@leadwaycloud.com"] |
| html | boolean | 否 | 是否是html格式的邮件内容 | false |

### com.leadwaycloud.message.notice.email.adapter.dto.request.v1.SendCustomerEmailForBackendRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| companyId | integer(int64) | 否 | 公司ID | 1 |
| subject | string | 是 | 标题 | "xxx订货单" |
| content | string | 是 | 邮件内容 |  |
| sendName | string | 是 | 发件人别名 | "立威云科" |
| to | string[] | 是 | 收件人 | ["kunliang.zeng@leadwaycloud.com"] |
| cc | string[] | 否 | 抄送人 | ["kunliang.zeng@leadwaycloud.com"] |
| bcc | string[] | 否 | 密送人 | ["kunliang.zeng@leadwaycloud.com"] |
| html | boolean | 否 | 是否是html格式的邮件内容 | false |
| fileName | string | 否 | 文件名称 | "立威云科.pdf" |
| fileBase64 | string | 否 | fileBase64 | "立威云科" |

### com.leadwaycloud.message.task.adapter.dto.request.TaskHandyFinishRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |
| principalId | integer(int64) | 是 | 任务处理人ID | 1 |
| processedNotice | boolean | 是 | 处理完成是否通知发起人 | false |

### com.leadwaycloud.message.task.adapter.dto.request.SubTaskReassignmentRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_) | "Activity_1l676zu" |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |

### com.leadwaycloud.message.task.adapter.dto.request.SubTaskFinishRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_) | "Activity_1l676zu" |
| principalId | integer(int64) | 是 | 任务处理人ID(如果不是第一次发起任务创建则必须提供) | 1 |
| finishTime | string | 是 | 完成时间 | "2020-10-11 13:09:11" |
| processedNotice | boolean | 是 | 处理完成是否通知发起人 | false |

### com.leadwaycloud.message.task.adapter.dto.request.BusinessNoticeRequest

业务提醒消息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| title | string | 是 | 标题 | "系统更新 v0.1.1" |
| content | string | 是 | 消息内容 |  |
| data | object | 是 | 消息业务对象 |  |
| date | string | 是 | 发布时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.message.task.adapter.dto.request.PublishNormalTaskRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessType | string | 否 | 业务类型 |  |
| businessId | integer(int64) | 否 | 业户数据ID |  |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_, 普通任务传UUID) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_, 普通任务传UUID) | "Activity_1l676zu" |
| name | string | 是 | 名称 | "审核任务" |
| type | string | 是 | 子任务类型  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】 | "TASK_VERIFY" |
| initiatorId | integer(int64) | 是 | 发起人ID | 1 |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |
| businessData | object | 是 | 任务业务数据 | {"id":1,"type":"inventory","code":"AD2021062100011","name":"xxx 盘点单"} |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| messageData | BusinessNoticeRequest | 是 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

### com.leadwaycloud.message.system.support.application.dto.RoleDTO

处理任务关联的角色

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 用户ID |  |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| description | string | 是 | 描述 |  |
| templateId | integer(int64) | 是 | 角色模板ID |  |

### com.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| taskId | integer(int64) | 是 | 主任务ID |  |
| task | MsgTaskResponse | 是 |  |  |
| name | string | 是 | 名称 |  |
| taskDefaultKey | string | 是 | 编号 |  |
| type | string | 是 | 类型  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】 |  |
| status | string | 是 | 状态  【 UNTREATED : 未处理   PROCESSED : 已处理   】  【 UNTREATED : 未处理   PROCESSED : 已处理   】 |  |
| initiatorId | integer(int64) | 是 | 发起人ID |  |
| initiator | UserDTO | 否 |  |  |
| principalId | integer(int64) | 否 | 处理人ID |  |
| principal | UserDTO | 否 |  |  |
| businessData | string | 是 | 任务业务数据 |  |
| messageData | string | 是 | 消息业务数据 |  |
| sendTime | string | 是 | 发起时间 |  |
| processTime | string | 否 | 处理时间 |  |
| createTime | string | 否 | 创建时间 |  |
| roleList | RoleDTO[] | 否 | 处理任务关联的角色 |  |
| userList | UserDTO[] | 否 | 处理任务关联的用户 |  |

### com.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse

主任务

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| name | string | 是 | 名称 |  |
| businessType | string | 是 | 业务类型 |  |
| businessCode | string | 是 | 编号 |  |
| status | string | 是 | 状态  【 PROCESSING : 处理中   PROCESSED : 已处理   UNTREATED : 未处理   】  【 PROCESSING : 处理中   PROCESSED : 已处理   UNTREATED : 未处理   】 |  |
| initiatorId | integer(int64) | 是 | 发起人ID |  |
| initiator | UserDTO | 是 |  |  |
| sendTime | string | 是 | 发起时间 |  |
| processInstanceId | string | 是 | work flow流程实例ID |  |
| finishTime | string | 否 | 完成时间 |  |
| createTime | string | 否 | 创建时间 |  |

### com.leadwaycloud.message.notice.sms.adapter.dto.request.v2.SendSMSRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| businessType | string | 是 | 业务类型  【 CAPTCHA : 验证码   MALL_USER_REGISTER_CAPTCHA : 商城用户注册验证码   MALL_USER_LOGIN_CAPTCHA : 商城用户登陆验证码   MALL_USER_PASSWORD_RESET_CAPTCHA : 商城用户密码重置验证码   MALL_USER_DESTORY_CAPTCHA : 商城用户注销验证码   MALL_USER_UNBIND_COMPANY_CAPTCHA : 商城用户与企业解绑验证码   MALL_USER_CHANGE_PHONE_CAPTCHA : 商城用户变更手机号验证码   MALL_USER_REGISTER_SUCCESS_CAPTCHA : 商城用户注册成功通知   MALL_COMPANY_AUTHENTICATION_SUCCESS_CAPTCHA : 商城企业认证成功通知   】 | "CAPTCHA" |
| mobilePhoneList | string[] | 是 | 需要发送短信的手机号 | [] |
| paramMap | object | 否 | 业务类型发送短信需要提供的参数 | {} |

### com.leadwaycloud.message.notice.email.adapter.dto.request.v2.SendTemplateEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| businessType | string | 是 | 邮件业务类型  【 CAPTCHA : 立威云科Email验证码   】 | "CAPTCHA" |
| toEmailList | string[] | 是 | 收件人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| ccEmailList | string[] | 否 | 抄送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| bccEmailList | string[] | 否 | 密送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| paramJsonMap | object | 否 | 业务类型发送需要提供的参数 | {"code":"123456"} |

### com.leadwaycloud.message.notice.email.adapter.dto.request.v2.SendCustomerEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| subject | string | 是 | 标题 |  |
| emailContent | string | 是 | 邮件内容 |  |
| toEmailList | string[] | 是 | 收件人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| ccEmailList | string[] | 否 | 抄送人邮箱 | ["kunliang.zeng@leadwaycloud"] |
| bccEmailList | string[] | 否 | 密送人邮箱 | ["kunliang.zeng@leadwaycloud"] |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateInsideTemplateRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 否 | 商户ID |  |
| name | string | 是 | 消息模版名称 | "提醒信息" |
| type | string | 是 | 消息模版类型(验证码消息code(EMAIL_VERIFICATION_CODE)/各业务类型code(BK_xxx)) | "EMAIL_VERIFICATION_CODE" |
| config | string | 是 | 信息模版配置 | "{}" |
| subject | string | 是 | 主题 |  |
| template | string | 是 | 信息模版内容 | "<html>" |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateMsgServerRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID |  |
| companyId | integer(int64) | 否 | 公司ID |  |
| name | string | 是 | 服务配置名称 | "MAILSERVER" |
| type | string | 是 | 服务类型(比如:EMAIL,SMS)  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEBSOCKET" |
| config | MsgServerConfigDTO | 是 |  |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.VerifyMeetingRoomApplyRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pass | boolean | 是 | 是否通过 |  |
| reason | string | 是 | 理由 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.JoinMeetingConfirmRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| join | boolean | 是 | 是否参与 |  |
| reason | string | 是 | 理由 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.ApplyMeetingRoomRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型 |  |
| meetingDate | string | 否 | 会议日期 | "2024-07-02" |
| startTime | string | 否 | 开始时间 | "13:09:11" |
| endTime | string | 否 | 结束时间 | "13:09:11" |
| compere | integer(int64) | 是 | 主持人ID |  |
| subject | string | 是 | 主题 |  |
| agenda | string | 否 | 议程 |  |
| peopleCount | string | 是 | 预计人数 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| notes | string | 否 | 备注 |  |
| meetingRoomId | integer(int64) | 是 | 会议室ID |  |
| meetingMemberList | integer(int64)[] | 是 | 参会成员 |  |

### com.leadwaycloud.message.oa.meeting.adapter.dto.request.CreateMeetingRoomRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID |  |
| name | string | 是 | 名称 |  |
| image | string | 否 | 照片 |  |
| openStartTime | string | 是 | 开始时间 | "08:00:00" |
| openEndTime | string | 是 | 结束时间 | "18:30:00" |
| peopleCount | string | 是 | 容纳人数 |  |
| supportMeetingType | string[] | 是 | 支持会议类型(从sys_properties中取MEETING_TYPE组) |  |
| firstManager | integer(int64) | 是 | 第一责任人ID |  |
| secondManager | integer(int64) | 是 | 第二责任人ID |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.SendTemplateMsgRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| imMsgTemplateCode | string | 是 | 模版消息唯一键(从sys_properties中取IM_MSG_TEMPLATE_CODE组) | "0454cb83a79b477db32570eb58bbc5bb" |
| paramMap | object | 是 | 消息参数 |  |
| receiveList | integer(int64) | 是 | 接收人列表(用户ID) |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.SendP2PMsgRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID | 1 |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| receiver | integer(int64) | 是 | 接收人(用户ID) | 600412495355845 |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| isSystem | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| system | boolean | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| linkMsg | MsgResponse$ImMsgLinkResponse | 否 |  |  |
| senderUser | UserDTO | 否 |  |  |
| group | ImGroupResponse | 否 |  |  |
| template | MsgResponse$ImMsgTemplateResponse | 否 |  |  |
| receiverUserList | integer(int64)[] | 否 | 接收人ID集合 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse$ImMsgLinkResponse

关联消息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| senderUser | UserDTO | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse$ImMsgTemplateResponse

模版消息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | 1 |  |
| code | string | 是 | 唯一键 |  |
| name | string | 是 | 名称 |  |
| config | string | 是 | 模版消息配置 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.SendGroupMsgRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| type | string | 是 | 类型 TEXT:文本 IMG:图片 VIDEO:视频 FILE:文件 | "TEXT" |
| content | string | 是 | 内容 | "测试消息" |
| groupId | integer(int64) | 是 | 群组ID | 1 |
| memberList | integer(int64)[] | 否 | 接收的群组成员,全部成员可不传(用户ID) | [1] |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否是系统消息 | false |
| subject | string | 否 | 标题 | "测试消息" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

### com.leadwaycloud.message.im.message.application.query.QueryUnReadMessageCount

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| pointTime | string | 是 | 小于指定时间点的未读消息条数 | "2024-07-11 10:09:11.222" |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.LastUnReadMessageResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | LastUnReadMessageResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.LastUnReadMessageResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| lastMsg | MsgResponse | 是 |  |  |
| unReadMsgCount | integer(int64) | 是 | 未读条数 | 1 |

### com.leadwaycloud.message.im.message.adapter.dto.request.ForwardMsgRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 是 | 发送人ID |  |
| messageList | integer(int64)[] | 是 | 消息列表 | [1] |
| mergeForward | boolean | 否 | 是否合并转发 | false |
| receiverList | integer(int64)[] | 否 | 接收人列表(用户ID) | [600412495355845] |
| groupList | integer(int64)[] | 否 | 群组列表(群组ID) | [1] |
| leaveMessage | string | 否 | 留言 | "xxx" |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.CollectIMMessageRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID |  |
| tagList | string[] | 否 | 标签 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SendMsgResponse | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户ID | 1 |
| msgId | integer(int64) | 是 | 消息ID | 1 |
| sessionKey | string | 是 | 会话key |  |
| sendTime | string | 是 | 发送时间 | "2020-10-11 13:09:11.222" |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 | "IM" |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 | "TEXT" |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkMsgId | integer(int64) | 否 | 关联消息ID | 1 |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| sender | integer(int64) | 是 | 发送人ID | 1 |
| senderName | string | 是 | 发送人名称 | "张三" |
| groupId | integer(int64) | 否 | 群组ID | 1 |
| groupName | string | 否 | 群组名称 | "xxx" |
| receiverUserList | integer(int64)[] | 否 | 接收者集合 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.SendMsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SendMsgResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.AddIMUsefulExpressionRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| content | string | 是 | 常用语内容 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.message.adapter.dto.response.UsefulExpressionResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UsefulExpressionResponse | 否 |  |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.AddCollectTagRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| tag | string | 是 | 标签 |  |

### com.leadwaycloud.message.im.message.adapter.dto.request.AddIMGroupRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 群组名称 |  |
| owner | integer(int64) | 是 | 群主 |  |
| announcement | string | 否 | 群公告 |  |
| memberList | string | 否 | 群成员(用户ID) |  |
| onlyManagerAddMember | boolean | 否 | 仅管理员添加成员 |  |

### com.leadwaycloud.message.im.email.adapter.dto.request.IMEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 否 | 消息ID(草稿邮件ID) |  |
| type | string | 是 | 类型 EMAIL:邮件 | "EMAIL" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试邮件消息" |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailResponse | 否 |  |  |

### com.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| linkMsg | IMEmailResponse$ImMsgLinkResponse | 否 |  |  |
| senderUser | UserDTO | 否 |  |  |

### com.leadwaycloud.message.im.email.adapter.dto.response.IMEmailResponse$ImMsgLinkResponse

关联消息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| senderUser | UserDTO | 否 |  |  |

### com.leadwaycloud.message.im.email.adapter.dto.request.IMCollectEmailRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID |  |
| tagList | string[] | 否 | 标签 |  |

### com.leadwaycloud.message.im.business.adapter.dto.request.CreateImBusinessRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 否 | 业务联系单ID |  |
| type | string | 是 | 类型 BUSINESS:业务联系单 | "BUSINESS" |
| subject | string | 是 | 主题 | "测试" |
| content | string | 是 | 内容 | "测试业务联系单消息" |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| departmentId | integer(int64) | 否 | 业务联系单提出部门ID | 1 |
| departmentName | string | 否 | 业务联系单提出部门名称 | "xxx" |
| approvalUserId | integer(int64) | 否 | 业务联系单审核人ID | 1 |
| approvalUserName | string | 否 | 业务联系单审核人名称 | "xxx" |
| lastConfirmTime | string | 否 | 要求反馈时间 | "2024-01-01 12:00:00" |
| reserveConfig | ReserveConfigDTO | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessResponse | 否 |  |  |

### com.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| linkMsg | IMBusinessResponse$ImMsgLinkResponse | 否 |  |  |
| senderUser | UserDTO | 否 |  |  |
| receiveCount | integer(int64) | 否 | 已回复人数 |  |

### com.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse$ImMsgLinkResponse

关联消息

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| merchantId | integer(int64) | 是 | 商户ID |  |
| sendTime | string | 是 | 发送时间 |  |
| sessionKey | string | 是 | 会话key |  |
| groupId | integer(int64) | 否 | 群组ID |  |
| sender | integer(int64) | 否 | 发送人ID |  |
| model | string | 是 | 模式  【 IM : 即时通讯   EMAIL : 邮件   BULLETIN : 公告   BUSINESS : 业务联系单   】 |  |
| type | string | 是 | 类型  【 TEXT : 文本   IMG : 图片   VIDEO : 视频   FILE : 文件   RECORD : 聊天记录   LINK : 链接   EMAIL : 邮件   BUSINESS : 业务联系单   】 |  |
| subject | string | 否 | 主题 |  |
| content | string | 是 | 内容 |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |
| linkId | integer(int64) | 否 | 关联消息ID |  |
| system | boolean | 否 | 是否系统消息 |  |
| templateId | integer(int64) | 否 | IM消息模版ID |  |
| reserveConfig | ReserveConfigDTO | 否 |  |  |
| status | string | 是 | 状态  【 DRAFT : 草稿   APPROVAL : 审核中   VALID : 有效   REVOKE : 撤回   CLOSE : 关闭   】 |  |
| expireTime | string | 否 | 过期时间 |  |
| priority | integer(int32) | 否 | 优先级 |  |
| reserved1 | integer(int64) | 否 | 备用字段1 |  |
| reserved2 | integer(int64) | 否 | 备用字段2 |  |
| reserved3 | string | 否 | 备用字段3 |  |
| reserved4 | string | 否 | 备用字段4 |  |
| reserved5 | string | 否 | 备用字段5 |  |
| reserved6 | string | 否 | 备用字段6 |  |
| reserved7 | string | 否 | 备用字段7 |  |
| reserved8 | string | 否 | 备用字段8 |  |
| reserved9 | boolean | 否 | 备用字段9 |  |
| reserved10 | boolean | 否 | 备用字段10 |  |
| reserved11 | string | 否 | 备用字段11 |  |
| reserved12 | string | 否 | 备用字段12 |  |
| senderUser | UserDTO | 否 |  |  |

### com.leadwaycloud.message.im.business.adapter.dto.request.ConfirmImBusinessRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| content | string | 是 | 内容 | "测试消息" |
| linkId | integer(int64) | 是 | 关联消息ID |  |
| attachment | AttachmentInfoDTO[] | 否 | 附件 |  |

### com.leadwaycloud.message.im.verify.adapter.dto.request.ImVerifyRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID | 1 |
| verifyType | string | 是 | 审核类别  【 BULLETIN : 公告发布审批   】  【 BULLETIN : 公告发布审批   】 | "BARCODE_ON_SHELF" |

### com.leadwaycloud.message.im.verify.adapter.dto.request.ImVerifyResultRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msgId | integer(int64) | 是 | 消息ID | 1 |
| businessKey | string | 是 | 业务类型 | "xxx" |
| pass | boolean | 是 | 是否通过 | false |
| notice | string | 否 | 审核结果描述 | "xxx" |

### com.leadwaycloud.message.notice.manager.adapter.dto.request.CreateEmailTemplateRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| merchantId | integer(int64) | 是 | 商户号ID | 1 |
| title | string | 是 | 标题 | "1" |
| status | string | 是 | 状态 | "1" |
| type | string | 是 | 类型 | "1" |
| content | string | 是 | 内容 | "1" |
| ccRole | string | 否 | 抄送角色ID集合 | "11111,2222222" |
| ccUser | string | 否 | 抄送用户ID集合 | "11111,2222222" |
| addresseeUser | string | 否 | 收件用户ID集合 | "11111,2222222" |
| notifySupplier | boolean | 否 | 通知供应商 | false |

### com.leadwaycloud.core.model.RJava.lang.Long

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | integer(int64) | 否 | 返回数据 |  |

### com.leadwaycloud.message.system.support.adapter.dto.request.QueryFile

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| name | string | 是 | 名称 | "demo" |
| folderId | string | 否 | 文件夹ID(查询某个文件夹下含子文件夹的文件) | "1242797390784131" |

### com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.util.List

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

### com.leadwaycloud.message.oa.calendar.schedule.application.query.QueryCalendarSchedule

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| startDate | string | 是 | 开始日期(时间区间不能超过31天) | "2020-01-01" |
| endDate | string | 是 | 结束日期(时间区间不能超过31天) | "2020-12-30" |
| statusList | string | 否 | 状态  【 START : 启动   PAUSE : 暂停   CLOSE : 关闭   CANCEL : 取消   】 |  |
| typeList | string | 否 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 否 | 内容 |  |
| priority | integer(int32) | 否 | 优先级 | 0 |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.calendar.schedule.adapter.dto.response.CalendarScheduleResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CalendarScheduleResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.response.CalendarScheduleResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| scheduleDate | string | 是 | 日程日期 | "2020-10-11" |
| startTime | string | 是 | 日程开始时间 | "08:00:00" |
| endTime | string | 否 | 日程结束时间 | "09:00:00" |
| calendarSchedule | CalendarScheduleResponse$CalendarSchedule | 是 |  |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.response.CalendarScheduleResponse$CalendarSchedule

日历日程

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID |  |
| userId | integer(int64) | 是 | 用户ID |  |
| status | string | 是 | 状态  【 START : 启动   PAUSE : 暂停   CLOSE : 关闭   CANCEL : 取消   】  【 START : 启动   PAUSE : 暂停   CLOSE : 关闭   CANCEL : 取消   】 |  |
| type | string | 是 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| custom | boolean | 是 | 是否为自定义日程 |  |
| startDate | string | 是 | 开始日期 | "2020-10-11" |
| endDate | string | 否 | 结束日期 | "2020-10-11" |
| startTime | string | 是 | 日程开始时间 | "08:00:00" |
| endTime | string | 否 | 日程结束时间 | "09:00:00" |
| repeat | string | 是 | 重复类型  【 NONE : 无 DAY   DAY : 每天   WEEK : 每周   MONTH : 每月   YEAR : 每年   】  【 NONE : 无 DAY   DAY : 每天   WEEK : 每周   MONTH : 每月   YEAR : 每年   】 | "NONE" |
| weekDay | integer(int32) | 否 | 每周周几(1,2,3,4,5,6,7) | 1 |
| monthDay | integer(int32) | 否 | 每月几号(1,2,3...31) | 1 |
| yearDay | string | 否 | 每年的几月几号(01-01) | "01-01" |
| content | string | 是 | 日程内容 |  |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |
| attachment | string | 否 | 自定义数据(json格式) |  |
| msgId | integer(int64) | 否 | 消息ID | 1 |
| priority | integer(int32) | 否 | 优先级 | 0 |
| msg | MsgResponse | 否 |  |  |
| createBy | integer(int64) | 否 | 创建人ID |  |
| createTime | string | 否 | 创建时间 |  |
| updateBy | integer(int64) | 否 | 修改人ID |  |
| updateTime | string | 否 | 修改时间 |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PublishSystemScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sender | integer(int64) | 否 | 发布人(如果未提供则会被定义为系统发布) |  |
| userList | integer(int64)[] | 是 | 用户ID |  |
| type | string | 是 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 是 | 日程内容 |  |
| priority | integer(int32) | 否 | 优先级 | 0 |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |
| attachment | string | 否 | 自定义数据(json格式) |  |
| startDate | string | 是 | 开始日期 | "2020-10-11" |
| endDate | string | 否 | 结束日期 | "2020-10-11" |
| startTime | string | 是 | 日程开始时间 | "08:00:00" |
| endTime | string | 否 | 日程结束时间 | "09:00:00" |
| messageConfig | PublishSystemScheduleRequest$MessageConfig | 否 |  |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PublishSystemScheduleRequest$MessageConfig

消息配置(未提供则不会发送模版消息)

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| imMsgTemplateCode | string | 是 | 模版消息唯一键(从sys_properties中取IM_MSG_TEMPLATE_CODE组) | "0454cb83a79b477db32570eb58bbc5bb" |
| paramMap | object | 是 | 消息参数 |  |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.PublishCalendarScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| type | string | 是 | 类型(从sys_properties中取CALENDAR_SCHEDULE_TYPE组) |  |
| content | string | 是 | 日程内容 |  |
| priority | integer(int32) | 否 | 优先级 | 0 |
| attachmentKey | string | 否 | 自定义数据key(可以填入对应数据的唯一ID) |  |
| attachment | string | 否 | 自定义数据(json格式) |  |
| startDate | string | 是 | 开始日期 | "2020-10-11" |
| endDate | string | 否 | 结束日期 | "2020-10-11" |
| startTime | string | 是 | 日程开始时间 | "08:00:00" |
| endTime | string | 否 | 日程结束时间 | "09:00:00" |
| repeat | string | 是 | 重复类型  【 NONE : 无 DAY   DAY : 每天   WEEK : 每周   MONTH : 每月   YEAR : 每年   】 | "NONE" |
| weekDay | integer(int32) | 否 | 每周周几(1,2,3,4,5,6,7) | 1 |
| monthDay | integer(int32) | 否 | 每月几号(1,2,3...31) | 1 |
| yearDay | string | 否 | 每年的几月几号(01-01) | "01-01" |

### com.leadwaycloud.message.task.adapter.dto.request.PublishWorkflowTaskRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| businessType | string | 否 | 业务类型 |  |
| businessId | integer(int64) | 否 | 业户数据ID |  |
| businessCode | string | 是 | 业户数据编号(例:如果针对订单审核可以放入订单ID/编号) |  |
| processInstanceId | string | 是 | 流程实例ID(proc_inst_id_, 普通任务传UUID) | "250666" |
| taskDefaultKey | string | 是 | 节点ID(task_def_key_, 普通任务传UUID) | "Activity_1l676zu" |
| name | string | 是 | 名称 | "审核任务" |
| type | string | 是 | 子任务类型  【 TASK_VERIFY : 审核任务   TASK_ORDER : 单据任务   】 | "TASK_VERIFY" |
| initiatorId | integer(int64) | 是 | 发起人ID | 1 |
| userList | integer(int64)[] | 否 | 任务处理用户ID集合 |  |
| roleList | integer(int64)[] | 否 | 任务处理角色ID集合 |  |
| businessData | object | 是 | 任务业务数据 | {"id":1,"type":"inventory","code":"AD2021062100011","name":"xxx 盘点单"} |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| messageData | BusinessNoticeRequest | 是 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgTaskResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | MsgSubTaskResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgSubTaskResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgSubTaskResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | MsgTaskResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.task.adapter.dto.response.MsgTaskResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgTaskResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SignetResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SignetUseRecordResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SignetMakeRecordResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SignetLendOutRecordResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | SignetGrantReceiveRecordResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse | 否 |  |  |

### com.leadwaycloud.message.oa.signet.application.query.QueryListSignet

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 否 | 公司ID |  |
| dataList | integer(int64)[] | 否 | ID列表 |  |
| nameOrCode | string | 否 | 名称/编号 |  |
| type | string | 否 | 类别  【 E : 电子印章   M : 实物章   】 | "M" |
| status | string | 否 | 状态  【 DELETE : 删除   UN_ENABLE : 制作中   ENABLE : 启用   LOSE : 丢失   ENCASE : 封存   DESTROY : 销毁   】 | "ENABLE" |
| categoryId | integer(int64) | 否 | 类型 |  |
| inHouse | boolean | 否 | 是否在库 |  |
| saveDepartmentNameOrCode | string | 否 | 保管部门名称/编号 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetVoidRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetVoidRecordResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetUseRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetUseRecordResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetMakeRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetMakeRecordResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetLendOutRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetLendOutRecordResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetGrantReceiveRecordResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetGrantReceiveRecordResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.signet.adapter.dto.response.SignetCategoryResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | SignetCategoryResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.lang.Object

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgMessageResponse | 否 |  |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| batch | string | 是 | 批次号(发送消息时产生) | "UUID" |
| type | string | 是 | 类型  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】  【 WEBSOCKET_SYSTEM_ANNOUNCEMENT : 系统公告   WEBSOCKET_SYSTEM_NOTICE : 系统通知   WEBSOCKET_BUSINESS_NOTICE : 业务提醒   WEBSOCKET_FUNCTION_CALLBACK : 功能回调   EMAIL_VERIFICATION_CODE : 立威云科Email验证码   SMS_VERIFICATION_CODE : 立威云科短信验证码   】 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 是 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKey | string | 是 | 客户端连接符 | "xxxID" |
| status | string | 是 | 状态  【 UNREAD : 未读   HAVE_READ : 已读   】  【 UNREAD : 未读   HAVE_READ : 已读   】 | "UNREAD" |
| title | string | 是 | 消息标题 |  |
| message | string | 是 | 消息内容 |  |
| messageData | string | 否 | 消息数据 |  |
| sentSuccess | boolean | 是 | 是否发送成功 | false |
| taskId | integer(int64) | 否 | 主任务ID | 1 |
| subTaskId | integer(int64) | 否 | 子任务ID | 1 |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| expireTime | string | 否 | 过期时间 | "2020-10-11 13:09:11" |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| readTime | string | 否 | 读取时间 | "2020-10-11 13:09:11" |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.core.model.RJava.util.MapJava.lang.StringJava.lang.Long

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.application.dto.UserDTO

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | UserDTO[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | MsgMessageResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgMessageResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgMessageResponse | 否 |  |  |

### PageableObject

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| paged | boolean | 否 |  |  |
| pageNumber | integer(int32) | 否 |  |  |
| offset | integer(int64) | 否 |  |  |
| sort | SortObject | 否 |  |  |
| pageSize | integer(int32) | 否 |  |  |
| unpaged | boolean | 否 |  |  |

### SortObject

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| sorted | boolean | 否 |  |  |
| empty | boolean | 否 |  |  |
| unsorted | boolean | 否 |  |  |

### com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | InsideTemplateResponse | 否 |  |  |

### org.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.InsideTemplateResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| totalElements | integer(int64) | 否 |  |  |
| totalPages | integer(int32) | 否 |  |  |
| pageable | PageableObject | 否 |  |  |
| first | boolean | 否 |  |  |
| last | boolean | 否 |  |  |
| size | integer(int32) | 否 |  |  |
| content | InsideTemplateResponse[] | 否 |  |  |
| number | integer(int32) | 否 |  |  |
| sort | SortObject | 否 |  |  |
| numberOfElements | integer(int32) | 否 |  |  |
| empty | boolean | 否 |  |  |

### com.leadwaycloud.core.model.ROrg.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgServerResponse | 否 |  |  |

### org.springframework.data.domain.PageCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.MsgServerResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| totalElements | integer(int64) | 否 |  |  |
| totalPages | integer(int32) | 否 |  |  |
| pageable | PageableObject | 否 |  |  |
| first | boolean | 否 |  |  |
| last | boolean | 否 |  |  |
| size | integer(int32) | 否 |  |  |
| content | MsgServerResponse[] | 否 |  |  |
| number | integer(int32) | 否 |  |  |
| sort | SortObject | 否 |  |  |
| numberOfElements | integer(int32) | 否 |  |  |
| empty | boolean | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | MeetingResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingRoomResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingRoomResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.oa.meeting.adapter.dto.response.MeetingResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MeetingResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | MsgResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.message.adapter.dto.response.MsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MsgResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.MessageReadInfoResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | MessageReadInfoResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.MessageReadInfoResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| receiverUser | UserDTO | 是 |  |  |
| readTime | string | 是 | 读取时间 | "2020-10-11 13:09:11" |
| downloadCount | integer(int64) | 否 | 下载次数(文件类型消息是有数据) | 1 |

### com.leadwaycloud.core.model.RJava.util.MapJava.lang.LongJava.lang.String

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.CollectMsgResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | CollectMsgResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.message.adapter.dto.response.CollectMsgResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msg | MsgResponse | 是 |  |  |
| tagList | string[] | 否 | 标签 |  |

### com.leadwaycloud.core.model.RJava.util.ListJava.lang.String

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | string[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.message.adapter.dto.response.ImGroupMemberResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | ImGroupMemberResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.core.model.P

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | object[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.P

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | P | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.email.adapter.dto.response.IMEmailReadResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMEmailReadResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.email.adapter.dto.response.IMEmailReadResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| receiverUser | UserDTO | 是 |  |  |
| readTime | string | 是 | 读取时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.im.email.adapter.dto.response.IMCollectEmailResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMCollectEmailResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.im.email.adapter.dto.response.IMCollectEmailResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| msg | IMEmailResponse | 是 |  |  |
| tagList | string[] | 否 | 标签 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | IMBusinessResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessResponse | 否 |  |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessDetailResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBusinessDetailResponse | 否 |  |  |

### com.leadwaycloud.message.im.business.adapter.dto.response.IMBusinessDetailResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| business | IMBusinessResponse | 是 |  |  |
| processUserList | UserDTO[] | 是 | 处理人集合 |  |
| confirmMsgList | IMBusinessResponse[] | 否 | 处理人确认消息集合 |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | IMBulletinResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.im.bulletin.adapter.dto.response.IMBulletinResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | IMBulletinResponse | 否 |  |  |

### com.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| first | boolean | 是 | 是否是第一页 | true |
| last | boolean | 是 | 是否是最后一页 | true |
| totalPages | integer(int32) | 是 | 总页数 | 1 |
| totalElements | integer(int64) | 是 | 总数据条数 | 1 |
| size | integer(int32) | 是 | 每页条数 | 10 |
| number | integer(int32) | 是 | 当前页码 | 0 |
| numberOfElements | integer(int32) | 是 | 当前页数据条数 | 0 |
| dataList | EmailTemplateResponse[] | 否 | 当前页数据 |  |

### com.leadwaycloud.core.model.RCom.leadwaycloud.core.model.PCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EmailTemplateResponse | 否 |  |  |

### com.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse

当前页数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| id | integer(int64) | 是 | ID | 1 |
| batch | string | 是 | 批次号(发送消息时产生) | "UUID" |
| type | string | 是 | 类型 | "WEBSOCKET_SYSTEM_ANNOUNCEMENT" |
| sendMethod | string | 是 | 发送方式  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】  【 WEB_SOCKET : 站内信   EMAIL : 邮件   SMS : 短信   】 | "WEB_SOCKET" |
| clientKeyType | string | 是 | 客户端连接符类型  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】  【 USER_ID : 用户ID   EMAIL : 邮箱   MOBILE_PHONE : 手机号码   OTHER : 其他   】 | "USER_ID" |
| clientKey | string | 是 | 客户端连接符 | "xxxID" |
| status | string | 是 | 状态 | "UNREAD" |
| title | string | 是 | 消息标题 |  |
| message | string | 是 | 消息内容 |  |
| messageData | string | 否 | 消息数据 |  |
| sentSuccess | boolean | 是 | 是否发送成功 | false |
| taskId | integer(int64) | 否 | 主任务ID | 1 |
| subTaskId | integer(int64) | 否 | 子任务ID | 1 |
| merchantId | integer(int64) | 否 | 商户ID | 1 |
| expireTime | string | 否 | 过期时间 | "2020-10-11 13:09:11" |
| sendTime | string | 否 | 发布时间 | "2020-10-11 13:09:11" |
| readTime | string | 否 | 读取时间 | "2020-10-11 13:09:11" |
| createTime | string | 否 | 创建时间 | "2020-10-11 13:09:11" |

### com.leadwaycloud.core.model.RCom.leadwaycloud.message.notice.manager.adapter.dto.reponse.EmailTemplateResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | EmailTemplateResponse | 否 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.adapter.dto.response.DepartmentUserResponse

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | DepartmentUserResponse[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.system.support.adapter.dto.response.DepartmentUserResponse

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| companyId | integer(int64) | 是 | 公司ID | 1 |
| departmentId | integer(int64) | 是 | 部门ID | 1 |
| user | UserDTO | 是 |  |  |

### com.leadwaycloud.core.model.RJava.util.ListCom.leadwaycloud.message.system.support.adapter.dto.response.PlatformAssistantClientVersion

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | PlatformAssistantClientVersion[] | 否 | 返回数据 |  |

### com.leadwaycloud.message.system.support.adapter.dto.response.PlatformAssistantClientVersion

返回数据

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| version | string | 是 | 版本号 | "1.0.0.1" |
| osType | string | 是 | 操作系统类型  【 WIN32 : Windows32位操作系统   WIN64 : Windows64位操作系统   MAC : Mac操作系统   】 | "WIN32" |
| mustUpdate | string | 是 | 是否必须更新 | "false" |
| updateTime | string | 是 | 发布时间 | "2020-10-11 13:09:11" |
| updateContentList | string[] | 是 | 更新内容 | [] |

### com.leadwaycloud.message.oa.calendar.schedule.adapter.dto.request.DeleteCalendarScheduleRequest

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| calendarScheduleId | integer(int64) | 是 | 日历日程ID |  |
| scheduleDate | string | 否 | 日程日期(未提供则删除全部，搭配current) | "2020-10-11" |
| current | boolean | 否 | 是否仅删除当前日程(未提供或者false则删除指定任务日期之后的全部任务) | true |

### com.leadwaycloud.core.model.R

| 名称 | 类型 | 必填 | 说明 | 示例 |
| --- | --- | --- | --- | --- |
| status | integer(int32) | 是 | 状态码 | 200 |
| code | string | 是 | 业务代码 | "000" |
| message | string | 是 | 消息描述 | "成功" |
| data | object | 否 | 返回数据 |  |