巴别鸟巴别鸟文档

获取所有分享参与人

属性 值
HTTP 方法 GET
接口路径 /nd/api/share/share_participants
所属分类 分享 API

接口说明

URL 参数

参数 类型 必填 说明
file_id string 是 文件 ID

表格可左右滚动查看

返回字段说明

users 是分享参与人记录数组。设置参与人角色时,取目标记录的 babelshareId 作为 babelshare_id,不要用 participantId 代替。以下字段及类型来自提供的非空样例,不推定其他参与人类型具有完全相同的非空字段。

字段 样例类型 说明
babelshareId string 分享参与记录标识;用于 设置分享参与人的权限角色 的 babelshare_id。
participantId string 参与者标识,与 babelshareId 是不同字段。
participantName string 参与者显示名称。
babelId string 用户工号字段。
participantType int 参与者类型代码;样例为 0,完整枚举未提供。
permission int 权限数值,不是角色 ID。
roleId int 参与人当前的角色 ID。
roleName string 参与人当前的角色名称。
email string 邮箱。
registered int 注册相关标记;样例为 1。
guest int 访客相关标记;样例为 0。
belongToEnterprise null 本次样例为 null,非空时的类型和结构未提供。
needReview int 审核相关标记;样例为 0。
reviewResult int 审核结果代码;样例为 -1,完整枚举未提供。

表格可左右滚动查看

以下沿用已有成功响应外层,补入一条参与人记录;标识、姓名、工号和邮箱已替换为示例值:

{
  "code": 0,
  "users": [
    {
      "babelshareId": "1001",
      "participantId": "2001",
      "participantName": "示例成员",
      "babelId": "member-example",
      "participantType": 0,
      "permission": 3647,
      "roleId": 12,
      "roleName": "编辑",
      "email": "user@example.com",
      "registered": 1,
      "guest": 0,
      "belongToEnterprise": null,
      "needReview": 0,
      "reviewResult": -1
    }
  ],
  "success": true
}

设置角色时,将所选记录的 babelshareId 传入单个字符串参数 babelshare_id;删除分享参与人 时,将待删除记录的 babelshareId 放入数组参数 babelshare_ids。这两个用途都不使用 participantId 替代分享参与记录标识。

调用说明

  • 调用前需完成 获取 token 或相应免登录认证,并在请求 Header 中携带 Authorization: Bearer <access_token>。
  • 参数和返回字段如因部署版本存在差异,应以实际私有云 API 文档和联调结果为准。
  • 所属分类:分享 API。
巴别鸟企业网盘文档内容会随产品版本、授权模块和部署配置更新;具体能力以实际部署与管理员配置为准。

本页 Markdown · AI 文档目录