常见问题

本文汇总了使用通讯录 API 期间可能遇到的常见问题与解决方案。

通讯录权限范围相关

通讯录权限范围和应用可用范围有什么区别？

通讯录权限范围和应用可用范围是两个不同的概念，请注意区分。两者区别说明如下所示，详细的介绍参考通讯录权限范围介绍、配置应用可用范围。

通讯录权限范围定义了应用在调用通讯录 API 时可获取的部门、用户的数据范围。应用无法访问不在通讯录权限范围内的数据。例如，以应用身份调用修改用户部分信息接口修改用户信息时，该用户必须要在应用的通讯录权限范围内。

应用可用范围定义了可以使用该应用的企业成员范围，不在该范围内的企业成员无权限使用该应用。例如，应用可用范围包含用户 A，不包含用户 B，则用户 A 可以在飞书客户端搜索到并使用该应用，但用户 B 无法搜索到并使用该应用。

调用通讯录接口需要哪些权限？

通讯录目前包含成员、部门、用户组等几大模块，每个模块都会提供对应的 API 接口，便于你进行智能化的系统对接。当你使用接口时，相关权限要求主要分为三类。

权限类型	说明
接口权限要求	定义应用有无权限调用该接口。如果没有权限，则无法访问接口。
通讯录权限范围	定义应用可以查询或操作的部门和用户的数据范围。当你调用接口获取或操作某数据时，如果没有该数据的通讯录权限，则会报错提示无权限。更多信息可参见权限范围详解。
字段权限要求	由于某些实体（例如用户）对不同字段的敏感度不同（例如用户的手机号相对比较敏感），要获取该类字段则需要申请额外的权限。如果没有指定字段的获取权限，则无法获取该字段的信息。

对于接口权限和字段权限的要求，你可以通过相应的 API 文档获取。如下图：

场景示例：某开发者需要调用创建用户接口，向企业中添加用户。

该开发者需要为应用开通创建用户 API 的 更新通讯录 权限。

由于需要将用户添加到某个（或多个）部门下，因此该开发者需要确保应用的通讯录权限范围包含待加入的部门。

调用接口创建用户后，响应结果中会包含用户 ID 等敏感字段，如需成功获取这些敏感字段，还需要为应用开通敏感字段的权限。

调用接口或者接收事件消息时，为什么获取不到 user_id、邮箱、手机号等信息？

问题原因：应用未申请接口或事件所需的权限，或对应的用户不在应用的通讯录权限范围内。

排查方案：

确保应用已开通了调用接口所需的接口权限，以及 user_id、邮箱、手机号等敏感信息的字段权限。如何申请 API 权限，参见申请 API 权限。

确保应用配置的通讯录权限范围包含了所要查询的用户。如何配置通讯录权限范围，参见权限范围详解。

tenant_access_token 与 user_accss_token 的权限差异是什么？

二者获取或操作数据时，权限过滤范围不一样。

tenant_access_token 基于应用的通讯录权限范围进行权限的过滤。例如，调用接口获取部门 A 信息时，会检查部门 A 是否在应用的通讯录权限范围内。

应用开发者可以在开发者后台为自己的应用配置通讯录权限范围。详情参见权限范围详解。

企业管理员可以在管理后台 > 工作台 > 应用管理 页面，进入指定应用配置页来调整应用的 通讯录设置。

user_accss_token 基于用户的可见组织架构范围来做权限过滤。用户可见的组织架构范围为 App 端上 通讯录 > 组织架构 部分可见的信息。企业管理员可以在管理后台 > 安全 > 成员权限 页面，配置 组织架构可见范围。

在部分接口中，使用 tenant_access_token 和 user_access_token 存在一定的差异，具体可参见 API 文档的置顶说明。例如获取单个部门信息。

如何获取企业全部员工的信息？

开放平台目前没有单独的接口可以直接获得全部员工信息。如果你需要获取企业内全部员工的信息，可以按照以下操作获取。

确保调用 API 的应用已开启了全部员工的通讯录权限范围。

调用获取子部门列表接口，设置 fetch_child 值为 true，递归获取企业内所有部门 ID。

根据获取到的部门 ID 列表，调用获取部门直属用户列表接口，来获得全部员工的相关信息。

如何获取根部门下的员工信息？

确保调用 API 的应用通讯录权限范围设置为全部员工，或包含了根部门下的所有员工。

调用获取部门直属用户列表接口，设置参数 department_id 为 0，获得根部门下的员工信息。

