# 获取应用通讯录权限范围配置 获取当前企业内某个自建应用线上实际生效的通讯录权限范围配置。 **注意事项**：通讯录权限范围是指应用在调用通讯录相关接口，可以获取的部门和用户的数据范围。应用无法获取权限范围之外的通讯录数据。 ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/application/v6/applications/:app_id/contacts_range_configuration HTTP Method | GET 接口频率限制 | [100 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取应用信息(admin:app.info:readonly) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取用户 user ID(contact:user.employee_id:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) ### 路径参数 名称 | 类型 | 描述 ---|---|--- app_id | string | 应用的 app_id，可以在[开发者后台](https://open.feishu.cn/app) > 凭证与基础信息页查看。
**示例值**："cli_9b445f5258795107" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- page_size | int | 否 | 分页大小
**示例值**：20
**默认值**：`50`
**数据校验规则**：
- 取值范围：`1` ～ `100` page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**：new-e3c5a0627cdf0c2e057da7257b90376a department_id_type | string | 否 | 返回值的部门ID的类型
**示例值**：department_id
**可选值有**：
- department_id：以自定义department_id来标识部门
- open_department_id：以open_department_id来标识部门
**默认值**：`open_department_id` user_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- contacts_range | application.app_contacts_range | 获取线上已生效的通讯录权限范围配置 contacts_scope_type | string | 通讯录可见性类型
**可选值有**：
- equal_to_availability：与应用可用范围一致，可通过[获取应用在企业内的可用范围](https://open.feishu.cn/document/ukTMukTMukTM/uIjM3UjLyIzN14iMycTN)接口查询具体人员
- some：部分成员，具体人员参见visible_list
- all：全部成员 visible_list | app_visible_list | 通讯录权限范围的可用名单 open_ids | string\[\] | 通讯录权限范围的可用成员 id 列表，按照user_id_type返回 department_ids | string\[\] | 通讯录权限范围的可用部门的 id 列表 group_ids | string\[\] | 通讯录权限范围的可用用户组 id 列表 has_more | boolean | 是否还有更多项 page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "contacts_range": { "contacts_scope_type": "some", "visible_list": { "open_ids": [ "ou_4065981088f8ef67a504ba8bd6b24d85" ], "department_ids": [ "od-4b4a6907ad726ea07b27b0d2882b7c65" ], "group_ids": [ "b6d1g5dd6fd26186" ] } }, "has_more": true, "page_token": "new-e3c5a0627cdf0c2e057da7257b90376a" } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 210503 | invalid app_id | 请检查请求路径中的 app_id 是否合法 400 | 210504 | no such app in tenant | 请检查被查询应用与当前调用接口应用是否在同一企业内 400 | 210505 | target app not a custom app | 请检查被查询应用是否是自建应用 400 | 210506 | no such app | 请检查请求路径中的 app_id 是否存在 400 | 210501 | invalid page_token | page_token 在应用间不互通，请检查该 page_token 是否由调用接口的应用获取到 400 | 210500 | page_token does not exist or has expired | 请检查 page_token 是否合法，page_token 过期时间为 2h，若超过 2h 请重新获取