企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
人事助手
花名册
更新员工花名册信息
更新员工花名册信息
最后更新:2024/01/04
通过这个接口更新指定员工的花名册信息
调用参数中的字段id信息可以通过获取员工字段配置接口获取
有一些字段不支持更新,参考不支持更新字段表

请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/hr/update_staff_info?access_token=ACCESS_TOKEN

请求包体:

{
	"userid":"xxxxx",
	"update_items":[
		{
			"fieldid":11020,
			"sub_idx":0,
			"value_string":"xxxxx"
		},
		{
			"fieldid":17003,
			"sub_idx":1,
			"value_mobile":{
				"value_mobile_country_code":"xxx",
				"value_mobile":"xxxxxxxx"
			}
		}
	],
	"remove_items":[
		{
			"group_type":1,
			"sub_idx":1
		},
		{
			"group_type":1,
			"sub_idx":2
		}
	],
	"insert_items":[
		{
			"group_type":4,
			"item":[
				{
					"fieldid":17001,
					"sub_idx":0,
					"value_string":"孙悟空"
				},
				{
					"fieldid":17002,
					"sub_idx":0,
					"value_uint32":1
				},
				{
					"fieldid":17003,
					"sub_idx":0,
					"value_mobile":{
						"value_country_code":"xxx",
						"value_mobile":"xxxxxxxx"
					}
				},
				{
					"fieldid":17004,
					"sub_idx":0,
					"value_string":"娜美克星"
				}
			]
		}
	]
}

参数说明:

参数必须说明
access_token调用接口凭证
userid需要更新花名册信息的员工的userid
该员工需要在调用应用的可见范围内,否则将返回错误码
update_items需要更新、增加或清空单个字段的内容,参考更新字段说明
有一些字段不支持更新,参考不支持更新字段表
这个字段和remove_items、insert_items字段不能全部为空
remove_items可重复的字段组(参考可重复字段组列表)中需要整组字段进行删除的字段组,参考删除字段说明
这个字段和update_items、insert_items字段不能全部为空
insert_items可重复的字段组(参考可重复字段组列表)中需要增加一组字段的字段组,参考增加字段说明
这个字段和update_items、remove_items字段不能全部为空

可重复字段组列表:

编号名称
1教育经历
2工作经历
3家庭成员
4紧急联系人
5合同信息

更新字段说明:

参数必须说明
fieldid字段id
sub_idx可重复组中的字段下标,非可重复组中的字段时需要填0
value_xxxxx需要更新、增加或清空的员工信息字段内容。
根据员工信息字段的类型,需要填写的这个字段的名称和类型也不同,参考字段值类型对照表
除了对应的字段外,在其他字段填写的内容将被忽略。

不支持更新字段表:

以字段id为准
名称字段id
年龄11006
社会工龄11012
员工状态12004

 

删除字段说明:

参数必须说明
group_type需要删除的字段组类型,参考可重复字段组列表
sub_idx需要删除的是第几组字段

增加字段说明:

参数必须说明
group_type需要增加的字段组类型,参考可重复字段组列表
item列表,需要增加的字段内容;
填写要求与更新字段说明相同,但sub_idx字段的内容将被忽略;
没有找到对应字段id的字段内容将被忽略。

字段值类型对照表:

字段类型对应的内容字段名称对应的内容字段类型
字符串value_string字符串
64位非负整数value_uint64非负整数
32位非负整数value_uint32非负整数
64位整数value_int64整数
电话号码value_mobile参考电话号码类型字段结构

电话号码类型字段结构:

参数说明
value_country_code字符串,表示电话号码的区号
value_mobile字符串,表示电话号码
这个字段如果不填/填写空串,则视为整个电话号码字段传入为空

返回数据:

{
	"errcode":0,
	"errmsg":"ok",
	"update_results":[
		{
			"fieldid":11001,
			"sub_idx":0,
			"result":1
		}
	],
	"remove_results":[
		{
			"group_type":1,
			"sub_idx":20,
			"result":3
		}
	],
	"insert_result":[
		{
			"group_type":1,
			"idx":1,
			"result":4
		}
	]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述
------
update_results更新字段的结果
update_results.fieldid尝试更新的字段id
update_results.sub_idx尝试更新的字段下标
update_results.result更新的结果,参考结果类型对照表
------
remove_results删除字段组的结果
remove_results.group_type尝试删除的字段组类型
remove_results.sub_idx尝试删除的字段组下标
remove_results.result删除的结果,参考结果类型对照表
------
insert_results增加字段组的结果
insert_results.group_type尝试增加的字段组类型
insert_results.idx尝试增加的字段组输入时的下标
insert_results.result增加的结果,参考结果类型对照表

结果类型对照表:

参数结果类型
1成功
2失败
3未找到的字段id/字段下标
4必填字段未填写/被清空
5不支持更新的字段类型
上一篇获取员工花名册信息
下一篇概述
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们