获取限制查看通讯录设置列表新版SDK

更新于 2023-02-15

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，获取通讯录限制可见性设置信息列表。

企业在调用新增或修改限制查看通讯录设置接口后，可调用本接口分页查询企业下的限制查看通讯录设置的信息。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	通讯录数据可见范围管理权限	API Explorer
第三方企业应用	暂不支持	通讯录数据可见范围管理权限	暂不支持
第三方个人应用	暂不支持	通讯录数据可见范围管理权限	暂不支持

名称	类型	是否必填	描述
x-acs-dingtalk-access-token	String	是	调用该接口的访问凭证。企业内部应用可调用获取企业内部应用的accessToken接口获取。

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

是

调用该接口的访问凭证。

名称	类型	是否必填	描述
nextToken	Long	否	分页游标。首次调用，该参数不传。非首次调用，该参数传上次调用时返回的nextToken。
maxResults	Integer	否	最大返回结果数，最大值100。

名称

类型

是否必填

描述

nextToken

Long

否

分页游标。

maxResults

Integer

否

最大返回结果数，最大值100。

名称	类型	描述
hasMore	Boolean	是否还有更多数据。 true：是 false：否
nextToken	Long	分页游标。
list	Array	限制查看通讯录设置列表。
id	Long	设置Id。
name	String	限制查看通讯录设置名称。
description	String	限制查看通讯录描述。
subjectUserIds	Array of String	限制查看通讯录的用户userId列表。
subjectDeptIds	Array of Long	限制查看通讯录的部门deptId列表。
subjectTagIds	Array of Long	限制查看通讯录的角色roleId。
type	String	限制类型。 excludeNode: 只能看到白名单里的用户和部门。 onlySelf: 只能看到自己。 onlySelfDeptAndChild: 只能看到自己所在部门及子部门。
excludeUserIds	Array of String	白名单内用户userId列表。
excludeDeptIds	Array of Long	白名单内的部门deptId列表。
excludeTagIds	Array of Long	白名单内角色roleId列表。
active	Boolean	是否生效。 true：生效 false：不生效。
restrictInUserProfile	Boolean	是否同时限制查看个人资料页。 true：是 false：否
restrictInSearch	Boolean	是否同时限制搜索。 true：是 false：否