淘宝开放平台

登录
文档中心 > API类目 > 钉钉API

钉钉API

dingtalk.oapi.v2.user.update (用户信息更新)

用户信息更新

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
userid String 必须 zhangsan
  • 最大长度：64
    		•  员工id，长度最大64个字符。员工在当前企业内的唯一标识。如果不传，服务器将自动生成一个userid。创建后不可修改，企业内必须唯一。
    name String 可选 张三
  • 最大长度：80
    		•  员工名称，长度最大80个字符。
    mobile String 可选 18513027676 手机号码，企业内必须唯一，不可重复。如果是国际号码，请使用+xx-xxxxxx的格式
    hide_mobile Boolean 可选 false 是否号码隐藏。隐藏手机号后，手机号在个人资料页隐藏，但仍可对其发DING、发起钉钉免费商务电话。
    telephone String 可选 010-86123456-2345
  • 最大长度：50
    		•  分机号，长度最大50个字符。企业内必须唯一，不可重复
    job_number String 可选 4
  • 最大长度：50
    		•  员工工号，长度最大50个字符。
    title String 可选 技术总监
  • 最大长度：200
    		•  职位，长度最大200个字符。
    email String 可选 test@xxx.com
  • 最大长度：50
    		•  员工邮箱，长度最大50个字符。企业内必须唯一，不可重复。
    org_email String 可选 test@xxx.com
  • 最大长度：100
    		•  员工的企业邮箱，长度最大100个字符。员工的企业邮箱已开通，才能增加此字段。
    work_place String 可选 未来park
  • 最大长度：100
    		•  办公地点，长度最大100个字符。
    remark String 可选 备注备注
  • 最大长度：2000
    		•  备注，长度最大2000个字符。
    dept_id_list Number [] 可选 "2,3,4"
  • 最小值：1
  • 最大列表长度：300
    		•  所属部门id列表
    dept_order_list DeptOrder [] 可选
  • 最大列表长度：100
    		•  员工在对应的部门中的排序。
    • └ dept_id
    • Number
    • 可选
    • 2
    • 部门id
    • └ order
    • Number
    • 可选
    • 1
    • 员工在部门中的排序。
    dept_title_list DeptTitle [] 可选
  • 最大列表长度：100
    		•  员工在对应的部门中的职位。
    • └ dept_id
    • Number
    • 可选
    • 2
    • 部门id
    • └ title
    • String
    • 可选
    • 资深产品经理
    • 员工在部门中的职位。
    extension Json 可选 {"爱好":"旅游","年龄":"24"} 扩展属性，长度最大2000个字符。可以设置多种属性（手机上最多显示10个扩展属性，具体显示哪些属性，请到OA管理后台->设置->通讯录信息设置和OA管理后台->设置->手机端显示信息设置）。 该字段的值支持链接类型填写，同时链接支持变量通配符自动替换，目前支持通配符有：userid，corpid。示例： [工位地址](http://www.dingtalk.com?userid=#userid#&corpid=#corpid#)
    senior_mode Boolean 可选 false 是否高管模式。开启后，手机号码对所有员工隐藏。普通员工无法对其发DING、发起钉钉免费商务电话。高管之间不受影响。
    hired_date Number 可选 1597573616828
  • 最小值：1
    		•  入职时间，Unix时间戳，单位ms。
    language String 可选 zh_CN
  • 最大长度：6
    		•  语言
    init_password String 可选 Password123 重置专属帐号密码
    loginId String 可选 loginId123 修改专属帐号登录名
    dept_position_list DeptPosition [] 可选
  • 最大列表长度：999
    		•  部门内任职
    • └ dept_id
    • Number
    • 可选
    • 2
    • 部门id
    • └ title
    • String
    • 可选
    • 资深产品经理
    • 员工在部门中的职位，长度最大200个字符。
    • └ is_main
    • Boolean
    • 可选
    • true
    • 是否主任职（需要有且只有一个主任职）
    • └ work_place
    • String
    • 可选
    • 未来park
    • 办公地点，长度最大100个字符。
    • └ manager_userid
    • String
    • 可选
    • 100
    • 部门内直属主管员工id
    • └ title_i18n
    • 可选
    • { "en_US": "sale" }
    • 办公地点国际化字段
    • └ work_place_i18n
    • 可选
    • {"en_US":"hangzhou"}
    • 职位国际化字段
    org_email_type String 可选 profession 企业邮箱类型（profession：标准版，base：基础版）
    force_update_fields String [] 可选 manager_userid
  • 最大列表长度：999
    		•  强制更新的字段，支持清空指定的字段，使用逗号分隔。目前支持字段：manager_userid
    manager_userid String 可选 0001 直属主管
    exclusive_mobile String 可选 +86-19812341234 专属帐号手机号
    exclusive_mobile_verify_status String 可选 verified/notVerified 手机号验证状态
    nickname String 可选 昵称 修改本组织专属帐号时可指定昵称
    avatarMediaId String 可选 @lALPDfmVUw19YdrNA-jNA-g 修改本组织专属帐号时可指定头像MediaId。只支持参考jpg/png，生成方法 https://developers.dingtalk.com/document/app/upload-media-files
    ext_attrs_update_mode Number 可选 0 自定义字段更新模式，0-覆盖方式 1-追加方式 (默认是覆盖)
    ext_attrs EmpExtAttr [] 可选
  • 最大列表长度：999
    		•  更新自定义字段列表
    • └ code
    • String
    • 可选
    • emp:xxx
    • 自定义字段编码
    • value
    • EmpExtAttrValue
    • 可选
    • 更新自定义字段值
    • └ images
    • String []
    • 可选
    • https://img.alicdn.com/imgextra/i2/O1CN01IVwD5w1mqnRxmUBng_!!6000000005006-2-tps-64-64.png
    • 自定义字段图片值
    • └ text
    • String
    • 可选
    • 点击前往钉钉官网
    • 自定义字段文本值
    • └ url
    • String
    • 可选
    • www.dingtalk.com
    • 自定义字段链接值
    gender String 可选 F 自定义性别字段
    limited Boolean 可选 false 是否外包员工
    has_subordinate Boolean 可选 false 汇报线架构-是否有下属
    dept_name String 可选 部门1-部门11-部门111 汇报线架构-员工所在的部门链信
    flower_name String 可选 花名 企业内昵称（花名）
    extension_i18n Json 可选 {"爱好":{"zh_CN": "旅游", "en_US": "travel", "ja_JP": "旅行"}} 扩展属性的国际化值

    响应参数

    名称 类型 示例值 描述
    errcode Number 0 错误码。0代表成功。
    errmsg String ok 错误信息。

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/v2/user/update");
OapiV2UserUpdateRequest req = new OapiV2UserUpdateRequest();
req.setUserid("zhangsan");
req.setName("张三");
req.setMobile("18513027676");
req.setHideMobile(false);
req.setTelephone("010-86123456-2345");
req.setJobNumber("4");
req.setTitle("技术总监");
req.setEmail("test@xxx.com");
req.setOrgEmail("test@xxx.com");
req.setWorkPlace("未来park");
req.setRemark("备注备注");
req.setDeptIdList("\"2,3,4\"");
List<DeptOrder> list2 = new ArrayList<DeptOrder>();
DeptOrder obj3 = new DeptOrder();
list2.add(obj3);
obj3.setDeptId(2L);
obj3.setOrder(1L);
req.setDeptOrderList(list2);
List<DeptTitle> list5 = new ArrayList<DeptTitle>();
DeptTitle obj6 = new DeptTitle();
list5.add(obj6);
obj6.setDeptId(2L);
obj6.setTitle("资深产品经理");
req.setDeptTitleList(list5);
req.setExtensionString("{\"爱好\":\"旅游\",\"年龄\":\"24\"}");
req.setSeniorMode(false);
req.setHiredDate(1597573616828L);
req.setLanguage("zh_CN");
req.setInitPassword("Password123");
req.setLoginId("loginId123");
List<DeptPosition> list8 = new ArrayList<DeptPosition>();
DeptPosition obj9 = new DeptPosition();
list8.add(obj9);
obj9.setDeptId(2L);
obj9.setTitle("资深产品经理");
obj9.setIsMain(true);
obj9.setWorkPlace("未来park");
obj9.setManagerUserid("100");
req.setDeptPositionList(list8);
req.setOrgEmailType("profession");
req.setForceUpdateFields("manager_userid");
req.setManagerUserid("0001");
req.setExclusiveMobile("+86-19812341234");
req.setExclusiveMobileVerifyStatus("verified/notVerified");
req.setNickname("昵称");
req.setAvatarMediaId("@lALPDfmVUw19YdrNA-jNA-g");
req.setExtAttrsUpdateMode(0L);
List<EmpExtAttr> list11 = new ArrayList<EmpExtAttr>();
EmpExtAttr obj12 = new EmpExtAttr();
list11.add(obj12);
obj12.setCode("emp:xxx");
EmpExtAttrValue obj14 = new EmpExtAttrValue();
obj14.setImages("https://img.alicdn.com/imgextra/i2/O1CN01IVwD5w1mqnRxmUBng_!!6000000005006-2-tps-64-64.png");
obj14.setText("点击前往钉钉官网");
obj14.setUrl("www.dingtalk.com");
list13.setValue(obj14);
req.setExtAttrs(list11);
req.setGender("F");
req.setLimited(false);
req.setHasSubordinate(false);
req.setDeptName("部门1-部门11-部门111");
req.setFlowerName("花名");
req.setExtensionI18nString("{\"爱好\":{\"zh_CN\": \"旅游\", \"en_US\": \"travel\", \"ja_JP\": \"旅行\"}}");
OapiV2UserUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
    "errcode":0,
    "errmsg":"ok"
}

    异常示例

    • JSON示例
    {
	"errcode":88,
	"errmsg":"ding talk error"
}

    错误码解释

    错误码 错误描述 解决方案

    API工具

    API测试工具 错误码查询工具 SDK下载

    如何获得此API

    FAQ

    我要提问
    返回
    顶部