跳到主要内容

批量创建成员

权限说明

仅专有轻流支持;

「超管accessToken」和「权限组accessToken」都可以调用,「权限组accessToken」须具有通讯录权限。

请求

**请求方式:**POST

请求地址:https://自有域名/openApi/user/batch

POST https://abcd.qingflow.com/openApi/user/batch

2.1 参数说明(路径参数):

2.2 参数说明(查询参数):

2.3 请求头(Header)

参数必须说明
accessToken调用接口凭证。获取方法请查看“文档”

2.4 请求体(Body)

参数必须类型说明
members[array]
userIdstring用户的userId
namestring用户名
areaCodestring区号,默认为86
mobileNumstring手机号
emailstring邮箱
headImgstring头像
department[array]同步部门id列表
role[array]同步角色id列表
customRole[array]成员所属自建角色列表(仅企业微信/钉钉/飞书等特殊工作区适用)
customDepartment[array]成员所在自建部门列表(仅企业微信/钉钉/飞书等特殊工作区适用)
beingDisabledboolean是否禁用成员
superiorIdstring直属主管的外部id(仅限专有轻流)

2.5 请求体示例

{
"members":[
{
"userId": "用户的userId",
"name": "用户名",
"areaCode": "86",
"mobileNum": "手机号",
"email": "邮箱",
"headImg": "头像",
"department":[],
"role": [],
"customRole": [],
"customDepartment": [],
"beingDisabled": "true"
}
]
}

返回

3.1 返回体

参数必含类型说明
errCodeint错误码,0表示成功,非0表示失败(注:结果只代表请求发送是否成功,不代表执行结果是否成功,执行结果可使用返回的reqesutId通过“查询操作结果”接口查询
errMsgstring错误描述
questionRelations关联的设置,这里没用
resultobject返回结果
requestIdstring

3.2 返回体示例

{
"errCode": 0,
"errMsg": "ok",
"result": {
"requestId":"22222"
}
}

注意事项

1、邮箱已存在于轻流,且对应用户在当前工作区时,调用本接口会更新成员信息