Skip to content

批量新增协作者

批量新增多维表格高级权限中自定义角色的协作者。

前提条件

要调用协作者相关接口,你需确保多维表格已开启高级权限并设置了自定义角色。你可通过更新多维表格元数据接口开启高级权限,通过新增自定义角色接口设置自定义角色。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/batch_create
HTTP MethodPOST
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可base:collaborator:create 新增协作者 bitable:app 查看、评论、编辑和管理多维表格

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
app_tokenstring多维表格 App 的唯一标识。不同形态的多维表格,其 app_token 的获取方式不同: - 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分: app_token.png
- 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token
了解更多,参考多维表格 app_token 获取方式
示例值:"bascnnKKvcoUblgmmhZkYqabcef"
role_idstring多维表格高级权限中自定义角色的唯一标识,以 rol 开头。获取方式:通过列出自定义角色接口获取。
示例值:"rolNGhPqks"

请求体

名称类型必填描述
member_listapp.role.member_id\[\]协作者列表
数据校验规则
- 最大长度:100
  └ typestring协作者 ID 的类型
示例值:"open_id"
可选值有
- open_id: 以 open_id 来识别协作者。获取方式参考如何获取不同的用户 ID。 - union_id: 以 union_id 来识别协作者。获取方式参考如何获取不同的用户 ID - user_id: 以 user_id 来识别协作者。获取方式参考如何获取不同的用户 ID - chat_id: 以 chat_id 来识别协作者。获取方式参考群 ID 说明 - department_id: 以 department_id 来识别协作者。调用前,请确保应用有部门的可见性,参考配置应用可用范围。获取 department_id 方式参考部门资源介绍 - open_department_id: 以 open_department_id 来识别协作者。调用前,请确保应用有部门的可见性,参考配置应用可用范围。获取 open_department_id 方式参考部门资源介绍
默认值open_id
  └ idstring协作者的 ID,需与 type 的类型需一致。获取 ID 方式参考 type 参数描述。
示例值:"ou_35990a9d9052051a2fae9b2f1afabcef"

请求体示例

json
{
    "member_list": [
        {
            "type": "open_id",
            "id": "ou_35990a9d9052051a2fae9b2f1afabcef"
        }
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
4001254000WrongRequestJson请求体错误
4001254001WrongRequestBody请求体错误
4001254002Fail导致报 1254002 错误码的场景较多,请参考以下建议排查: - 如果单次操作的内容变更较大,请尝试在单次操作中减少数据量 - 如果你并发调用了接口,请尝试控制请求间隔,稍后重试 - 如果在知识库(wiki)中创建多维表格,请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如,在分页查询多维表格时,传递了无效的 page_token,或传递了错误的数据表的 table_id - 如果该报错偶尔发生,可能是服务器超时或不稳定,请重试解决
4001254003WrongBaseTokenapp_token 错误。app_token 是多维表格 App 的唯一标识。不同形态的多维表格,其 app_token 的获取方式不同: - 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分: app_token.png - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token。 了解更多,参考多维表格 app_token 获取方式
4001254032InvalidRoleName自定义角色名无效
4001254033RoleNameDuplicated自定义角色名重复
4041254040BaseTokenNotFoundapp_token 不存在。不同形态的多维表格,其 app_token 的获取方式不同: - 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分: app_token.png - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token。 了解更多,参考多维表格 app_token 获取方式
4041254047RoleIdNotFoundrole_id 不存在。role_id 是多维表格高级权限中自定义角色的唯一标识,以 rol 开头。可通过列出自定义角色接口获取。
4001254048MemberNotFound协作者 ID 不存在。请检查: - 查询参数 member_id_type 与 member_id 的类型是否保持一致; - member_id 填写是否正确。不同类型的 ID 获取方式不同: - open_id:参考如何获取不同的用户 ID - union_id:参考如何获取不同的用户 ID - user_id:参考如何获取不同的用户 ID - chat_id:参考群 ID 说明 - department_id:调用前,请确保应用有部门的可见性,参考配置应用可用范围。获取 department_id 方式参考部门资源介绍 - open_department_id:调用前,请确保应用有部门的可见性,参考配置应用可用范围。获取 open_department_id 方式参考部门资源介绍
4001254110RoleExceedLimit自定义角色数量超限,限制 30 条
4291254290TooManyRequest请求过快,稍后重试
4001254291Write conflict在同一个数据表中,并发调用了读写接口或请求过快,出现冲突。请参考以下建议解决: - 确保没有并发调用多维表格读写相关接口 - 若操作量较大,建议在接口与接口之间增加 0.5 或 1 秒的延迟,也可在报错中增加重试逻辑,确保业务的稳定性 - 对于写接口,可以将接口中的查询参数 ignore_consistency_check 设置为 true,表示在读写操作时,暂时忽略一致性检查,以提高性能
4001254301OperationTypeError多维表格未开启高级权限或不支持开启高级权限
4031254302Permission denied.调用身份缺少多维表格的高级权限。你需给予调用身份数据表的 可管理 权限或多维表格的 可管理 等权限,再重新调用。具体步骤如下所示: - 对用户授予高级权限,你可在 多维表格高级权限设置 中添加用户,为用户开通足够权限;或在多维表格页面右上方 分享 入口为当前用户添加可管理权限。详情参考飞书帮助中心文档使用多维表格高级权限 - 对应用授予高级权限,你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 image.png 注意: 在 添加文档应用 前,你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组,给予这个群自定义的读写等权限。
4001255001InternalError内部错误,请联系技术支持
5041255040Request timed out, please try again later请求超时,进行重试
4001254036Base is copying, please try again later.复制多维表格为异步操作,该错误码表示当前多维表格仍在复制中,在复制期间无法操作当前多维表格。需要等待复制完成后再操作

内容来源:飞书开放平台 · 自动爬取整理