调用BatchAddFeishuUsers批量添加飞书用户_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

批量添加飞书用户。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
IsAuthAdmin	boolean	否	是否是权限管理员 true false 不填写默认为 false	true
IsAdmin	boolean	否	是否为 admin 用户： true false 不填写默认为 false	False
FeishuUsers	string	否	要添加的用户信息	{"ad**fd": "张三", "82**5a": "李四"}"
UserGroupIds	string	否	所属用户组	"0d5fb19b-5555-41f0-99da-1248fc27ca51,0f868dd6_68dd_4d13_8422_c5dca3bd4b61"
UserType	integer	否	用户类型开发者类型：1 访问者类型：2 分析师：3	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	D8749D65-E80A-433C-AF1B-CE9C180FF3B4
Result	object	返回添加用户组成员的结果。取值范围： true：添加成功 false：添加失败
FailCount	integer	失败校验的个数。	10
FailResults	array<object>	失败的具体详情。
FailResults	object
FailInfos	array<object>	错误原因。
FailInfos	object
Code	string	错误码。	ACCOUNT_EXIST
CodeDesc	string	错误码描述。	账号已存在
Input	string	错误的输入值。	20
OkCount	integer	成功计数。	1
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	True

示例

正常返回示例

JSON格式

{
  "RequestId": "D8749D65-E80A-433C-AF1B-CE9C180FF3B4",
  "Result": {
    "FailCount": 10,
    "FailResults": [
      {
        "FailInfos": [
          {
            "Code": "ACCOUNT_EXIST",
            "CodeDesc": "账号已存在",
            "Input": "20"
          }
        ]
      }
    ],
    "OkCount": 1
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Feishhu.Config.Not.Exit	Feishu is not configured in the current organization	当前组织未配置飞书。
400	Feishu.User.Need.Sync.Contact	Feishu need to sync contact list.	飞书需要同步通讯录。
400	Feishu.Parameter.Error	Feishu config error: %s.	飞书参数错误：%s。
400	Mail.Invalid	Email/phone number is invalid.	邮箱/手机号无效。
400	Usergroup.Not.Exist	The user group does not exist.	用户组不存在。
400	Instance.Over.MaxLicense	You have reached the maximum number of users that can be added. Please upgrade the configurations or remove some users first.	您可以添加的用户已达上限，请升级配置或移除其它用户后再添加。
400	Feishu.User.Duplicated	Feishu account already exists or bound：%s.	飞书账号已存在或绑定。
400	Viewer.CannotHave.CustomRole	Organization viewer cannot have custom roles.	组织访问者不能具有自定义角色。
400	UserAnalyst.NotSupport.ThisRole	This role has permissions that analysts cannot grant.	该角色具有分析员无法授予的权限。
400	User.OrganizationRole.NotExist	User %s must have role in organization.	用户 %s 在组织中必须有一个角色。
400	FeishuUser.UserGroup.AssociationError	Feishu User can only be added into feishu or Bi user group.	飞书用户只能被添加到飞书或BI用户组中。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-10-24	OpenAPI 错误码发生变更	查看变更详情
2023-08-07	OpenAPI 错误码发生变更	查看变更详情
2022-09-08	新增 OpenAPI	查看变更详情