获取单个用户信息

该接口用于获取通讯录中单个用户的信息。

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/contact/v2/users/:user_id
HTTP Method	GET
支持的应用类型	自建应用 商店应用
权限要求 开启任一权限即可	以应用身份读取通讯录
字段权限要求	该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 获取用户基本信息 获取用户 user_id 获取用户邮箱 获取用户性别 获取用户手机号 获取用户雇佣信息 获取用户组织架构信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称	类型	描述
user_id	string	用户ID，需要与查询参数中的user_id_type类型保持一致。 示例值："7be5fg9a"

查询参数

名称	类型	描述
user_id_type	string	用户 ID 类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id，字段权限要求： 获取用户 user ID

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟ open_id	string	开放平台唯一Id，标识一个用户在某个应用中的身份
∟ union_id	string	标识一个用户在某个应用开发商下的身份
∟ user_id	string	租户内用户的唯一标识，用户的user_id 字段权限要求： 获取用户 user_id（仅自建应用）
∟ name	string	用户名 字段权限要求（满足任一）： 获取用户基本信息
∟ nickname	string	别名 字段权限要求（满足任一）： 获取用户基本信息
∟ email	string	邮箱，注意非 +86 手机号成员必须同时添加邮箱 字段权限要求： 获取用户邮箱信息
∟ mobile	string	手机号，在本企业内不可重复；未认证企业仅支持添加中国大陆手机号，注意国际电话区号前缀中必须包含加号 + 字段权限要求： 获取用户手机号
∟ gender	int	性别 可选值有： * 0：保密 * 1：男 * 2：女 字段权限要求（满足任一）： 获取用户性别
∟ avatar_key	string	用户头像信息 字段权限要求（满足任一）： 获取用户基本信息
∟ status	user_status	用户状态 字段权限要求（满足任一）： 获取用户雇佣信息
∟is_resigned	boolean	是否离职
∟is_activated	boolean	是否激活
∟department_ids	string[]	用户所属部门的ID列表，一个用户可属于多个部门，主部门在第一个。 字段权限要求（满足任一）： 获取部门基础信息
∟ leader_user_id	string	用户的直接主管的用户ID， 字段权限要求（满足任一）： 获取用户 user_id
∟lateral_user_ids	string[]	次级汇报人Id
∟join_time	string	入职时间
∟leave_time	string	离职时间
∟participatework_time	string	参加工作时间
∟employee_type	string	员工类型 可选值有： * REGULAR：正式 * PROBATIONARY：试用
∟ report_user_id	string	汇报人userId。 字段权限要求（满足任一）： 获取用户 user_id
∟ employee_no	string	工号 字段权限要求（满足任一）： 获取用户组织架构信息
∟ job_title	string	职务 字段权限要求（满足任一）： 获取用户组织架构信息
∟work_station	string	工位
∟custom_attr	custom_attr[]	自定义字段
∟field_name	string	字段名称
∟field_value	string	字段值
∟type	string	字段类型 可选值有： * TEXT：文本 * WEB：网页 * DOWN_SINGLE：下拉单选 * DOWN_MULTIPLE：下拉多选 * DATE：日期 * DATE_INTER：日期区间 * STAFF_SINGLE：人员单选 * STAFF_MULTIPLE：人员多选 * DEPT_SINGLE：部门单选 * DEPT_MULTIPLE：部门多选

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "data": {
    "union_id": "on_482e27352f865d650379ecff4476c20c",
    "open_id": "ou_0c1aeccbe1220353894aaa607267057b",
    "user_id": "3106",
    "name": "xxx",
    "nickname": "xx min 2",
    "email": "xxx@abc.com",
    "mobile": "18512312312",
    "gender": 2,
    "avatar_key": "https://bosshi-admin-qa.weizhipin.com/api/media/public/TsL7SZkyE7OziL1OMpaqLDHzPMFJGOEskgZ2PIRIhqcqyjlUQ00W_KijR_4bUajc_s64.png",
    "status": {
      "is_resigned": false,
      "is_activated": true
    },
    "department_ids": [
      "0104010C02"
    ],
    "leader_user_id": "0876",
    "lateral_user_ids": [
      "0879"
    ],
    "employee_no": "3106",
    "job_title": "测试工程师",
    "report_user_id": "10001",
    "join_time": "2022-01-01 01:01:02",
    "leave_time": "2022-01-01 01:01:02",
    "participatework_time": "2022-01-01 01:01:02",
    "employee_type": "PROBATIONARY",
    "work_station": "北京",
    "custom_attrs": [
      {
        "type": "DATE",
        "fieldName": "db24318acfc24ab8965084d2504aafb3",
        "fieldValue": "2023-01-24T16:00:01.000Z",
        "fieldDesc": "佳佳测试"
      }
    ]
  },
  "msg": "操作成功"
}