服务端 API/历史版本（不推荐）/通讯录/用户管理/新增用户 # 新增用户 **注意事项**：为了更好地提升该接口的安全性，我们对其进行了升级，请尽快迁移至[新版本>>](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/user/create) 该接口用于向通讯录中新增用户。 - 调用该接口需要申请`更新通讯录`以及`以应用身份访问通讯录`权限。新增用户的所有部门必须都在当前应用的通讯录授权范围内才允许新增用户。应用商店应用无权限调用此接口 ## 请求 基本 |   ---|--- HTTP URL | https://open.larksuite.com/open-apis/contact/v1/user/add HTTP Method | POST 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 更新通讯录
以应用身份访问通讯录（历史版本） ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：获取与使用access_token](https://open.larksuite.com/document/ukTMukTMukTM/uMTNz4yM1MjLzUzM) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 请求体 |参数|类型|必须|说明| |-|-|-|-| |name|string|是|用户名| |email|string|否|用户邮箱地址，同一企业内，邮箱必须唯一| |mobile|string|是|用户手机号，同一企业内，手机号必须唯一| |department_ids、open_department_ids|list|否|新增用户所在部门自定义 ID 或者 openID，二者至少提供其中之一，**同时传两个参数优先使用 open_department_ids**，当前版本接口仅支持一个用户创建在一个部门下，需要有加入部门的通讯录权限；| |mobile_visible|bool|否|手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码| |city|string|否|用户所在城市| |country|string|否|用户所在国家| |gender|string|否|性别，1:男，2:女| |employee_type|int|否|员工类型。1:正式员工；2:实习生；3:外包；4:劳务；5:顾问| |join_time|int|否|入职时间| |leader_employee_id、leader_open_id|string|否|直接领导信息，支持通过 leader_employee_id 或者 leader_open_id 设置直接领导，**同时传递两个参数时按参数 leader_employee_id 处理**| |employee_id|string|否|用户企业内唯一标识。
自定义唯一标识不区分大小写，长度为 1 ~ 64 个字符。只能由数字、字母和 "_-@.“ 四种字符组成，且第一个字符必须是数字或字母。
创建用户时可指定该唯一标识，指定的唯一标识不能修改。| |employee_no|string|否|工号| |need_send_notification|bool|否|是否发送邀请通知。该字段为 true 时， 添加用户成功后会往相应的邮箱或者 mobile 发送邀请通知| |custom_attrs|object|否|自定义用户属性。
该字段仅当企业管理员在企业管理后台开启了“允许开放平台API调用”时有效。
传入的每个自定义用户属性需要包含平台生成的属性ID和要设置的属性值。
当企业管理后台未开启“允许开放平台API调用”，以及传入的自定义用户属性 ID 不存在或者非法时，会忽略该条属性设置信息。| |work_station|string|否|工位| ### 请求体示例 ```json { "name":"张三", "department_ids":["TT-1234"], "open_department_ids": ["od-a528a1df6182b09110887ef653bd5e03"], "email":"zhangsan@gmail.com", "mobile":"+8613822235671", "mobile_visible":false, "city":"北京", "country": "CN", "gender":1, "employee_type":1, "join_time":1534222800, "leader_open_id":"ou_3454556545acdb12324", "leader_employee_id":"2ab56f23", "employee_id":"tt_123456", "employee_no":"323463", "need_send_notification":true, "custom_attrs":{ "C-6702376000044400907": { "value": "value1" }, "C-6702376000048595214": { "value": "value2" } }, "work_station":"Poly, F6-123" } ``` ## 响应 ### 响应体 |参数|说明| |-|-| |code|返回码，非 0 表示失败| |msg|返回码的描述| |data|返回业务信息| | ∟userinfo|用户信息| |  ∟employee_id|用户的 employee_id，企业自建应用返回，应用商店应用不返回| |  ∟open_id|用户的 open_id| |  ∟name|用户名| |  ∟status|用户状态| |  ∟avatar_72|用户头像，72*72px| |  ∟avatar_240|用户头像，240*240px| |  ∟avatar_640|用户头像，640*640px| |  ∟avatar_url|用户头像，原始大小| |  ∟update_time|更新时间| |  ∟email|用户邮箱地址| |  ∟gender|string|否|性别，1:男，2:女| |  ∟join_time|int|否|入职时间戳| |  ∟en_name|英文名| |  ∟description|用户描述信息| |  ∟departments|用户所在部门的自定义 ID，用户可能同时存在于多个部门| |  ∟open_departments|用户所在部门的 openID，用户可能同时存在于多个部门| |  ∟city|用户所在城市| |  ∟country|用户所在国家| |  ∟station|工位信息| |  ∟leader_employee_id|直接领导 employee_id，企业自建应用返回，应用商店应用不返回| |  ∟leader_open_id|直接领导 open_id| |  ∟work_station|工位| ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "user_info":{ "employee_id":"tt_123456", "open_id":"ou_6dfd8d7e5e881bed9be19c043940bf60", "name":"张三", "status":2, "avatar_72": "https://sf3-ttcdn-tos.pstatp.com/img/avatar/62db96e8-c5b6-4077-bb9d-2697d65a29eb~72x72.png", "avatar_240": "https://sf3-ttcdn-tos.pstatp.com/img/avatar/62db96e8-c5b6-4077-bb9d-2697d65a29eb~240x240.png", "avatar_640": "https://sf3-ttcdn-tos.pstatp.com/img/avatar/62db96e8-c5b6-4077-bb9d-2697d65a29eb~640x640.png", "avatar_url": "https://sf3-ttcdn-tos.pstatp.com/img/avatar/62db96e8-c5b6-4077-bb9d-2697d65a29eb~noop.png", "update_time":1540886759, "name_py":"zhangsan", "email":"zhangsan@gmail.com", "gender":1, "join_time":"1534222800", "departments":[ "TT-1234" ], "open_departments":[ "od-a140b4eeb892b90a0ab3e616fc2054d6" ], "city":"北京", "country": "CN", "work_station":"Poly, F6-123", "leader_employee_id":"2ab56f23", "leader_open_id":"ou_76a95e7f1b7841f74576d2fc00838f47" } } } ``` ### 错误码 具体可参考：[服务端错误码说明](https://open.larksuite.com/document/ukTMukTMukTM/ugjM14COyUjL4ITN)