用户 ID 相关

为什么调用通过手机号或邮箱获取用户 ID接口不返回用户 ID？

导致不返回用户 ID 的原因有多种，你可以按照以下思路进行排查。

确认请求头 Authorization 传入了正确的应用身份令牌（tenant_access_token），注意应用不要选择错误，例如，当前业务场景需要使用应用 A1，但因为应用名称相仿而传入了应用 A2 的 tenant_access_token。

如果输入的手机号或者邮箱地址在企业内不存在，接口不会报错，而是只返回手机号或者邮箱。因此你需要确保输入的手机号或者邮箱在企业内有相匹配的员工。

注意：使用企业邮箱查询将无法返回用户 ID，必须使用用户的邮箱地址。

如果用户已离职，且调用接口时请求参数 include_resigned 取值为 false（表示查询结果不包含离职员工的用户信息），则不会返回离职用户 ID。

企业自建应用获取用户的 user_id 时，必须开通 获取用户 user ID（contact:user.employee_id:readonly） 权限。如未开通，需登录开发者后台，在应用详情页的 开发配置 > 权限管理 > API 权限 功能页开通权限，并需要发布应用使配置生效。如何申请 API 权限的详细介绍参见申请 API 权限。

如果应用没有某一用户的数据权限，则无法返回该用户的 ID，你可登录开发者后台，在应用详情页的 开发配置 > 权限管理 > 数据权限 功能页查看 通讯录权限范围 内是否有待查询的用户，如果没有则需要在 通讯录权限范围 内添加上该用户，并需要发布应用使配置生效。具体操作参考配置应用数据权限。

注意：如果通讯录权限范围设置的是 与应用的可用范围一致，则你需要在应用发布阶段（点击 应用发布 > 版本管理与发布 > 创建版本 后的 版本详情 页面内）配置应用的可用范围，并发布应用使配置生效。具体操作参考配置应用可用范围。

同一个用户在多个应用内的 open_id 是一样的吗？

不一样。open_id 是用户在应用内唯一标识，同一用户在不同应用中的 open_id 不一样。

同一用户在不同企业内的 open_id 和 union_id 是一样的吗？

不一样。同一用户在不同的企业内属于两个不同的用户实体，相应的 open_id 和 union_id 也不同。

user_id 是否可以更新？

可以。你可以调用更新用户ID接口进行更新。

如何获取 user_id？

方式一：通过邮箱或手机号获取。获取方式见接口使用手机号或邮箱获取用户 ID。

方式二：登录管理后台，在组织架构中找到具体用户并点击查看用户详情，在用户详情中获取用户 ID。

用户/人员相关

误删了部门或者用户后，是否能按照原有的 ID 恢复？

不能。目前不能恢复原有的 department_id 或者 user_id。企业内 department_id 或者 user_id 是唯一的，建议你新增一个 department_id 或者 user_id。

如何判断某个应用的用户是否在使用我开发的其他应用？

目前可以使用字段 union_id 进行判断。一个用户在同一个开发者所属的多个应用中，union_id 唯一。

搜索用户接口为什么获取不到返回值？

如果调用搜索用户接口获取不到返回值，你可以通过以下方式排查原因：

确认待搜索的用户可以在飞书客户端的搜索栏中搜索到，且该用户不是外部用户或离职人员。

如果调用 API 时设置了分页查询参数 page_token，则需要确认该参数的值填写正确。

为什么不能通过手机号、邮箱获取到指定用户信息？

你需要排查调用 API 的应用通讯录权限范围包含待查询的用户。如果通讯录范围不包含待查询的用户，则调用 API 时会返回邮箱或手机号不存在的报错提示。如何设置通讯录权限范围，可参见权限范围详解。

用户什么时候会被自动拉入部门群？

当部门成员进行调整（入职、离职、更新人员类型、更新部门负责人）时，会被自动拉入部门群。

被删除的用户的 user_id 会被后续新增的用户占用吗？

user_id 可能会被新增的员工占用。

系统默认生成的 user_id 在企业内是有效用户（无效表示已离职用户）的唯一 ID。当开发者或管理员对用户进行删除，再添加新用户时，可能会存在新添加的用户的 user_id 和历史上已经删除的用户 user_id 一致的情况。因此建议你在新增用户时，使用具有唯一性标示的 ID 作为 user_id，避免造成相关困扰。

说明： 部门的自定义 ID 设置逻辑与 user_id 一致。

如何查询离职员工的信息？

