跳到主要内容

创建外部用户

该接口用于在通讯录中创建外部用户。


权限说明

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

路径参数

请求

请求方式:POST

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

请求头(header)

参数类型是否必须说明
accessTokenstring调用接口凭证

请求体(body)

参数类型是否必须说明
useridstring用户的userid
nickNamestring用户名
areaCodestring区号,默认为86(填写手机号时该参数必填)
mobileNumstring手机号(手机号、邮箱二选一必填)
emailstring邮箱(邮箱避免重复)(手机号、邮箱二选一必填)
headimgstring头像
beingDisabledboolean是否禁用成员
beingCollaboratorboolean是否是协同用户
deptinfoObeject部门信息
deptidlong外部部门id

返回

**返回体 **

参数类型是否必含说明
errCodeint错误码,非0表示失败
errMsgstring错误描述
resultobject返回结果
userIdint用户的userId
nickNamestring用户昵称
emailstring邮箱
headImgstring头像地址
mobileNumstring手机号和邮箱二选一必填
areaCodestring手机区号不需要+号(例如 86)
beingDisabledboolean是否禁用
beingCollaboratorboolean是否开启协同
deptInfoObject部门信息
namestring-外部部门名称
deptIdlong外部部门id