登录
基础
连接微信
办公通过这个接口获取员工字段配置信息
请求方式：GET(HTTPS)
请求地址：https://qyapi.weixin.qq.com/cgi-bin/hr/get_fields?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 必须 | 说明 |
|---|---|---|
| access_token | 是 | 调用接口凭证 |
返回数据：
{
"errcode":0,
"errmsg":"ok",
"group_list":[
{
"group_id":1001,
"group_name":"个人信息",
"field_list":[
{
"fieldid":11001,
"field_name":"姓名",
"field_type":1,
"value_type":1,
"is_must":true
},
{
"fieldid":11002,
"field_name":"别名",
"field_type":1,
"value_type":1,
"is_must":false
},
{
"fieldid":12010,
"field_name":"职位",
"field_type":2,
"value_type":3,
"is_must":false,
"option_list":[
{
"id":1,
"value":"总经理"
},
{
"id":2,
"value":"秘书"
}
]
}
]
},
{
"group_id":1002,
"group_name":"在职信息",
"field_list":[
{
"fieldid":12024,
"field_name":"工号",
"field_type":1,
"value_type":1,
"is_must":true
}
]
}
]
}参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述 |
| group_list | 字段组的配置信息，参考字段组配置信息说明 |
字段组配置信息(group_list)说明：
| 参数 | 说明 |
|---|---|
| group_id | 字段组的id |
| group_name | 字段组的名称 |
| field_list | 字段组所包含的所有字段信息，参考字段信息说明 |
字段信息(field_list)说明：
| 参数 | 说明 |
|---|---|
| field_id | 字段的id |
| field_name | 字段的名称 |
| field_type | 字段的类型，参考字段类型说明 |
| value_type | 字段值的类型，参考字段值类型对照表 |
| is_must | 字段是否为必填 |
| option_list | 字段为选项类型时，每个选项的枚举值和对应的文本 仅当field_type字段为2时返回 |
| option_list.id | 选项的枚举值 |
| option_list.value | 选项的文本内容 |
字段类型(type)说明：
| 参数 | 字段类型 | 对应获取/更新时字段类型 |
|---|---|---|
| 1 | 文本类型 | 字符串类型 或 电话号码类型 |
| 2 | 选项类型 | 32位非负整数类型 |
| 3 | 时间类型 | 64位非负整数类型 或 64位整数类型 |
| 4 | 图片类型 | 文件类型 |
| 5 | 单个文件类型 | 文件类型 |
| 6 | 多个文件类型 | 文件类型 |
字段值类型(value_type)对照表：
| 参数 | 字段类型 | 对应的内容字段类型 |
|---|---|---|
| 1 | 字符串 | 字符串 |
| 2 | 64位非负整数 | 非负整数 |
| 3 | 32位非负整数 | 非负整数 |
| 4 | 64位整数 | 整数 |
| 5 | 电话号码 | 参考电话号码类型字段结构 |
| 6 | 文件 | 参考文件类型字段结构 |
电话号码类型字段结构：
| 参数 | 说明 |
|---|---|
| value_country_code | 字符串，表示电话号码的区号 |
| value_mobile | 字符串，表示电话号码 |
文件类型字段结构：
| 参数 | 说明 |
|---|---|
| media_id | 列表，内容为字符串，可在获取临时素材接口下载对应文件 |
基础连接微信办公基础连接微信办公基础连接微信办公