资源介绍

资源定义

飞书某个企业里的一个用户。

飞书为用户设置了多种用户身份标识，包括 user_id、open_id 和 union_id，有关用户身份的详细介绍，请参考用户相关的 ID 概念。

用户状态转换逻辑如下图所示：

字段说明

名称	类型	描述
user_id	string	租户内用户的唯一标识，该值可以自定义也可以由系统随机生成。详细定义参见什么是 User ID；获取方式参见如何获得 User ID、Open ID 和 Union ID自定义`user_id`数据校验规则：最大长度：`64` 字符正则校验：不能包含空格字示例值："u273y71"字段权限要求：获取用户的user_id
open_id	string	应用内用户的唯一标识，详细定义参见什么是 Open ID；获取方式参见如何获得 User ID、Open ID 和 Union ID示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"
union_id	string	用户的唯一标识，帮助应用开发商把其开发的多个应用中的同个用户关联起来，详细定义参见什么是 Union ID；获取方式参见如何获得 User ID、Open ID 和 Union ID示例值："on_cad4860e7af114fb4ff6c5d496d1dd76"
name	string	用户名示例值："张三"数据校验规则：最小长度：`1` 字符最大长度：`64` 字符字段权限要求（满足任一）：获取用户基本信息以应用身份读取通讯录
en_name	string	英文名示例值："San Zhang"字段权限要求（满足任一）：获取用户基本信息以应用身份读取通讯录
email	string	邮箱示例值："zhangsan@gmail.com"字段权限要求：获取用户邮箱信息
mobile	string	手机号，在本企业内不可重复；未认证企业仅支持添加中国大陆手机号，通过飞书认证的企业允许添加海外手机号示例值："13011111111"字段权限要求：获取用户手机号
mobile_visible	boolean	手机号码可见性，true 为可见，false 为不可见，目前默认为 true。不可见时，组织员工将无法查看该员工的手机号码示例值：false
gender	int	性别示例值：1可选值有：`0`：保密`1`：男`2`：女字段权限要求（满足任一）：获取用户性别以应用身份读取通讯录
avatar_key	string	头像的文件Key，可通过“消息与群组/消息/图片信息”中的“上传图片”接口上传并获取头像文件 Key"上传图片"接口使用方式参见上传图片示例值："2500c7a9-5fff-4d9a-a2de-3d59614ae28g"
department_ids	string[]	用户所属部门的ID列表。不同ID的说明与department_id的获取方式参见部门ID说明示例值：od-4e6ac4d14bcd5071a37a39de902c7141
leader_user_id	string	用户的直接主管的用户ID示例值："ou_7dab8a3d3cdcc9da365777c7ad535d62"
city	string	工作城市示例值："杭州"字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
country	string	国家或地区。格式为国家或地区缩写Code，具体参见列表示例值："CN"字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
work_station	string	工位示例值："北楼-H34"字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
join_time	int	入职时间示例值：2147483647字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
employee_no	string	工号示例值："1"字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
employee_type	int	员工类型，可选值有：1：正式员工2：实习生3：外包4：劳务5：顾问同时可读取到自定义员工类型的 int 值，可通过下方接口获取到该租户的自定义员工类型的名称获取人员类型参见查询人员类型示例值：1
orders	user_order[]	用户排序信息。用于标记通讯录下组织架构的人员顺序，人员可能存在多个部门中，且有不同的排序。
∟ department_id	string	排序信息对应的部门ID。不同ID的说明与department_id的获取方式参见部门ID说明示例值："od-4e6ac4d14bcd5071a37a39de902c7141"
∟ user_order	int	用户在其直属部门内的排序，数值越大，排序越靠前示例值：100
∟ department_order	int	用户所属的多个部门间的排序，数值越大，排序越靠前示例值：100
custom_attrs	user_custom_attr[]	自定义字段字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
∟ type	string	自定义字段类型`TEXT`：文本`HREF`：网页`ENUMERATION`：枚举`PICTURE_ENUM`：图片`GENERIC_USER`：用户如有问题请查阅自定义字段相关常见问题示例值："TEXT"
∟ id	string	自定义字段ID示例值："DemoId"
∟ value	user_custom_attr_value	自定义字段取值, 取值参考常见问题的用户接口相关问题
∟ text	string	字段类型为 TEXT 时该参数定义字段值，字段类型为 HREF 时该参数定义网页标题示例值："DemoText"
∟ url	string	字段类型为 HREF 时，该参数定义默认 URL示例值："http://www.fs.cn"
∟ pc_url	string	字段类型为 HREF 时，该参数定义PC端 URL示例值："http://www.fs.cn"
∟ option_id	string	字段类型为 ENUMERATION 或 PICTURE_ENUM 时，该参数定义选项值示例值："edcvfrtg"
∟ generic_user	custom_attr_generic_user	字段类型为 GENERIC_USER 时，该参数定义引用人员，主要用于成员名片页展示对另一用户的引用，实现成员名片页之间的跳转
∟ id	string	被引用的用户的user_id示例值："9b2fabg5"
∟ type	int	用户类型1：用户示例值：1
enterprise_email	string	企业邮箱，请先确保已在管理后台启用飞书邮箱服务示例值："demo@mail.com"字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录
job_title	string	职务字段权限要求（满足任一）：获取用户受雇信息以应用身份读取通讯录

数据示例

{
    "user_id": "u273y71",
    "open_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
    "union_id": "ou_be2c1742f2bb189469bdd33f0b1516ea",
    "name": "张三",
    "en_name": "San Zhang",
    "email": "zhangsan@gmail.com",
    "mobile": "13011111111",
    "mobile_visible": false,
    "gender": 1,
    "avatar_key": "2500c7a9-5fff-4d9a-a2de-3d59614ae28g",
    "department_ids": [
        "od-4e6ac4d14bcd5071a37a39de902c7141"
    ],
    "leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
    "city": "杭州",
    "country": "CN",
    "work_station": "北楼-H34",
    "join_time": 2147483647,
    "employee_no": "1",
    "employee_type": 1,
    "orders": [
        {
            "department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
            "user_order": 100,
            "department_order": 100
        }
    ],
    "custom_attrs": [
        {
            "type": "TEXT",
            "id": "DemoId",
            "value": {
                "text": "DemoText",
                "url": "http://www.fs.cn",
                "pc_url": "http://www.fs.cn",
                "option_id": "edcvfrtg",
                "generic_user": {
                    "id": "9b2fabg5",
                    "type": 1
                }
            }
        }
    ],
    "enterprise_email": "demo@mail.com",
    "job_title": "xxxxx",
    "notification_option": {
        "channels": [
            "sms"
        ],
        "language": "zh-CN"
    }
}

资源定义#

字段说明#

数据示例#

资源定义

字段说明

数据示例