更新应用通讯录权限范围配置

该接口用于更新当前企业内自建应用或已安装的商店应用的通讯录权限范围配置。更新后线上立即生效。

Tip: 通讯录权限范围是指应用在调用通讯录相关接口，可以获取的部门和用户的数据范围。应用无法获取权限范围之外的通讯录数据。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/application/v6/applications/:app_id/contacts_range
HTTP Method	PATCH
接口频率限制	20 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	application:application.contacts_range:write 更新应用通讯录权限范围
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
app_id	string	应用id 示例值："cli_dsfjksdfee1"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
department_id_type	string	否	部门id类型 示例值：open_department_id 可选值有： - open_department_id: 以open_department_id标识部门 - department_id: 以department_id标识部门 默认值：open_department_id

请求体

名称	类型	必填	描述
contacts_range_type	string	是	更新范围方式 示例值："some" 可选值有： - equal_to_availability: 与应用可用性始终保持一致 - some: 部分成员 - all: 全部成员范围
add_visible_list	app_contacts_range_id_list	否	通讯录权限范围新增列表 仅contacts_range_type为some 时生效并进行增量更新
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 示例值：["ou_7dab8a3d3cdcc9da365777c7ad535d62"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组列表 示例值：["g12334"] 数据校验规则： - 最大长度：100
del_visible_list	app_contacts_range_id_list	否	从通讯录权限范围删除的列表 仅contacts_range_type为some 时生效并进行增量更新
└ user_ids	string\[\]	否	成员id列表 id类型根据user_id_type参数指定 示例值：["ou_7dab8a3d3cdcc9da365777c7ad535d62"] 数据校验规则： - 最大长度：100
└ department_ids	string\[\]	否	部门id列表 id类型根据department_id_type参数指定 示例值：["od-4e6ac4d14bcd5071a37a39de902c7141"] 数据校验规则： - 最大长度：100
└ group_ids	string\[\]	否	用户组列表 示例值：["g12334"] 数据校验规则： - 最大长度：100

请求体示例

{
    "contacts_range_type": "some",
    "add_visible_list": {
        "user_ids": [
            "ou_7dab8a3d3cdcc9da365777c7ad535d62"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g12334"
        ]
    },
    "del_visible_list": {
        "user_ids": [
            "ou_7dab8a3d3cdcc9da365777c7ad535d62"
        ],
        "department_ids": [
            "od-4e6ac4d14bcd5071a37a39de902c7141"
        ],
        "group_ids": [
            "g12334"
        ]
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	210001	param is invalid	检查参数是否合法
200	210002	invalid app_id or app not exists	检查app_id对应的应用是否存在且是否被企业安装
200	210003	please check if param is empty or if there is conflicts between add and del list	检查add_visible_list/del_visible_list 中的元素是否有冲突
200	210004	server internal error	服务内部错误
200	210005	invalid group_ids	检查group_id 是否正确
200	210006	can not modify cantact of special app or official app	检查应用是否为飞书官方应用或者其他在企业管理后台无法修改通讯录范围的应用