调用通过手机号或邮箱获取用户 ID接口，查询包含离职员工的用户信息（include_resigned 取值为 true）。

调用获取单个用户信息接口，通过离职员工的用户 ID 获取具体信息。

用户接口相关

如何理解用户属性中的自定义字段？

在创建用户和获取单个用户信息接口中，包含了用户自定义字段（custom_attrs），该字段是对用户属性的扩展，用于为企业提供根据自身需求灵活扩展用户描述的能力。自定义字段根据取值语法的不同，主要分为：文本类型、网页类型、枚举类型、图片类型、用户类型。

如需调用 API 时使用该自定义字段，则需要确保：

企业管理员在管理后台 > 组织架构 > 字段管理 > 字段设置 页面，点击 API 调用设置 并开启 允许开放平台通讯录 API 调用 的开关。

企业管理员在管理后台 > 组织架构 > 字段管理 > 字段设置 > 自定义字段 页面，已新增自定义字段。

各类型自定义字段详细介绍如下表所示。

类型	描述
文本类型	纯文本用户属性。该类型字段只有一个 string 类型的 value，取值对应接口内 `value` 的 `text` 字段。
网页类型	包含文本和跳转链接的用户属性。该属性如果展示在成员名片页，可实现点击跳转的效果。在相应的接口内，使用该类型字段时需要配置：标题文字，取值对应接口内 `value` 的 `text` 字段。跳转链接，取值对应接口内 `value` 的 `url` 字段。由于 PC 端的跳转链接可能和移动端不一样，所以接口单独设置了 `pc_url` 字段作为 PC 端的跳转链接，如果不设置该值，则 PC 端的跳转链接为 `url` 字段。
枚举类型	包含一个或多个选项的用户属性。例如员工类型字段，可以设置正式、外包、顾问等企业成员类型枚举值，当为用户设置属性时只能在这些选项中选择。当你在接口内设置该类型的自定义字段时，需要在接口 `value` 的 `option_id` 字段内传入选项名（即管理员在管理后台配置的某个选项的名称）。
图片类型	该类型与枚举类型相似，不同的是对应的选项数据必须是图片，用于在成员名片页展示其对应的图片。当你在接口内设置该类型的自定义字段时，需要在接口 `value` 的 `option_id` 字段内传入图片 id（管理员可从管理后台查询到对应的图片 id）。说明：图片类型内测中，如需了解可咨询开放平台技术支持。
用户类型	该类型主要用于在成员名片页展示对企业其他人员的引用，从而实现成员名片页之间的跳转。例如将张三的 HRBP 字段展示为李四，并支持点击跳转至李四的名片页。当你在接口内设置该类型的自定义字段时，需要在接口 `generic_user` 中设置对应的用户 user_id（`id`）和用户类型（`type`）。

如何使用创建用户接口中的 enterprise_email 字段？

创建用户接口中的 enterprise_email 字段表示设置用户的企业邮箱。企业邮箱的域名需要企业在管理后台申请并开启。如果企业没有开启对应域名的企业邮箱，当你在创建用户接口内设置用户企业邮箱时会操作失败，此时需要你联系企业管理员确认企业是否在后台启用了该域名的企业邮箱。

如何理解获取用户列表接口？

获取用户列表接口是用于获取某个部门下的直属用户列表，其数据的获取受到通讯录权限范围的限制，说明如下：

如果请求带上了部门 ID，接口首先会检查应用是否有该部门的通讯录权限。如果有，则会返回该部门下的直属成员信息。

根部门的部门 ID 为 0，如果请求时带上了 department_id 为 0 则接口会检查应用是否有根部门的通讯录权限，如果有，则返回根部门下直属成员信息。

如果请求没有带上部门 ID，接口无法对应用进行部门 ID 的通讯录权限校验，则接口会获取到权限范围内的独立成员。

独立成员是指：当应用的通讯录权限范围包含了某成员，但不包含成员所在部门时，该成员视为权限范围内的独立成员。

因此，建议你在使用该接口时，应结合通讯录的权限以及要获取的数据，来决定要不要在请求中带上部门 ID。

部门接口相关

如何获取父部门下所有员工的通讯录信息？

目前不支持通过一个接口来获取父部门下所有员工的通讯录信息，你可以通过接口组合实现：

调用获取部门信息列表接口，获取父部门下所有部门的 department_id。

调用获取部门直属用户列表接口，获取每个部门下员工的通讯录信息。

