开放API接口文档

群组

1.创建群组：

• 接口地址：/group/create
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
name	String	是	群名称
description	String	否	群简介
validateType	String	否	加群验证：例如：允许任何人加入：any_one_join 申请加入：apply_join 不允许任何人加入：no_one_join

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":
        {
            "groupName": "",
            "groupId": ""
        }
 }

2.群信息修改：

• 接口地址：/group/change
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
name	String	是	群名称
description	String	否	群简介
validateType	String	否	加群验证：例如：允许任何人加入：any_one_join 申请加入：apply_join 不允许任何人加入：no_one_join

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

群组文件夹

1.创建文件夹：

• 接口地址：/group/dir/create
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
name	String	是	文件夹名称
parentId	Long	否	父级目录ID ：文件夹下上传，则父目录ID为文件夹ID,群组根目录下上传文件，则 parentId 填-1或不填
authType	String	否	文件夹权限：例如：1.只读:全体成员可编辑，可见：全体成员：read_all_look_all；2.只读：仅群主以及管理员可编辑，可见：全体成员：read_admin_look_all；3.只读：全体成员可编辑，可见：仅群主以及管理员：read_all_look_admin；4.只读：仅群主以及管理员可编辑，可见：仅群主以及管理员：read_admin_look_admin；5.只读：全体成员可编辑，可见：群主管理员以及特定的群成员：read_all_look_admin_designee；6.只读：仅群主以及管理员可编辑，可见：群主管理员以及特定的群成员：read_admin_look_designee；

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":
        {
            "name": "",
            "groupId": "",
            "fileId": ""
        }
 }

2.文件夹重命名：

• 接口地址：/group/dir/rename
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	文件夹ID
name	String	是	文件夹名称

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

3.文件夹权限修改：

• 接口地址：/group/dir/updateAuth
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	文件夹ID
dirAuthType	String	是	文件夹权限：例如：更新读权限-所有人可读：update_read_all，更新读权限-群主及管理员可读：update_read_admin，更新可见权限-全体成员：update_look_all，仅群主以及管理员：update_look_admin，群主管理员以及特定的群成员：update_look_designee；

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

4.分页获取群组路径下的文件：

• 接口地址：/group/dir/listFileByPage
• 请求方式：GET
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
path	String	是	群组下路径
len	Integer	否	展示条数 默认展示20条
sort	Integer	否	排序条件 1.更新时间 2.最近修改人 3.文件大小 其他 ：文件名称
isReverse	Boolean	否	是否倒序
lastId	Long	否	上次查询文件ID
dirOnly	Boolean	否	只展示文件夹 默认 false

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":[
        {
            "groupId": "",
            "fileId": "",
            "name": "",
            "parentId": "",
            "dir": "",
            "size": "",
            "createTime": ""
        }
    ]
 }

5.文件夹加星：

• 接口地址：/group/dir/star
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	文件夹ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

群文件

1.新建笔记（MD、协同文档、协同表格）：

• 接口地址：/group/file/create
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
parentId	Long	是	父目录ID ：文件夹下上传，则父目录ID为文件夹ID,群组根目录下上传文件，则 parentId 填-1或不填
fileName	String	是	文件名称：a.md-MD笔记 , b.doc/c.docx-灵犀文档 ,d.xlsx/e.xls-灵犀表格
fileSize	Long	是	笔记大小
inputStream	InputStream	是	文件流

• 响应结果：

 {
     "code":0,
     "message":"成功",
     "requestId":"",
     "data":
         {
             "name": "",
             "groupId": "",
             "fileId": ""
         }
 }

2.笔记重命名：

• 接口地址：/group/file/rename
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID
name	String	是	笔记名称

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

3.笔记加星：

• 接口地址：/group/file/star
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

4.移动笔记：

• 接口地址：/group/file/move
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID
destPath	String	是	目标路径 :只能在相同群组进行移动

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

5.复制笔记：

• 接口地址：/group/file/copy
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID
destGroupId	Long	是	目标群ID
destFolderId	Long	是	目标文件夹ID

• 响应结果：

 {
     "code":0,
     "message":"成功",
     "requestId":"",
     "data":
         {
             "name": "",
             "groupId": "",
             "fileId": ""
         }
  }

6.删除笔记：

• 接口地址：/group/file/delete
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

7.下载笔记：

• 接口地址：/group/file/download
• 请求方式：GET
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
fileId	Long	是	笔记ID

• 响应结果：数据流，可通过Content-Disposition获取文件名称

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }

8.上传笔记：

• 接口地址：/group/file/upload
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
parentId	Long	是	父目录ID：文件夹下上传，则父目录ID为文件夹ID,群组根目录下上传文件，则 parentId 填-1或不填
fileName	String	是	文件名称：a.md-MD笔记 , b.doc/c.docx-灵犀文档 ,d.xlsx/e.xls-灵犀表格
fileSize	Long	是	笔记大小 ：大小限制100M
inputStream	InputStream	是	文件流

• 响应结果：

 {
     "code":0,
     "message":"成功",
     "requestId":"",
     "data":
         {
             "name": "",
             "groupId": "",
             "fileId": ""
         }
 }

群成员

1.查询群成员列表：

• 接口地址：/group/member/list
• 请求方式：GET
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":[
        {
            "userId": "",
            "name": "",
            "photo": "",
            "joinTime": ""
        }
    ]
 }

2.查看群成员信息：

• 接口地址：/group/member/getInfo
• 请求方式：GET
• 请求参数：

参数名称	类型	必选	描述
userId	String	是	查询用户ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":
        {
            "userId": "",
            "name": "",
            "photo": "",
            "description": "",
            "location": "",
            "phone": "",
            "email": "",
            "sex": "",
            "modifyTime": "",
            "createTime": ""
        }
 }

3.移除群成员：

• 接口地址：/group/member/remove
• 请求方式：POST
• 请求参数：

参数名称	类型	必选	描述
groupId	Long	是	群组ID
memberId	String	是	成员ID

• 响应结果：

 {
    "code":0,
    "message":"成功",
    "requestId":"",
    "data":""
 }