集成方需要提供的服务端接口

邀请人员弹框右侧查询已选人员列表

接口名称 查询已选人员列表
URL /remote/getUserList
请求方式 POST
请求参数 {}
返回值说明:
字段 说明
id 用户id
name 用户姓名

返回值示例:

{
  "code": 0,
  "msg": "",
  "data": [
    	{
      	"id": 1,
      	"name": "admin"
             }
          ]
}

邀请人员弹框左侧查询部门人员树

接口名称 查询部门人员树
URL /remote/selectorDeptUserTree
请求方式 POST
请求参数 {}
返回值说明:
字段 说明
id 主键id
parentDeptId 父部门id
  • 对用户:所在部门id
  • 对部门:父部门id
name 名称
position 职位
type 类型
  • 1:用户
  • 2:部门
ossUrl 服务器地址
avatar 头像地址(ossUrl + avatar组成完整URL)
noDeptUserFlag 未分组成员标识(未分配部门成员)
disabled 是否不可选择(默认false)
deptPath 上级部门面包屑路径
children 子节点

返回值示例:

{
  "code"0,
  "msg""",
  "data": {
    "id"1,
    "parentDeptId"0,
    "name""adv03",
    "position": null,
    "type"2,
    "ossUrl": null,
    "avatar": null,
    "noDeptUserFlag": false,
    "disabled": false,
    "deptPath""",
    "children": [
      {
        "id"1,
        "parentDeptId"1,
        "name""admin",
        "position""超级管理员",
        "type"1,
        "ossUrl""",
        "avatar""",
        "noDeptUserFlag": false,
        "disabled": false,
        "deptPath""adv03",
        "children": null
      }
          ]
       }
}

选择文件-查询根目录文件夹

接口名称 查询根目录文件夹
URL /remote/getRootFolder
请求方式 POST
请求参数 {}
返回值说明:
字段 说明
folderId 文件夹id
parentId 父文件夹id
name 文件名称
childrenFolders 子节点

返回值示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "folderId": 1,
      "parentId": 0,
      "name": "文件夹1",
      "childrenFolders": [
        {
          "folderId": 11,
          "parentId": 1,
          "name": "文件夹11",
          "childrenFolders": null
        }
      ]
    }
  ]
}

选择文件-查询当前文件夹下所有子文件夹的对应子文件夹

接口名称 查询当前文件夹下所有子文件夹的对应子文件夹
URL /remote/getChildFolder
请求方式 POST
请求参数:
参数 说明 是否必须
folderIds 子文件夹id列表
返回值说明:data中返回值为key-value的键值对。
  • key:当前文件夹下的子文件夹id。
  • value:该子文件夹下的子文件夹集合。
字段 说明
folderId 文件夹id
parentId 父文件夹id
name 文件夹名称
childrenFolders 子节点(只查询一层节点,childrenFolders为null)

返回值示例:

{
  "code"0,
  "msg""",
  "data": {
    "1": [
      {
        "folderId"11,
        "parentId"1,
        "name""文件夹11",
        "childrenFolders": null
      },
      {
        "folderId"12,
        "parentId"1,
        "name""文件夹12",
        "childrenFolders": null
      }
    ]
  }
}

选择文件-查询当前文件夹下的文件

接口名称 查询当前文件夹下的文件
URL /remote/listFile
请求方式 POST
请求参数:
参数 说明 是否必须
folderId 所属文件夹id
pageIndex 页码
pageSize 页数
返回值说明:
字段 说明
id 文件id
folderId 所属文件夹id
name 文件名称
fileType 文件类型
  • 1:其他
  • 2:2D文件
  • 3:3D文件
lightWeightUrl 轻量化文件路径

返回值示例:

{
  "code"0,
  "msg""",
  "data": {
    "pageIndex""1",
    "pageSize""1",
    "total""1",
    "list": [
      {
        "id"2,
        "folderId"2,
        "name""文件2.par",
        "fileType"3,
        "lightWeightUrl""http(s)://ip:port/xxx"
      }
    ]
  }
}

批注-获取源文件的批注

接口名称 获取源文件的批注
URL /remote/getFileComment
请求方式 GET
请求参数:
参数 说明 是否必须
fileId 文件的id,为文件的轻量化URL的32位MD5值
返回值说明:
字段 数据类型 说明
meetingId int 会议id
parentId - 未使用
avatar string 用户头像
content string 评论内容
createTime string(date_time) 创建时间
updateTime string(date_time) 更新时间
guid string 批注的唯一ID
imageSrc string 评论图片base64数据
operType int 批注类型
  • 1:标注
  • 2:评论
  • 3:回复
  • 4:图片批注
userId int 评论人id
userName string 评论人名称

返回值示例:

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "meetingId": 194,
      "parentId": 0,
      "userId": 14,
      "userName": "李一",
      "content": "test“,
      "operType": 1,
      "imageSrc": null,
      "avatar": "",
      "createTime": "2023-03-28 18:07:19",
      "updateTime": "2023-03-28 18:07:19",
      "guid": "1640656806605582336"
    }
  ]
}