为什么获取到的 department_id 有的带 od- 前缀，有的不带？

问题场景：通过获取单个部门信息接口获取到 department_id，有时带有 od- 前缀，有时不带。

解决方案：请确认各请求之间是否指定了不同的 department_id_type，如果 department_id_type 取值为 open_department_id，则会带有 od- 前缀。关于 department_id 的详细介绍，参见通用参数。

如何理解获取部门信息列表接口？

获取部门信息列表接口用于获取部门下的子部门信息，其数据的获取受到通讯录权限范围的限制：

如果请求带上了父部门 ID，接口首先会检查应用是否有该部门的通讯录权限，如果有，则返回该部门下的子部门信息，并根据 fetch_child 的取值来决定是否递归查询子部门信息。

根部门的部门 ID 为 0，如果请求时父部门 ID 传值 0，则接口会校验应用是否有全员权限。

如果请求没有带上父部门 ID，接口将无法对应用进行部门通讯录权限校验，此时接口会根据应用的通讯录权限范围返回数据。如果应用的通讯录权限范围是全员，则会返回单个根部门 ID。

根部门的部门 ID 为 0，你可以使用根部门 ID 发起请求，否则接口直接返回应用的通讯录权限范围内的部门信息。

因此建议你在使用该接口时，应该结合通讯录的权限以及要获取的数据，来决定请求中是否带上父部门 ID。

错误排查

使用批量获取信息接口时，没有获取到完整的信息，但是仍提示执行成功是什么原因？

问题场景：使用批量获取信息接口时，只返回部分信息，没有返回全部批量信息，并且接口提示任务执行成功（msg 返回 success）。

问题原因：批量接口的返回值是指当前批量任务的执行情况，代表是否执行，而非是否执行成功，因此接口返回的 msg 为 success 仅表示接口成功执行了。你可以通过查询批量任务执行状态接口获取任务详细的执行情况。

新增用户接口返回 email and mobile account conflict 是什么原因？

问题场景：调用新增用户接口返回 email and mobile account conflict 报错。

问题原因：如果使用手机号和邮箱分别注册了两个不同的账号，则手机号和邮箱分别对应登录凭证不同的两个账号。此时新增用户，同时设置手机号与邮箱，则接口无法判断应当关联到哪一个账号上，从而报上述错误。

解决方案：注销其中一个账号，再尝试新增用户。

新增用户接口返回 department id xxxxxxxx is not exist 是什么原因？

问题场景：调用新增用户返回 department id xxxxxxxx is not exist 报错。

解决方案：

确认写入的 department id 是否存在。

确认是否误用了 open_department_id。open_department_id 和 department_id 是两个不同的 ID。

确认应用是否在该部门的通讯录权限范围内。

通讯录权限范围相关#

通讯录权限范围和应用可用范围有什么区别？#

调用通讯录接口需要哪些权限？#

调用接口或者接收事件消息时，为什么获取不到 user_id、邮箱、手机号等信息？#

tenant_access_token 与 user_accss_token 的权限差异是什么？#

如何获取企业全部员工的信息？#

如何获取根部门下的员工信息？#

用户 ID 相关#

为什么调用通过手机号或邮箱获取用户 ID接口不返回用户 ID？#

同一个用户在多个应用内的 open_id 是一样的吗？#

同一用户在不同企业内的 open_id 和 union_id 是一样的吗？#

user_id 是否可以更新？#

如何获取 user_id？#

用户/人员相关#

误删了部门或者用户后，是否能按照原有的 ID 恢复？#

如何判断某个应用的用户是否在使用我开发的其他应用？#

搜索用户接口为什么获取不到返回值？#

为什么不能通过手机号、邮箱获取到指定用户信息？#

用户什么时候会被自动拉入部门群？#

被删除的用户的 user_id 会被后续新增的用户占用吗？#

如何查询离职员工的信息？#

用户接口相关#

如何理解用户属性中的自定义字段？#

如何使用创建用户接口中的 enterprise_email 字段？#

如何理解获取用户列表接口？#

部门接口相关#

如何获取父部门下所有员工的通讯录信息？#

为什么获取到的 department_id 有的带 od- 前缀，有的不带？#

如何理解获取部门信息列表接口？#

错误排查#

使用批量获取信息接口时，没有获取到完整的信息，但是仍提示执行成功是什么原因？#

新增用户接口返回 email and mobile account conflict 是什么原因？#

新增用户接口返回 department id xxxxxxxx is not exist 是什么原因？#