更新高校账号用户信息新版SDK

更新于 2024-12-06更新高校账号用户信息。如果是更新个人账号信息，请调用另一个更新个人账号用户信息的接口。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉教育高校通讯录写权限	API Explorer
第三方企业应用	暂不支持	暂不支持	暂不支持
第三方个人应用	暂不支持	暂不支持	暂不支持

请求方法

Header参数

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证：企业内部应用可调用获取企业内部应用的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证：

企业内部应用可调用获取企业内部应用的accessToken接口获取。

Body参数

名称	类型	是否必填	描述
userid	String	是	员工唯一标识ID（不可修改），企业内必须唯一。说明长度为1~64个字符，如果不传，将自动生成一个userid。
name	String	否	员工名称，长度最大80个字符。
mobile	String	否	手机号码，企业内必须唯一，不可重复。目前仅支持国内手机号。
empType	String	否	员工的成员类型： college_teacher：教职工 college_student：学生说明如果员工原类型未知，可以通过该字段更新成学生/教职工。如果员工已经是学生/教职工，本字段不支持成员类型变更，需要通过修改成员类型接口变更。
telephone	String	否	分机号，长度最大50个字符。
jobNumber	String	否	教职工工号/学生学号，长度最长为50个字符。
title	String	否	职位，长度最大为200个字符。
email	String	否	员工个人邮箱，长度最大50个字符。
orgEmail	String	否	员工的企业邮箱，长度最大100个字符。
orgEmailType	String	否	员工的企业邮箱类型： profession: 标准版 base：基础版
workPlace	String	否	办公地点，长度最大100个字符。
remark	String	否	备注，长度最大2000个字符。
deptIdList	Array of Long	否	部门ID。
mainDeptId	Long	否	主部门ID。
deptOrderList	Array	否	员工在对应的部门中的排序。
deptId	Long	否	部门ID。
order	Integer	否	员工在部门中的排序。
deptTitleList	Array	否	员工在对应的部门中的职位。
deptId	Long	否	部门ID。
title	String	否	员工在部门内的职位
extension	Map<String, String>	否	扩展属性，可以设置多种属性，最大长度2000个字符。 `具体支持的key可见成员字段管理。` `身份证号是高敏信息，查询用户信息接口不返回。`
seniorMode	Boolean	否	是否开启高管模式，默认值false： true：开启 false：不开启
hiredDate	Long	否	入职时间，Unix时间戳，单位毫秒。
managerUserid	String	否	直属主管的userId。
hideMobile	Boolean	否	是否号码隐藏： true：隐藏 false：不隐藏说明隐藏手机号后，手机号在个人资料页隐藏，但仍可对其发DING、发起钉钉商务电话。
deptPositionSet	Array	否	部门多任职，其任职主部门由mainDeptId确定。说明仅组织开通了多任职才生效。
deptId	Long	否	部门id。
title	String	否	职位。
workPlace	String	否	办公地点。
managerUserId	String	否	直属主管。
language	String	否	通讯录语言，取值： zh_CN：中文（默认值）。 en_US：英文。
forceUpdateFields	String	否	强制更新的字段，支持清空指定的字段，多个字段之间使用逗号分隔。目前支持字段: manager_userid、org_email。
loginIdType	String	否	高校账号的登录类型： studentNo：学号 teacherNo：职工号 cardNo：身份证号 candidateNo：考生号说明使用studentNo或teacherNo，此时jobNumber必传。使用cardNo或者candidateNo，则extension中必传{"身份证号":"xxxx"}或者{"考生号":"xxxx"}。身份证号是高敏信息，查询用户信息接口不返回。`
avatarMediaId	String	否	创建高校账号时可指定头像MediaId，只支持jpg/png。可调用上传媒体文件接口获取。
nickname	String	否	创建高校账号时可指定昵称。

返回参数

名称	类型	描述
success	Boolean	是否成功。

示例

请求示例

HTTP

Java

Python

PHP

Node.js

返回示例

错误码

HttpCode	错误码	错误信息	说明
400	needAuth	NEED_AUTH	需要授权
400	invalidIsvOrgId	INVALID_ISV_ORG_ID	无效的isv
400	invalidRequestParams	INVALID_REQUEST_PARAMS	不合法的参数
400	saveFailed	SAVE_EMPLOYEE_INFO_FAILED	创建用户信息失败
400	noPermission	NO_PERMISSION	没有权限
400	illegalMobile	ILLEGAL_MOBILE	无效的手机号
400	userIdExist	USERID_EXIST_IN_ORG	userId已存在
400	deptCannotFind	DEPT_CAN_NOT_FIND	部门不存在
400	userOpenAccountProtect	USER_OPEN_ACCOUNT_PROTECT	用户开启了账号保护
400	systemError	SYSTEM_ERROR	系统异常

这篇文档是否有帮助？

本页内容