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

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

请求包体:

{
	"userid":"xxxxx",
	"get_all":false,
	"fieldids":[
		{
			"fieldid":11004,
			"sub_idx":0
		},
		{
			"fieldid":14001,
			"sud_idx":1
		}
	]
}

参数说明:

参数必须说明
access_token调用接口凭证
userid需要获取花名册信息的员工的userid
该员工需要在调用应用的可见范围内,否则将返回错误码
get_all是否获取全部字段信息,不填时默认为否
fieldids需要获取的字段信息。
参数get_all为否或不填时,此字段不能为空;
参数get_all为是时,此字段填写的内容将被忽略
fieldids.fieldid需要获取的字段id
fieldids.sub_idx需要获取的字段下标。
当需要获取的字段属于可重复的组(参考可重复字段组列表)时,需要指定获取组内第几组数据的字段信息,当需要获取的字段不属于可重复的组时,需要为0。
不填时默认为0

可重复字段组列表:

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

返回数据:

{
	"errcode":0,
	"errmsg":"ok",
	"field_info":[
		{
			"fieldid":11004,
			"sub_idx":0,
			"result":1,
			"value_type":3,
			"value_uint32":1
		},
		{
			"fieldid":11003,
			"sub_idx":0,
			"result":1,
			"value_type":5,
			"value_mobile":{
				"value_country_code":"xx",
				"value_mobile":"xxxxxxxxxx"
			}
		},
		{
			"fieldid":19001,
			"sub_idx":0,
			"result":1,
			"value_type":6,
			"value_file":{
				"media_id":["xxxxxx","xxxxxx"]
			}
		}
	]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述
field_info获取到的字段信息,参考字段信息说明

字段信息说明:

参数说明
fieldid字段id
sub_idx下标
result查询结果,参考查询结果对照表
value_type字段值的类型,参考字段值类型对照表
value_xxxxx字段值的内容,根据不同的字段值类型,返回的这个字段的名称和类型也不同,参考字段值类型对照表

查询结果对照表:

参数结果
1成功
2失败
3字段未找到
5不支持获取的字段类型

字段值类型对照表:

参数字段类型对应的内容字段名称对应的内容字段类型
1字符串value_string字符串
264位非负整数value_uint64非负整数
332位非负整数value_uint32非负整数
464位整数value_int64整数
5电话号码value_mobile参考电话号码类型字段结构
6文件value_file参考文件类型字段结构

电话号码类型字段结构:

参数说明
value_country_code字符串,表示电话号码的区号
value_mobile字符串,表示电话号码

文件类型字段结构:

参数说明
media_id列表,内容为字符串,可在获取临时素材接口下载对应文件
上一篇获取员工字段配置
下一篇更新员工花名册信息
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们