使用逗号分割多个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "time", + "description": "" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/PublicController.php", + "group": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "groupTitle": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "name": "" + }, + { + "type": "post", + "url": "api/approve/export", + "title": "18. 导出数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "export", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/identitylinkHistory/findParticipant", + "title": "16. 查询流程实例的参与者(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "identitylinkHistory__findParticipant", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/identitylink/findParticipant", + "title": "12. 查询流程实例的参与者(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "identitylink__findParticipant", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/findProcNotify", + "title": "15. 查询抄送我的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__findProcNotify", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/findTask", + "title": "13. 查询需要我审批的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__findTask", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/startByMyself", + "title": "14. 查询我启动的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__startByMyself", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procdef/all", + "title": "02. 查询流程定义", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procdef__all", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/procdef/del", + "title": "03. 删除流程定义", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procdef__del", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/addGlobalComment", + "title": "05. 添加全局评论", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__addGlobalComment", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/process/detail", + "title": "17. 根据流程ID查询流程详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__detail", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/findProcNotify", + "title": "11. 查询抄送我的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__findProcNotify", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/findTask", + "title": "08. 查询需要我审批的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__findTask", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/start", + "title": "04. 启动流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__start", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/startByMyself", + "title": "10. 查询我启动的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__startByMyself", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/startByMyselfAll", + "title": "09. 查询我启动的流程(全部)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__startByMyselfAll", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/task/complete", + "title": "06. 审批", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "task__complete", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/task/withdraw", + "title": "07. 撤回", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "task__withdraw", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/dialog/group/add", + "title": "34. 新增群组", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "group__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "群头像
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "chat_name", + "description": "群名称
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/adduser", + "title": "36. 添加群成员", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "新增的群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/deluser", + "title": "37. 移出(退出)群成员", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "移出的群成员,格式: [userid1, userid2, userid3]
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/disband", + "title": "39. 解散群组", + "description": "需要token身份
会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/edit", + "title": "35. 修改群组", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "group__edit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "群头像
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "chat_name", + "description": "群名称
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "admin", + "description": "系统管理员操作(1:只判断是不是系统管理员,否则判断是否群管理员)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/searchuser", + "title": "40. 搜索个人群(仅限管理员)", + "description": "需要token身份,用于创建部门搜索个人群组
", + "version": "1.0.0", + "group": "dialog", + "name": "group__searchuser", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/transfer", + "title": "38. 转让群组", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "新的群主
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/lists", + "title": "01. 对话列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:1678248944,1678248944)
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/color", + "title": "33. 设置颜色", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__color", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/detail", + "title": "22. 消息详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__detail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "only_update_at", + "description": "仅获取update_at字段
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/done", + "title": "32. 完成待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__done", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "待办数据ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/download", + "title": "23. 文件下载", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__download", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "down", + "description": "直接下载
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/emoji", + "title": "28. emoji回复", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__emoji", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "symbol", + "description": "回复或取消的emoji表情
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/forward", + "title": "27. 转发消息给", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__forward", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "dialogids", + "description": "转发给的对话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "转发给的成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/list", + "title": "09. 获取消息列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "position_id", + "description": "此消息ID前后的数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "prev_id", + "description": "此消息ID之前的数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "next_id", + "description": "此消息ID之后的数据
消息类型
获取条数,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/mark", + "title": "25. 消息标记操作", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__mark", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
仅标记已读指定之后(含)的消息
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/one", + "title": "11. 获取单条消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/read", + "title": "12. 已读聊天消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__read", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "消息ID(组)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/readlist", + "title": "21. 获取消息阅读情况", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__readlist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID(需要是消息的发送人)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/search", + "title": "10. 搜索消息位置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "搜索关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendanon", + "title": "20. 发送匿名消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendanon", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对方会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendfile", + "title": "17. 文件上传", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfile", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "image_attachment", + "description": "图片是否也存到附件
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendfiles", + "title": "18. 群发文件上传", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfile", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user_ids", + "description": "用户ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "dialog_ids", + "description": "对话ID(user_ids 二选一)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "image_attachment", + "description": "图片是否也存到附件
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/sendfileid", + "title": "19. 通过文件ID发送文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfileid", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "dialogids", + "description": "转发给的对话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "转发给的成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendrecord", + "title": "16. 发送语音", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendrecord", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "base64", + "description": "语音base64
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "duration", + "description": "语音时长(毫秒)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendtext", + "title": "15. 发送消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendtext", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "text_type", + "description": "消息类型
更新消息ID(优先大于 reply_id)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "update_mark", + "description": "是否更新标记
回复ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "silence", + "description": "是否静默发送
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/silence", + "title": "26. 消息免打扰", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__silence", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/stream", + "title": "14. 通知成员监听消息", + "description": "通知指定会员EventSource监听流动消息
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__stream", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "通知会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "stream_url", + "description": "流动消息地址
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/tag", + "title": "29. 标注/取消标注", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__tag", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/todo", + "title": "30. 设待办/取消待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__todo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "设待办对象
会员ID组(type=user有效,格式: [userid1, userid2, userid3])
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/todolist", + "title": "31. 获取消息待办情况", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__todolist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/unread", + "title": "13. 获取未读消息数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__unread", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"id\": 43,\n \"unread\": 308,\n \"mention\": 11,\n \"user_at\": \"2020-12-12 00:00:00.000\",\n \"user_ms\": 1677558147167,\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/withdraw", + "title": "24. 聊天消息撤回", + "description": "消息撤回限制24小时内,需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__withdraw", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/okr/add", + "title": "41. 创建OKR评论会话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "okr__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "标题
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "link_id", + "description": "关联id
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/okr/push", + "title": "42. 推送OKR相关信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "okr__push", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "发送内容
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/one", + "title": "03. 获取单个会话信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/open/user", + "title": "08. 打开会话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "open__user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对话会员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/search", + "title": "02. 搜索会话", + "description": "根据消息关键词搜索相关会话,需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "消息关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/tel", + "title": "07. 获取对方联系电话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "tel", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/todo", + "title": "05. 获取会话待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "todo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/top", + "title": "06. 会话置顶", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "top", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/user", + "title": "04. 获取会话成员", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "getuser", + "description": "获取会员详情(1: 返回会员昵称、邮箱等基本信息,0: 默认不返回)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/file/add", + "title": "04. 添加、修改文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "文件类型
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "文件ID(赋值修改文件名称)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content", + "title": "08. 获取文件内容", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number|String", + "optional": false, + "field": "id", + "description": "仅获取update_at字段
直接下载
读取历史记录ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/history", + "title": "13. 获取内容历史", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__history", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/office", + "title": "11. 保存文件内容(office)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__office", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/restore", + "title": "14. 恢复文件历史", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__restore", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "history_id", + "description": "历史数据ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/save", + "title": "09. 保存文件内容", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "D", + "description": "Request Payload 提交
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/upload", + "title": "12. 保存文件内容(上传文件)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__upload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/copy", + "title": "05. 复制文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "copy", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/download/confirm", + "title": "20. 确认下载", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "download__confirm", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "下载文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/download/pack", + "title": "19. 打包文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "download__pack", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "ids", + "description": "文件ID,格式: [id, id2, id3]
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "下载文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/link", + "title": "18. 获取链接", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "link", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "refresh", + "description": "刷新链接
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/lists", + "title": "01. 获取文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/move", + "title": "06. 移动文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "move", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Numbers", + "optional": false, + "field": "ids", + "description": "文件ID(格式:[id1, id2])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "pid", + "description": "移动到的文件夹ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/office/token", + "title": "10. 获取token", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "office__token", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "array", + "optional": false, + "field": "config", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/one", + "title": "02. 获取单条数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number|String", + "optional": false, + "field": "id", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/remove", + "title": "07. 删除文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Numbers", + "optional": false, + "field": "ids", + "description": "文件ID(格式:[id1, id2])
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/search", + "title": "03. 搜索文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "link", + "description": "通过分享地址搜索(如:https://t.hitosea.com/single/file/ODcwOCwzOSxpa0JBS2lmVQ==)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share", + "title": "15. 获取共享信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share/out", + "title": "17. 退出共享", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share__out", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share/update", + "title": "16. 设置共享", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "共享成员,格式: [userid1, userid2, userid3]
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "permission", + "description": "共享方式
设置共享时是否忽略提醒
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/project/add", + "title": "03. 添加项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "columns", + "description": "列表,格式:列表名称1,列表名称2
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "flow", + "description": "开启流程
个人项目,注册成功时创建(仅支持创建一个个人项目)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/archived", + "title": "12. 归档项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "archived", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/add", + "title": "15. 添加任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "列表名称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/lists", + "title": "14. 获取任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/one", + "title": "18. 获取任务列详细", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "column__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "deleted", + "description": "是否读取已删除
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/remove", + "title": "17. 删除任务列表", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "column__remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID(留空为添加列表)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/update", + "title": "16. 修改任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "列表名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/exit", + "title": "11. 退出项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "exit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/flow/delete", + "title": "41. 删除工作流", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "flow__delete", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/flow/list", + "title": "39. 工作流列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "flow__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/flow/save", + "title": "40. 保存工作流", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "flow__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "flows", + "description": "工作流数据
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite", + "title": "06. 获取邀请链接", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "invite", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "refresh", + "description": "刷新链接
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite/info", + "title": "07. 通过邀请链接code获取项目信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "invite__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite/join", + "title": "08. 通过邀请链接code加入项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "invite__join", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/lists", + "title": "01. 获取项目列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "all", + "description": "是否查看所有项目(限制管理员)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "项目类型
归档状态
同时取列表
同时取成员ID
同时取任务统计
搜索条件
时间范围(如:1678248944,1678248944)
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "sampleData:", + "content": "{\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"🏢 产品官网项目\",\n \"desc\": \"设置各小组成员的工作列表,各自领取或领导分配任务,将做好的任务分期归档,方便复盘!\",\n \"userid\": 1,\n \"dialog_id\": 15,\n \"archived_at\": null,\n \"archived_userid\": 0,\n \"created_at\": \"2022-01-02 06:23:15\",\n \"updated_at\": \"2022-01-02 07:12:33\",\n\n \"owner\": 1, // 是否项目负责人\n \"owner_userid\": 1, // 项目负责人ID\n\n \"task_num\": 9,\n \"task_complete\": 0,\n \"task_percent\": 0,\n \"task_my_num\": 8,\n \"task_my_complete\": 0,\n \"task_my_percent\": 0,\n },\n ],\n \"current_page\": 1, // 当前页数\n \"last_page\": 1, // 下一页数\n \"total\": 6, // 总计数(当前查询条件)\n \"total_all\": 6 // 总计数(全部)\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/log/lists", + "title": "42. 获取项目、任务日志", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "log__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID(与 项目ID 二选一,任务ID优先)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/one", + "title": "02. 获取一个项目信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "sampleData:", + "content": "{\n \"id\": 7,\n \"name\": \"🏢 产品官网项目\",\n \"desc\": \"设置各小组成员的工作列表,各自领取或领导分配任务,将做好的任务分期归档,方便复盘!\",\n \"userid\": 1,\n \"dialog_id\": 15,\n \"archived_at\": null,\n \"archived_userid\": 0,\n \"created_at\": \"2022-01-02 06:23:15\",\n \"updated_at\": \"2022-01-02 07:12:33\",\n\n \"owner\": 1, // 是否项目负责人\n \"owner_userid\": 1, // 项目负责人ID\n\n \"project_user\": [ // 项目成员\n {\n \"id\": 2,\n \"project_id\": 2,\n \"userid\": 1,\n \"owner\": 1,\n \"created_at\": \"2022-01-02 00:55:32\",\n \"updated_at\": \"2022-01-02 00:55:32\"\n }\n ],\n\n \"task_num\": 9,\n \"task_complete\": 0,\n \"task_percent\": 0,\n \"task_my_num\": 8,\n \"task_my_complete\": 0,\n \"task_my_percent\": 0,\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/remove", + "title": "13. 删除项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/sort", + "title": "10. 排序任务", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "sort", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "sort", + "description": "排序数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "only_column", + "description": "仅更新列表
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/task/add", + "title": "30. 添加任务", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "mixed", + "optional": true, + "field": "column_id", + "description": "列表ID,任意值自动创建,留空取第一个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "owner", + "description": "负责人
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "subtasks", + "description": "子任务(格式:[{name,owner,times}])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "top", + "description": "添加的任务排到列表最前面
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/addsub", + "title": "31. 添加子任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__addsub", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/archived", + "title": "34. 归档任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__archived", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/content", + "title": "25. 获取任务详细描述", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__content", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/dialog", + "title": "33. 创建/获取聊天室", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__dialog", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/down", + "title": "23. 下载导出的任务", + "version": "1.0.0", + "group": "project", + "name": "task__down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/easylists", + "title": "20. 任务列表-简单的", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__easylists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "taskid", + "description": "排除的任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "userid", + "description": "用户ID(如:1,2)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:2022-03-01 12:12:12,2022-05-01 12:12:12)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/export", + "title": "21. 导出任务(限管理员)", + "description": "导出指定范围任务(已完成、未完成、已归档),返回下载地址,需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__export", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userid", + "description": "指定会员,如:[1, 2]
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/exportoverdue", + "title": "22. 导出超期任务(限管理员)", + "description": "导出指定范围任务(已完成、未完成、已归档),返回下载地址,需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__exportoverdue", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedelete", + "title": "27. 删除任务文件", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__filedelete", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedetail", + "title": "28. 获取任务文件详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__filedetail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "only_update_at", + "description": "仅获取update_at字段
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedown", + "title": "29. 下载任务文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__filedown", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "down", + "description": "直接下载
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/files", + "title": "26. 获取任务文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__files", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/flow", + "title": "37. 任务工作流信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__flow", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/lists", + "title": "19. 任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "主任务ID(project_id && parent_id ≤ 0 时 仅查询自己参与的任务)
指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:1678248944,1678248944)
归档状态
是否读取已删除
排序方式
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/move", + "title": "38. 任务移动", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__move", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/one", + "title": "24. 获取单个任务信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "archived", + "description": "归档状态
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/remove", + "title": "35. 删除任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/resetfromlog", + "title": "36. 根据日志重置任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__resetfromlog", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/task/update", + "title": "32. 修改任务、子任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "loop", + "description": "重复周期,数字代表天数(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "owner", + "description": "修改负责人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "背景色(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "assist", + "description": "修改协助人员(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "visibility_appointor", + "description": "修改可见性人员
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "p_level", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_name", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_color", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "flow_item_id", + "description": "任务状态,工作流状态ID
" + }, + { + "group": "Parameter", + "type": "String|false", + "optional": true, + "field": "complete_at", + "description": "完成时间(如:2020-01-01 00:00,false表示未完成)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/top", + "title": "43. 项目置顶", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "top", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/transfer", + "title": "09. 移交项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "transfer", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "新的项目负责人ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/update", + "title": "04. 修改项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/user", + "title": "05. 修改项目成员", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID 或 成员ID组
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/report/detail", + "title": "05. 报告详情", + "version": "1.0.0", + "group": "report", + "name": "detail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "报告id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/last_submitter", + "title": "07. 获取最后一次提交的接收人", + "version": "1.0.0", + "group": "report", + "name": "last_submitter", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/mark", + "title": "06. 标记已读/未读", + "version": "1.0.0", + "group": "report", + "name": "mark", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "报告id(组)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "action", + "description": "操作
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/my", + "title": "01. 我发送的汇报", + "version": "1.0.0", + "group": "report", + "name": "my", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/read", + "title": "09. 标记汇报已读,可批量", + "version": "1.0.0", + "group": "report", + "name": "read", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "ids", + "description": "报告id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/receive", + "title": "02. 我接收的汇报", + "version": "1.0.0", + "group": "report", + "name": "receive", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/store", + "title": "03. 保存并发送工作汇报", + "version": "1.0.0", + "group": "report", + "name": "store", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "汇报ID,0为新建
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sign", + "description": "唯一签名,通过[api/report/template]接口返回
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "title", + "description": "汇报标题
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "type", + "description": "汇报类型,weekly:周报,daily:日报
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "content", + "description": "内容
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "receive", + "description": "汇报对象
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "offset", + "description": "时间偏移量
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/template", + "title": "04. 生成汇报模板", + "version": "1.0.0", + "group": "report", + "name": "template", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "type", + "description": "汇报类型,weekly:周报,daily:日报
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "offset", + "description": "偏移量
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "date", + "description": "时间
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/unread", + "title": "08. 获取未读", + "version": "1.0.0", + "group": "report", + "name": "unread", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/system/checkin/down", + "title": "23. 下载导出的签到数据", + "version": "1.0.0", + "group": "system", + "name": "checkin__down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/checkin/export", + "title": "22. 导出签到数据(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "checkin__export", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userid", + "description": "指定会员,如:[1, 2]
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "date", + "description": "指定日期范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['09:00', '18:00']
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/column/template", + "title": "10. 创建项目模板", + "description": "获取创建项目模板、保存创建项目模板
", + "version": "1.0.0", + "group": "system", + "name": "column__template", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "优先级数据,格式:[{name,columns}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/demo", + "title": "08. 获取演示帐号", + "version": "1.0.0", + "group": "system", + "name": "demo", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/approve/down", + "title": "19. 下载导出的审批数据", + "version": "1.0.0", + "group": "system", + "name": "down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/email/check", + "title": "21. 邮件发送测试(限管理员)", + "description": "测试配置邮箱是否能发送邮件
", + "version": "1.0.0", + "group": "system", + "name": "email__check", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/fileupload", + "title": "19. 上传文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "fileupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/cnip", + "title": "14. 是否中国IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__cnip", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/info", + "title": "12. 获取终端详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "key值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ip", + "title": "13. 获取IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__ip", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipgcj02", + "title": "15. 获取IP地址经纬度", + "version": "1.0.0", + "group": "system", + "name": "get__ipgcj02", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipinfo", + "title": "16. 获取IP地址详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__ipinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/updatelog", + "title": "20. 获取更新日志", + "description": "获取更新日志
", + "version": "1.0.0", + "group": "system", + "name": "get__updatelog", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/imgupload", + "title": "17. 上传图片", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "File", + "optional": false, + "field": "image", + "description": "post-图片对象
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-图片base64(与'image'二选一)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "post-文件名
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "width", + "description": "压缩图片宽(默认0)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "height", + "description": "压缩图片高(默认0)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "whcut", + "description": "压缩方式
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/imgview", + "title": "18. 浏览图片空间", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgview", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "path", + "description": "路径
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/license", + "title": "11. License", + "description": "获取License信息、保存License(限管理员)
", + "version": "1.0.0", + "group": "system", + "name": "license", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "License 原文
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/priority", + "title": "09. 任务优先级", + "description": "获取任务优先级、保存任务优先级
", + "version": "1.0.0", + "group": "system", + "name": "priority", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "优先级数据,格式:[{name,color,days,priority}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting", + "title": "01. 获取设置、保存设置", + "version": "1.0.0", + "group": "system", + "name": "setting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/aibot", + "title": "04. 获取会议设置、保存AI机器人设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__aibot", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/apppush", + "title": "06. 获取APP推送设置、保存APP推送设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__apppush", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/checkin", + "title": "05. 获取签到设置、保存签到设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__checkin", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/email", + "title": "02. 获取邮箱设置、保存邮箱设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__email", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/meeting", + "title": "03. 获取会议设置、保存会议设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__meeting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/thirdaccess", + "title": "07. 第三方帐号(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__thirdaccess", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/approve/user/status", + "title": "20. 获取用户审批状态", + "version": "1.0.0", + "group": "system", + "name": "user__status", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "userid", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/version", + "title": "24. 获取版本号", + "version": "1.0.0", + "group": "system", + "name": "version", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "version", + "description": "" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "publish", + "description": "" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/users/basic", + "title": "11. 获取指定会员基础信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "basic", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID(多个格式:jsonArray,一次最多50个)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "post", + "url": "api/users/bot/edit", + "title": "32. 编辑机器人", + "description": "需要token身份,编辑 我的机器人 或 管理员修改系统机器人 信息
", + "version": "1.0.0", + "group": "users", + "name": "bot__edit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "机器人ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "机器人名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "机器人头像
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "clear_day", + "description": "清理天数(仅 我的机器人)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "webhook_url", + "description": "Webhook地址(仅 我的机器人)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/bot/info", + "title": "31. 机器人信息", + "description": "需要token身份,获取我的机器人信息
", + "version": "1.0.0", + "group": "users", + "name": "bot__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "机器人ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/checkin/get", + "title": "26. 获取签到设置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__get", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/checkin/list", + "title": "28. 获取签到数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ym", + "description": "年-月(如:2020-01)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "before", + "description": "取月份之前的数据(单位:月数,最大3)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "post", + "url": "api/users/checkin/save", + "title": "27. 保存签到设置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "list", + "description": "优先级数据,格式:[{mac,remark}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/delete/account", + "title": "22. 删除帐号", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "delete__account", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "帐号邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "邮箱验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "reason", + "description": "注销理由
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "登录密码
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/add", + "title": "24. 新建、修改部门(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "部门id,留空为创建部门
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "部门名称
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "上级部门ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "部门负责人ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "dialog_group", + "description": "部门群(仅创建部门时有效)
使用现有群ID(dialog_group=use时有效)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/del", + "title": "25. 删除部门(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__del", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "部门id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/list", + "title": "23. 部门列表(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__list", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/edit", + "title": "21. 修改邮箱", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "edit__email", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newEmail", + "description": "新邮箱地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "邮箱验证码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editdata", + "title": "08. 修改自己的资料", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editdata", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "userimg", + "description": "会员头像(地址)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "tel", + "description": "电话
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位/职称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editpass", + "title": "09. 修改自己的密码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editpass", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "oldpass", + "description": "旧密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newpass", + "description": "新密码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/send", + "title": "20. 发送邮箱验证码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "email__send", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "type", + "description": "邮件类型
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "邮箱地址
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/verification", + "title": "14. 邮箱验证", + "description": "不需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "email__verification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "验证参数
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/info", + "title": "07. 获取我的信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"userid\": 1,\n \"identity\": [ ],\n \"department\": [ ],\n \"az\": \"\",\n \"email\": \"admin@admin.com\",\n \"nickname\": \"admin\",\n \"userimg\": \"\",\n \"login_num\": 10,\n \"changepass\": 0,\n \"last_ip\": \"127.0.0.1\",\n \"last_at\": \"2021-06-01 12:00:00\",\n \"line_ip\": \"127.0.0.1\",\n \"line_at\": \"2021-06-01 12:00:00\",\n \"created_ip\": \"\",\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/key/client", + "title": "30. 客户端KEY", + "description": "获取客户端KEY,用于加密数据发送给服务端
", + "version": "1.0.0", + "group": "users", + "name": "key__client", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "client_id", + "description": "客户端ID(希望不变的,除非清除浏览器缓存或者卸载应用)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/lists", + "title": "12. 会员列表(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
获取签到mac地址
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login", + "title": "01. 登录、注册", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "login", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code", + "description": "登录验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code_key", + "description": "验证码通过key验证
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "invite", + "description": "注册邀请码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codeimg", + "title": "04. 验证码图片", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codeimg", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Image", + "optional": false, + "field": "data", + "description": "返回数据(直接输出图片)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codejson", + "title": "05. 验证码json", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codejson", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/needcode", + "title": "03. 是否需要验证码", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__needcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/qrcode", + "title": "02. 二维码登录", + "description": "通过二维码code登录 (或:是否登录成功)
", + "version": "1.0.0", + "group": "users", + "name": "login__qrcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
二维码 code
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/invitation", + "title": "19. 【会议】发送邀请", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__invitation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "meetingid", + "description": "频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "邀请成员
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/link", + "title": "17. 【会议】获取分享链接", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__link", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "meetingid", + "description": "频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sharekey", + "description": "分享的key
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/open", + "title": "16. 【会议】创建会议、加入会议", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__open", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sharekey", + "description": "分享的key
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "username", + "description": "用户名称
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "邀请成员
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/tourist", + "title": "18. 【会议】游客信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__tourist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "tourist_id", + "description": "游客ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/operation", + "title": "13. 操作会员(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "operation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "操作
邮箱地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "tel", + "description": "联系电话
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "password", + "description": "新的密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "checkin_macs", + "description": "自动签到mac地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "department", + "description": "部门
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "disable_time", + "description": "离职时间
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "transfer_userid", + "description": "离职交接人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "delete_reason", + "description": "删除原因
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/reg/needinvite", + "title": "06. 是否需要邀请码", + "description": "用于判断注册是否需要邀请码
", + "version": "1.0.0", + "group": "users", + "name": "reg__needinvite", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/search", + "title": "10. 搜索会员列表", + "description": "搜索会员列表
", + "version": "1.0.0", + "group": "users", + "name": "searchinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "keys", + "description": "搜索条件
排序方式
在这个时间戳之后更新的
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "state", + "description": "获取在线状态
获取数量,10-100
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1(赋值分页模式,take参数无效)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:10,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/share/list", + "title": "33. 获取分享列表", + "version": "1.0.0", + "group": "users", + "name": "share__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "分享类型:file-文件,text-列表 默认file
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级文件id,用于获取子目录和上传到指定目录的id
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "upload_file_id", + "description": "上传文件id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/socket/status", + "title": "29. 获取socket状态", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "socket__status", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "fd", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/umeng/alias", + "title": "15. 设置友盟别名", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "umeng__alias", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "alias", + "description": "别名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/approve/verifyToken", + "title": "01. 验证APi登录", + "version": "1.0.0", + "group": "users", + "name": "verifyToken", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "version", + "description": "" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "publish", + "description": "" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "会员" + } +] }); diff --git a/public/docs/api_data.json b/public/docs/api_data.json new file mode 100644 index 000000000..849ddb8f8 --- /dev/null +++ b/public/docs/api_data.json @@ -0,0 +1,10888 @@ +[ + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/PublicController.php", + "group": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "groupTitle": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "name": "" + }, + { + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "mac", + "description": "使用逗号分割多个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "time", + "description": "" + } + ] + } + }, + "type": "", + "url": "", + "version": "0.0.0", + "filename": "app/Http/Controllers/Api/PublicController.php", + "group": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "groupTitle": "/Users/GAOYI/wwwroot/dootask/app/Http/Controllers/Api/PublicController.php", + "name": "" + }, + { + "type": "post", + "url": "api/approve/export", + "title": "18. 导出数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "export", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/identitylinkHistory/findParticipant", + "title": "16. 查询流程实例的参与者(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "identitylinkHistory__findParticipant", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/identitylink/findParticipant", + "title": "12. 查询流程实例的参与者(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "identitylink__findParticipant", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/findProcNotify", + "title": "15. 查询抄送我的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__findProcNotify", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/findTask", + "title": "13. 查询需要我审批的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__findTask", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procHistory/startByMyself", + "title": "14. 查询我启动的流程(已结束)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procHistory__startByMyself", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/procdef/all", + "title": "02. 查询流程定义", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procdef__all", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/procdef/del", + "title": "03. 删除流程定义", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "procdef__del", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/addGlobalComment", + "title": "05. 添加全局评论", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__addGlobalComment", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/approve/process/detail", + "title": "17. 根据流程ID查询流程详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__detail", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/findProcNotify", + "title": "11. 查询抄送我的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__findProcNotify", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/findTask", + "title": "08. 查询需要我审批的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__findTask", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/start", + "title": "04. 启动流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__start", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/startByMyself", + "title": "10. 查询我启动的流程(审批中)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__startByMyself", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/process/startByMyselfAll", + "title": "09. 查询我启动的流程(全部)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "process__startByMyselfAll", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/task/complete", + "title": "06. 审批", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "task__complete", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "post", + "url": "api/approve/task/withdraw", + "title": "07. 撤回", + "description": "需要token身份
", + "version": "1.0.0", + "group": "approve", + "name": "task__withdraw", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "工作流" + }, + { + "type": "get", + "url": "api/dialog/group/add", + "title": "34. 新增群组", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "group__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "群头像
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "chat_name", + "description": "群名称
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/adduser", + "title": "36. 添加群成员", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "新增的群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/deluser", + "title": "37. 移出(退出)群成员", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "移出的群成员,格式: [userid1, userid2, userid3]
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/disband", + "title": "39. 解散群组", + "description": "需要token身份
会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/edit", + "title": "35. 修改群组", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "group__edit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "群头像
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "chat_name", + "description": "群名称
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "admin", + "description": "系统管理员操作(1:只判断是不是系统管理员,否则判断是否群管理员)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/searchuser", + "title": "40. 搜索个人群(仅限管理员)", + "description": "需要token身份,用于创建部门搜索个人群组
", + "version": "1.0.0", + "group": "dialog", + "name": "group__searchuser", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/group/transfer", + "title": "38. 转让群组", + "description": "需要token身份
会话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "新的群主
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/lists", + "title": "01. 对话列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:1678248944,1678248944)
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/color", + "title": "33. 设置颜色", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__color", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/detail", + "title": "22. 消息详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__detail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "only_update_at", + "description": "仅获取update_at字段
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/done", + "title": "32. 完成待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__done", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "待办数据ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/download", + "title": "23. 文件下载", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__download", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "down", + "description": "直接下载
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/emoji", + "title": "28. emoji回复", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__emoji", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "symbol", + "description": "回复或取消的emoji表情
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/forward", + "title": "27. 转发消息给", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__forward", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "dialogids", + "description": "转发给的对话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "转发给的成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/list", + "title": "09. 获取消息列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "position_id", + "description": "此消息ID前后的数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "prev_id", + "description": "此消息ID之前的数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "next_id", + "description": "此消息ID之后的数据
消息类型
获取条数,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/mark", + "title": "25. 消息标记操作", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__mark", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
仅标记已读指定之后(含)的消息
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/one", + "title": "11. 获取单条消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/read", + "title": "12. 已读聊天消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__read", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "消息ID(组)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/readlist", + "title": "21. 获取消息阅读情况", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__readlist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID(需要是消息的发送人)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/search", + "title": "10. 搜索消息位置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "搜索关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendanon", + "title": "20. 发送匿名消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendanon", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对方会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendfile", + "title": "17. 文件上传", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfile", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "image_attachment", + "description": "图片是否也存到附件
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendfiles", + "title": "18. 群发文件上传", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfile", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "user_ids", + "description": "用户ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "dialog_ids", + "description": "对话ID(user_ids 二选一)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "image_attachment", + "description": "图片是否也存到附件
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "filename", + "description": "post-文件名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-base64图片(二选一)
" + }, + { + "group": "Parameter", + "type": "File", + "optional": true, + "field": "files", + "description": "post-文件对象(二选一)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/sendfileid", + "title": "19. 通过文件ID发送文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendfileid", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "dialogids", + "description": "转发给的对话ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "转发给的成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendrecord", + "title": "16. 发送语音", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendrecord", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "reply_id", + "description": "回复ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "base64", + "description": "语音base64
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "duration", + "description": "语音时长(毫秒)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/sendtext", + "title": "15. 发送消息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__sendtext", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "消息内容
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "text_type", + "description": "消息类型
更新消息ID(优先大于 reply_id)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "update_mark", + "description": "是否更新标记
回复ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "silence", + "description": "是否静默发送
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/silence", + "title": "26. 消息免打扰", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__silence", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/msg/stream", + "title": "14. 通知成员监听消息", + "description": "通知指定会员EventSource监听流动消息
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__stream", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "通知会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "stream_url", + "description": "流动消息地址
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/tag", + "title": "29. 标注/取消标注", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__tag", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/todo", + "title": "30. 设待办/取消待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__todo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "设待办对象
会员ID组(type=user有效,格式: [userid1, userid2, userid3])
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/todolist", + "title": "31. 获取消息待办情况", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__todolist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/unread", + "title": "13. 获取未读消息数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__unread", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"id\": 43,\n \"unread\": 308,\n \"mention\": 11,\n \"user_at\": \"2020-12-12 00:00:00.000\",\n \"user_ms\": 1677558147167,\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/msg/withdraw", + "title": "24. 聊天消息撤回", + "description": "消息撤回限制24小时内,需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "msg__withdraw", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "msg_id", + "description": "消息ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/okr/add", + "title": "41. 创建OKR评论会话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "okr__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "标题
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "link_id", + "description": "关联id
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "群成员,格式: [userid1, userid2, userid3]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "post", + "url": "api/dialog/okr/push", + "title": "42. 推送OKR相关信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "okr__push", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "text", + "description": "发送内容
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/one", + "title": "03. 获取单个会话信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "对话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/open/user", + "title": "08. 打开会话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "open__user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "对话会员ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/search", + "title": "02. 搜索会话", + "description": "根据消息关键词搜索相关会话,需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "消息关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/tel", + "title": "07. 获取对方联系电话", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "tel", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/todo", + "title": "05. 获取会话待办", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "todo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/top", + "title": "06. 会话置顶", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "top", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/dialog/user", + "title": "04. 获取会话成员", + "description": "需要token身份
", + "version": "1.0.0", + "group": "dialog", + "name": "user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "dialog_id", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "getuser", + "description": "获取会员详情(1: 返回会员昵称、邮箱等基本信息,0: 默认不返回)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/DialogController.php", + "groupTitle": "对话" + }, + { + "type": "get", + "url": "api/file/add", + "title": "04. 添加、修改文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "文件类型
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "文件ID(赋值修改文件名称)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content", + "title": "08. 获取文件内容", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number|String", + "optional": false, + "field": "id", + "description": "仅获取update_at字段
直接下载
读取历史记录ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/history", + "title": "13. 获取内容历史", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__history", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/office", + "title": "11. 保存文件内容(office)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__office", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/restore", + "title": "14. 恢复文件历史", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__restore", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "history_id", + "description": "历史数据ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/save", + "title": "09. 保存文件内容", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "D", + "description": "Request Payload 提交
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/content/upload", + "title": "12. 保存文件内容(上传文件)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "content__upload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/copy", + "title": "05. 复制文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "copy", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/download/confirm", + "title": "20. 确认下载", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "download__confirm", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "下载文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/download/pack", + "title": "19. 打包文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "download__pack", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "ids", + "description": "文件ID,格式: [id, id2, id3]
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "下载文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/link", + "title": "18. 获取链接", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "link", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "refresh", + "description": "刷新链接
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/lists", + "title": "01. 获取文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/move", + "title": "06. 移动文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "move", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Numbers", + "optional": false, + "field": "ids", + "description": "文件ID(格式:[id1, id2])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "pid", + "description": "移动到的文件夹ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/office/token", + "title": "10. 获取token", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "office__token", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "array", + "optional": false, + "field": "config", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/one", + "title": "02. 获取单条数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number|String", + "optional": false, + "field": "id", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/remove", + "title": "07. 删除文件(夹)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Numbers", + "optional": false, + "field": "ids", + "description": "文件ID(格式:[id1, id2])
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/search", + "title": "03. 搜索文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "search", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "link", + "description": "通过分享地址搜索(如:https://t.hitosea.com/single/file/ODcwOCwzOSxpa0JBS2lmVQ==)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "key", + "description": "关键词
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share", + "title": "15. 获取共享信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share/out", + "title": "17. 退出共享", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share__out", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/file/share/update", + "title": "16. 设置共享", + "description": "需要token身份
", + "version": "1.0.0", + "group": "file", + "name": "share__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "共享成员,格式: [userid1, userid2, userid3]
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "permission", + "description": "共享方式
设置共享时是否忽略提醒
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/FileController.php", + "groupTitle": "文件" + }, + { + "type": "get", + "url": "api/project/add", + "title": "03. 添加项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "columns", + "description": "列表,格式:列表名称1,列表名称2
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "flow", + "description": "开启流程
个人项目,注册成功时创建(仅支持创建一个个人项目)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/archived", + "title": "12. 归档项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "archived", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/add", + "title": "15. 添加任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "列表名称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/lists", + "title": "14. 获取任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:100,最大:200
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/one", + "title": "18. 获取任务列详细", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "column__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "deleted", + "description": "是否读取已删除
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/remove", + "title": "17. 删除任务列表", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "column__remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID(留空为添加列表)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/column/update", + "title": "16. 修改任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "column__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列表ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "列表名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "颜色
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/exit", + "title": "11. 退出项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "exit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/flow/delete", + "title": "41. 删除工作流", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "flow__delete", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/flow/list", + "title": "39. 工作流列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "flow__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/flow/save", + "title": "40. 保存工作流", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "flow__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "flows", + "description": "工作流数据
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite", + "title": "06. 获取邀请链接", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "invite", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "refresh", + "description": "刷新链接
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite/info", + "title": "07. 通过邀请链接code获取项目信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "invite__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/invite/join", + "title": "08. 通过邀请链接code加入项目", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "invite__join", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/lists", + "title": "01. 获取项目列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "all", + "description": "是否查看所有项目(限制管理员)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "项目类型
归档状态
同时取列表
同时取成员ID
同时取任务统计
搜索条件
时间范围(如:1678248944,1678248944)
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:50,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "sampleData:", + "content": "{\n \"data\": [\n {\n \"id\": 7,\n \"name\": \"🏢 产品官网项目\",\n \"desc\": \"设置各小组成员的工作列表,各自领取或领导分配任务,将做好的任务分期归档,方便复盘!\",\n \"userid\": 1,\n \"dialog_id\": 15,\n \"archived_at\": null,\n \"archived_userid\": 0,\n \"created_at\": \"2022-01-02 06:23:15\",\n \"updated_at\": \"2022-01-02 07:12:33\",\n\n \"owner\": 1, // 是否项目负责人\n \"owner_userid\": 1, // 项目负责人ID\n\n \"task_num\": 9,\n \"task_complete\": 0,\n \"task_percent\": 0,\n \"task_my_num\": 8,\n \"task_my_complete\": 0,\n \"task_my_percent\": 0,\n },\n ],\n \"current_page\": 1, // 当前页数\n \"last_page\": 1, // 下一页数\n \"total\": 6, // 总计数(当前查询条件)\n \"total_all\": 6 // 总计数(全部)\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/log/lists", + "title": "42. 获取项目、任务日志", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "log__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID(与 项目ID 二选一,任务ID优先)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/one", + "title": "02. 获取一个项目信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "sampleData:", + "content": "{\n \"id\": 7,\n \"name\": \"🏢 产品官网项目\",\n \"desc\": \"设置各小组成员的工作列表,各自领取或领导分配任务,将做好的任务分期归档,方便复盘!\",\n \"userid\": 1,\n \"dialog_id\": 15,\n \"archived_at\": null,\n \"archived_userid\": 0,\n \"created_at\": \"2022-01-02 06:23:15\",\n \"updated_at\": \"2022-01-02 07:12:33\",\n\n \"owner\": 1, // 是否项目负责人\n \"owner_userid\": 1, // 项目负责人ID\n\n \"project_user\": [ // 项目成员\n {\n \"id\": 2,\n \"project_id\": 2,\n \"userid\": 1,\n \"owner\": 1,\n \"created_at\": \"2022-01-02 00:55:32\",\n \"updated_at\": \"2022-01-02 00:55:32\"\n }\n ],\n\n \"task_num\": 9,\n \"task_complete\": 0,\n \"task_percent\": 0,\n \"task_my_num\": 8,\n \"task_my_complete\": 0,\n \"task_my_percent\": 0,\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/remove", + "title": "13. 删除项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/sort", + "title": "10. 排序任务", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "sort", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "sort", + "description": "排序数据
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "only_column", + "description": "仅更新列表
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/task/add", + "title": "30. 添加任务", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "mixed", + "optional": true, + "field": "column_id", + "description": "列表ID,任意值自动创建,留空取第一个
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "owner", + "description": "负责人
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "subtasks", + "description": "子任务(格式:[{name,owner,times}])
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "top", + "description": "添加的任务排到列表最前面
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/addsub", + "title": "31. 添加子任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__addsub", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "任务描述
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/archived", + "title": "34. 归档任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__archived", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/content", + "title": "25. 获取任务详细描述", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__content", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/dialog", + "title": "33. 创建/获取聊天室", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__dialog", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/down", + "title": "23. 下载导出的任务", + "version": "1.0.0", + "group": "project", + "name": "task__down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/easylists", + "title": "20. 任务列表-简单的", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__easylists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "taskid", + "description": "排除的任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "userid", + "description": "用户ID(如:1,2)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:2022-03-01 12:12:12,2022-05-01 12:12:12)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/export", + "title": "21. 导出任务(限管理员)", + "description": "导出指定范围任务(已完成、未完成、已归档),返回下载地址,需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__export", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userid", + "description": "指定会员,如:[1, 2]
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/exportoverdue", + "title": "22. 导出超期任务(限管理员)", + "description": "导出指定范围任务(已完成、未完成、已归档),返回下载地址,需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__exportoverdue", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedelete", + "title": "27. 删除任务文件", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__filedelete", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedetail", + "title": "28. 获取任务文件详情", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__filedetail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "only_update_at", + "description": "仅获取update_at字段
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/filedown", + "title": "29. 下载任务文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__filedown", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "file_id", + "description": "文件ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "down", + "description": "直接下载
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/files", + "title": "26. 获取任务文件列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__files", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/flow", + "title": "37. 任务工作流信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__flow", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/lists", + "title": "19. 任务列表", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "主任务ID(project_id && parent_id ≤ 0 时 仅查询自己参与的任务)
指定时间范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "timerange", + "description": "时间范围(如:1678248944,1678248944)
归档状态
是否读取已删除
排序方式
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/move", + "title": "38. 任务移动", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__move", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "column_id", + "description": "列ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/one", + "title": "24. 获取单个任务信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "task__one", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "archived", + "description": "归档状态
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/remove", + "title": "35. 删除任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__remove", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/task/resetfromlog", + "title": "36. 根据日志重置任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__resetfromlog", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "post", + "url": "api/project/task/update", + "title": "32. 修改任务、子任务", + "description": "需要token身份(限:项目、任务负责人)
", + "version": "1.0.0", + "group": "project", + "name": "task__update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "task_id", + "description": "任务ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "任务描述
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "times", + "description": "计划时间(格式:开始时间,结束时间;如:2020-01-01 00:00,2020-01-01 23:59)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "loop", + "description": "重复周期,数字代表天数(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "owner", + "description": "修改负责人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "content", + "description": "任务详情(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "color", + "description": "背景色(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "assist", + "description": "修改协助人员(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "visibility_appointor", + "description": "修改可见性人员
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "p_level", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_name", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "p_color", + "description": "优先级相关(子任务不支持)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "flow_item_id", + "description": "任务状态,工作流状态ID
" + }, + { + "group": "Parameter", + "type": "String|false", + "optional": true, + "field": "complete_at", + "description": "完成时间(如:2020-01-01 00:00,false表示未完成)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/top", + "title": "43. 项目置顶", + "description": "需要token身份
", + "version": "1.0.0", + "group": "project", + "name": "top", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/transfer", + "title": "09. 移交项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "transfer", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "新的项目负责人ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/update", + "title": "04. 修改项目", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "update", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "项目名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "desc", + "description": "项目介绍
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/project/user", + "title": "05. 修改项目成员", + "description": "需要token身份(限:项目负责人)
", + "version": "1.0.0", + "group": "project", + "name": "user", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "project_id", + "description": "项目ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "成员ID 或 成员ID组
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ProjectController.php", + "groupTitle": "项目" + }, + { + "type": "get", + "url": "api/report/detail", + "title": "05. 报告详情", + "version": "1.0.0", + "group": "report", + "name": "detail", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "报告id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/last_submitter", + "title": "07. 获取最后一次提交的接收人", + "version": "1.0.0", + "group": "report", + "name": "last_submitter", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/mark", + "title": "06. 标记已读/未读", + "version": "1.0.0", + "group": "report", + "name": "mark", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "报告id(组)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "action", + "description": "操作
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/my", + "title": "01. 我发送的汇报", + "version": "1.0.0", + "group": "report", + "name": "my", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/read", + "title": "09. 标记汇报已读,可批量", + "version": "1.0.0", + "group": "report", + "name": "read", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "ids", + "description": "报告id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/receive", + "title": "02. 我接收的汇报", + "version": "1.0.0", + "group": "report", + "name": "receive", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/store", + "title": "03. 保存并发送工作汇报", + "version": "1.0.0", + "group": "report", + "name": "store", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "汇报ID,0为新建
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sign", + "description": "唯一签名,通过[api/report/template]接口返回
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "title", + "description": "汇报标题
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "type", + "description": "汇报类型,weekly:周报,daily:日报
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "content", + "description": "内容
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "receive", + "description": "汇报对象
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "offset", + "description": "时间偏移量
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/template", + "title": "04. 生成汇报模板", + "version": "1.0.0", + "group": "report", + "name": "template", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "type", + "description": "汇报类型,weekly:周报,daily:日报
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "offset", + "description": "偏移量
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "date", + "description": "时间
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/report/unread", + "title": "08. 获取未读", + "version": "1.0.0", + "group": "report", + "name": "unread", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ReportController.php", + "groupTitle": "汇报" + }, + { + "type": "get", + "url": "api/system/checkin/down", + "title": "23. 下载导出的签到数据", + "version": "1.0.0", + "group": "system", + "name": "checkin__down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/checkin/export", + "title": "22. 导出签到数据(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "checkin__export", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userid", + "description": "指定会员,如:[1, 2]
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "date", + "description": "指定日期范围,如:['2020-12-12', '2020-12-30']
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "time", + "description": "指定时间范围,如:['09:00', '18:00']
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/column/template", + "title": "10. 创建项目模板", + "description": "获取创建项目模板、保存创建项目模板
", + "version": "1.0.0", + "group": "system", + "name": "column__template", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "优先级数据,格式:[{name,columns}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/demo", + "title": "08. 获取演示帐号", + "version": "1.0.0", + "group": "system", + "name": "demo", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/approve/down", + "title": "19. 下载导出的审批数据", + "version": "1.0.0", + "group": "system", + "name": "down", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "通过export接口得到的下载钥匙
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "File", + "optional": false, + "field": "data", + "description": "返回数据(直接下载文件)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/email/check", + "title": "21. 邮件发送测试(限管理员)", + "description": "测试配置邮箱是否能发送邮件
", + "version": "1.0.0", + "group": "system", + "name": "email__check", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/fileupload", + "title": "19. 上传文件", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "fileupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "图片base64
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "文件名
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "files", + "description": "文件名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/cnip", + "title": "14. 是否中国IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__cnip", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/info", + "title": "12. 获取终端详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "key", + "description": "key值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ip", + "title": "13. 获取IP地址", + "version": "1.0.0", + "group": "system", + "name": "get__ip", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipgcj02", + "title": "15. 获取IP地址经纬度", + "version": "1.0.0", + "group": "system", + "name": "get__ipgcj02", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/ipinfo", + "title": "16. 获取IP地址详细信息", + "version": "1.0.0", + "group": "system", + "name": "get__ipinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ip", + "description": "IP值
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/updatelog", + "title": "20. 获取更新日志", + "description": "获取更新日志
", + "version": "1.0.0", + "group": "system", + "name": "get__updatelog", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/imgupload", + "title": "17. 上传图片", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgupload", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "File", + "optional": false, + "field": "image", + "description": "post-图片对象
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "image64", + "description": "post-图片base64(与'image'二选一)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "filename", + "description": "post-文件名
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "width", + "description": "压缩图片宽(默认0)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "height", + "description": "压缩图片高(默认0)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "whcut", + "description": "压缩方式
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/get/imgview", + "title": "18. 浏览图片空间", + "description": "需要token身份
", + "version": "1.0.0", + "group": "system", + "name": "imgview", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "path", + "description": "路径
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/license", + "title": "11. License", + "description": "获取License信息、保存License(限管理员)
", + "version": "1.0.0", + "group": "system", + "name": "license", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "License 原文
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "post", + "url": "api/system/priority", + "title": "09. 任务优先级", + "description": "获取任务优先级、保存任务优先级
", + "version": "1.0.0", + "group": "system", + "name": "priority", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "优先级数据,格式:[{name,color,days,priority}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting", + "title": "01. 获取设置、保存设置", + "version": "1.0.0", + "group": "system", + "name": "setting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/aibot", + "title": "04. 获取会议设置、保存AI机器人设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__aibot", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/apppush", + "title": "06. 获取APP推送设置、保存APP推送设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__apppush", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/checkin", + "title": "05. 获取签到设置、保存签到设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__checkin", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/email", + "title": "02. 获取邮箱设置、保存邮箱设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__email", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/meeting", + "title": "03. 获取会议设置、保存会议设置(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__meeting", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/setting/thirdaccess", + "title": "07. 第三方帐号(限管理员)", + "version": "1.0.0", + "group": "system", + "name": "setting__thirdaccess", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/approve/user/status", + "title": "20. 获取用户审批状态", + "version": "1.0.0", + "group": "system", + "name": "user__status", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "userid", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/system/version", + "title": "24. 获取版本号", + "version": "1.0.0", + "group": "system", + "name": "version", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "version", + "description": "" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "publish", + "description": "" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/SystemController.php", + "groupTitle": "系统" + }, + { + "type": "get", + "url": "api/users/basic", + "title": "11. 获取指定会员基础信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "basic", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID(多个格式:jsonArray,一次最多50个)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "post", + "url": "api/users/bot/edit", + "title": "32. 编辑机器人", + "description": "需要token身份,编辑 我的机器人 或 管理员修改系统机器人 信息
", + "version": "1.0.0", + "group": "users", + "name": "bot__edit", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "机器人ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "机器人名称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "avatar", + "description": "机器人头像
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "clear_day", + "description": "清理天数(仅 我的机器人)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "webhook_url", + "description": "Webhook地址(仅 我的机器人)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/bot/info", + "title": "31. 机器人信息", + "description": "需要token身份,获取我的机器人信息
", + "version": "1.0.0", + "group": "users", + "name": "bot__info", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "机器人ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/checkin/get", + "title": "26. 获取签到设置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__get", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/checkin/list", + "title": "28. 获取签到数据", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "ym", + "description": "年-月(如:2020-01)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "before", + "description": "取月份之前的数据(单位:月数,最大3)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "post", + "url": "api/users/checkin/save", + "title": "27. 保存签到设置", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "checkin__save", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "list", + "description": "优先级数据,格式:[{mac,remark}]
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/delete/account", + "title": "22. 删除帐号", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "delete__account", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "帐号邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "邮箱验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "reason", + "description": "注销理由
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "登录密码
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "type", + "description": "类型
返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/add", + "title": "24. 新建、修改部门(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__add", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "id", + "description": "部门id,留空为创建部门
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "name", + "description": "部门名称
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "parent_id", + "description": "上级部门ID
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "owner_userid", + "description": "部门负责人ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "dialog_group", + "description": "部门群(仅创建部门时有效)
使用现有群ID(dialog_group=use时有效)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/del", + "title": "25. 删除部门(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__del", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "id", + "description": "部门id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/department/list", + "title": "23. 部门列表(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "department__list", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/edit", + "title": "21. 修改邮箱", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "edit__email", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newEmail", + "description": "新邮箱地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "邮箱验证码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editdata", + "title": "08. 修改自己的资料", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editdata", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "userimg", + "description": "会员头像(地址)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "tel", + "description": "电话
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位/职称
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/editpass", + "title": "09. 修改自己的密码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "editpass", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "oldpass", + "description": "旧密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "newpass", + "description": "新密码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/send", + "title": "20. 发送邮箱验证码", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "email__send", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "type", + "description": "邮件类型
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "邮箱地址
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/email/verification", + "title": "14. 邮箱验证", + "description": "不需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "email__verification", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "code", + "description": "验证参数
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/info", + "title": "07. 获取我的信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "info", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + }, + "examples": [ + { + "title": "data:", + "content": "{\n \"userid\": 1,\n \"identity\": [ ],\n \"department\": [ ],\n \"az\": \"\",\n \"email\": \"admin@admin.com\",\n \"nickname\": \"admin\",\n \"userimg\": \"\",\n \"login_num\": 10,\n \"changepass\": 0,\n \"last_ip\": \"127.0.0.1\",\n \"last_at\": \"2021-06-01 12:00:00\",\n \"line_ip\": \"127.0.0.1\",\n \"line_at\": \"2021-06-01 12:00:00\",\n \"created_ip\": \"\",\n}", + "type": "json" + } + ] + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/key/client", + "title": "30. 客户端KEY", + "description": "获取客户端KEY,用于加密数据发送给服务端
", + "version": "1.0.0", + "group": "users", + "name": "key__client", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "client_id", + "description": "客户端ID(希望不变的,除非清除浏览器缓存或者卸载应用)
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/lists", + "title": "12. 会员列表(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "lists", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": true, + "field": "keys", + "description": "搜索条件
获取签到mac地址
当前页,默认:1
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:20,最大:50
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login", + "title": "01. 登录、注册", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "login", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
邮箱
" + }, + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "password", + "description": "密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code", + "description": "登录验证码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "code_key", + "description": "验证码通过key验证
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "invite", + "description": "注册邀请码
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据(同"获取我的信息"接口)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codeimg", + "title": "04. 验证码图片", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codeimg", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Image", + "optional": false, + "field": "data", + "description": "返回数据(直接输出图片)
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/codejson", + "title": "05. 验证码json", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__codejson", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/needcode", + "title": "03. 是否需要验证码", + "description": "用于判断是否需要登录验证码
", + "version": "1.0.0", + "group": "users", + "name": "login__needcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "email", + "description": "用户名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/login/qrcode", + "title": "02. 二维码登录", + "description": "通过二维码code登录 (或:是否登录成功)
", + "version": "1.0.0", + "group": "users", + "name": "login__qrcode", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
二维码 code
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1需要、0不需要)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/invitation", + "title": "19. 【会议】发送邀请", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__invitation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "meetingid", + "description": "频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": false, + "field": "userids", + "description": "邀请成员
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/link", + "title": "17. 【会议】获取分享链接", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__link", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "meetingid", + "description": "频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sharekey", + "description": "分享的key
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/open", + "title": "16. 【会议】创建会议、加入会议", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__open", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "type", + "description": "类型
频道ID(不是数字)
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "name", + "description": "会话ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "sharekey", + "description": "分享的key
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "username", + "description": "用户名称
" + }, + { + "group": "Parameter", + "type": "Array", + "optional": true, + "field": "userids", + "description": "邀请成员
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/meeting/tourist", + "title": "18. 【会议】游客信息", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "meeting__tourist", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "tourist_id", + "description": "游客ID
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/operation", + "title": "13. 操作会员(限管理员)", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "operation", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "userid", + "description": "会员ID
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "操作
邮箱地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "tel", + "description": "联系电话
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "password", + "description": "新的密码
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "nickname", + "description": "昵称
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "profession", + "description": "职位
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "checkin_macs", + "description": "自动签到mac地址
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "department", + "description": "部门
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "disable_time", + "description": "离职时间
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "transfer_userid", + "description": "离职交接人
" + }, + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "delete_reason", + "description": "删除原因
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/reg/needinvite", + "title": "06. 是否需要邀请码", + "description": "用于判断注册是否需要邀请码
", + "version": "1.0.0", + "group": "users", + "name": "reg__needinvite", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/search", + "title": "10. 搜索会员列表", + "description": "搜索会员列表
", + "version": "1.0.0", + "group": "users", + "name": "searchinfo", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "Object", + "optional": false, + "field": "keys", + "description": "搜索条件
排序方式
在这个时间戳之后更新的
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": false, + "field": "state", + "description": "获取在线状态
获取数量,10-100
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "page", + "description": "当前页,默认:1(赋值分页模式,take参数无效)
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pagesize", + "description": "每页显示数量,默认:10,最大:100
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/share/list", + "title": "33. 获取分享列表", + "version": "1.0.0", + "group": "users", + "name": "share__list", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "type", + "description": "分享类型:file-文件,text-列表 默认file
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "pid", + "description": "父级文件id,用于获取子目录和上传到指定目录的id
" + }, + { + "group": "Parameter", + "type": "Number", + "optional": true, + "field": "upload_file_id", + "description": "上传文件id
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/socket/status", + "title": "29. 获取socket状态", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "socket__status", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": true, + "field": "fd", + "description": "" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/users/umeng/alias", + "title": "15. 设置友盟别名", + "description": "需要token身份
", + "version": "1.0.0", + "group": "users", + "name": "umeng__alias", + "parameter": { + "fields": { + "Parameter": [ + { + "group": "Parameter", + "type": "String", + "optional": false, + "field": "alias", + "description": "别名
" + } + ] + } + }, + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "Number", + "optional": false, + "field": "ret", + "description": "返回状态码(1正确、0错误)
" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "msg", + "description": "返回信息(错误描述)
" + }, + { + "group": "Success 200", + "type": "Object", + "optional": false, + "field": "data", + "description": "返回数据
" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/UsersController.php", + "groupTitle": "会员" + }, + { + "type": "get", + "url": "api/approve/verifyToken", + "title": "01. 验证APi登录", + "version": "1.0.0", + "group": "users", + "name": "verifyToken", + "success": { + "fields": { + "Success 200": [ + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "version", + "description": "" + }, + { + "group": "Success 200", + "type": "String", + "optional": false, + "field": "publish", + "description": "" + } + ] + } + }, + "filename": "app/Http/Controllers/Api/ApproveController.php", + "groupTitle": "会员" + } +] diff --git a/public/docs/api_project.js b/public/docs/api_project.js new file mode 100644 index 000000000..9fc877f39 --- /dev/null +++ b/public/docs/api_project.js @@ -0,0 +1,19 @@ +define({ + "name": "API", + "version": "1.0.0", + "description": "APP接口文档", + "title": "APP接口", + "url": "https://你的域名/", + "template": { + "withGenerator": false + }, + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2023-12-16T15:38:24.621Z", + "url": "https://apidocjs.com", + "version": "0.25.0" + } +}); diff --git a/public/docs/api_project.json b/public/docs/api_project.json new file mode 100644 index 000000000..fb263e686 --- /dev/null +++ b/public/docs/api_project.json @@ -0,0 +1,19 @@ +{ + "name": "API", + "version": "1.0.0", + "description": "APP接口文档", + "title": "APP接口", + "url": "https://你的域名/", + "template": { + "withGenerator": false + }, + "sampleUrl": false, + "defaultVersion": "0.0.0", + "apidoc": "0.3.0", + "generator": { + "name": "apidoc", + "time": "2023-12-16T15:38:24.621Z", + "url": "https://apidocjs.com", + "version": "0.25.0" + } +} diff --git a/public/docs/assets/main.bundle.js b/public/docs/assets/main.bundle.js index 7b15aae4a..7c4673d33 100644 --- a/public/docs/assets/main.bundle.js +++ b/public/docs/assets/main.bundle.js @@ -1,8 +1,8 @@ -(()=>{var Za={2988:()=>{+function(P){"use strict";var y=".dropdown-backdrop",o='[data-toggle="dropdown"]',h=function(l){P(l).on("click.bs.dropdown",this.toggle)};h.VERSION="3.4.1";function i(l){var s=l.attr("data-target");s||(s=l.attr("href"),s=s&&/#[A-Za-z]/.test(s)&&s.replace(/.*(?=#[^\s]*$)/,""));var u=s!=="#"?P(document).find(s):null;return u&&u.length?u:l.parent()}function r(l){l&&l.which===3||(P(y).remove(),P(o).each(function(){var s=P(this),u=i(s),g={relatedTarget:this};!u.hasClass("open")||l&&l.type=="click"&&/input|textarea/i.test(l.target.tagName)&&P.contains(u[0],l.target)||(u.trigger(l=P.Event("hide.bs.dropdown",g)),!l.isDefaultPrevented()&&(s.attr("aria-expanded","false"),u.removeClass("open").trigger(P.Event("hidden.bs.dropdown",g))))}))}h.prototype.toggle=function(l){var s=P(this);if(!s.is(".disabled, :disabled")){var u=i(s),g=u.hasClass("open");if(r(),!g){"ontouchstart"in document.documentElement&&!u.closest(".navbar-nav").length&&P(document.createElement("div")).addClass("dropdown-backdrop").insertAfter(P(this)).on("click",r);var n={relatedTarget:this};if(u.trigger(l=P.Event("show.bs.dropdown",n)),l.isDefaultPrevented())return;s.trigger("focus").attr("aria-expanded","true"),u.toggleClass("open").trigger(P.Event("shown.bs.dropdown",n))}return!1}},h.prototype.keydown=function(l){if(!(!/(38|40|27|32)/.test(l.which)||/input|textarea/i.test(l.target.tagName))){var s=P(this);if(l.preventDefault(),l.stopPropagation(),!s.is(".disabled, :disabled")){var u=i(s),g=u.hasClass("open");if(!g&&l.which!=27||g&&l.which==27)return l.which==27&&u.find(o).trigger("focus"),s.trigger("click");var n=" li:not(.disabled):visible a",m=u.find(".dropdown-menu"+n);if(!!m.length){var f=m.index(l.target);l.which==38&&f>0&&f--,l.which==40&&f