跳转到主要内容
调用通讯录相关接口前，需要添加通讯录接口权限，可通过当前接口获取通讯录权限范围。

​
接口调用说明

本文接口是旧版规范服务端API，如何调用参见旧版API VS 新版API。
对于通讯录相关的接口，在调用前管理员必须在钉钉开发者后台先申请对应的接口权限，并指定这些接口可以获取哪些通讯录范围。 如下图所示，当前应用的access_token只具备管理部门A的通讯录权限。开发者可以先调用本接口查看应用的通讯录授权范围。通信录示意图开发者在调用通讯录接口时，只能获取到在授权范围内的员工通讯录信息，获取非授权范围内的员工通讯录信息会提示获取部门/员工不在授权范围内。

​
请求

基本信息
HTTP URLhttps://oapi.dingtalk.io/auth/scopes
HTTP MethodGET
支持的应用类型appType-企业内部应用appType-第三方企业应用
权限要求permission-qyapi_base-调用企业API时需要具备的基本权限

​
查询参数

名称类型是否必填示例值描述
access_tokenString是6ed1bxxx调用该API的应用凭证。 - 企业内部应用，通过获取企业内部应用的access_token接口获取。 - 第三方企业应用，通过获取第三方企业的access_token接口获取。

​
请求示例

curl -X GET "https://oapi.dingtalk.io/auth/scopes" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2314cdxxxxbcd10713'
Java 
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/auth/scopes");
OapiAuthScopesRequest req = new OapiAuthScopesRequest();
req.setHttpMethod("GET");
OapiAuthScopesResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
Python 
import dingtalk.api

req=dingtalk.api.OapiAuthScopesRequest("https://oapi.dingtalk.io/auth/scopes")
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)
PHP 
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAuthScopesRequest;
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/auth/scopes");
C# 
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/auth/scopes");
OapiAuthScopesRequest req = new OapiAuthScopesRequest();
req.SetHttpMethod("GET");
OapiAuthScopesResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

​
响应

​
响应体

名称类型示例值描述
auth_org_scopesAuthOrgScopes授权信息。
authed_userString[][“user1”,“user”]授权可获取通信录信息的员工userid列表。
authed_deptNumber[][1,2,3]授权可获取通信录信息的部门ID列表。
auth_user_fieldString[][“name”,“email”]授权可获取的企业用户字段。
errmsgStringok返回码描述。
errcodeNumber0返回码。

​
响应体示例

{
        "errcode":0,
        "condition_field":[],
        "auth_user_field":[
                "jobnumber",
                "isLeader",
                "name",
                "position",
                "isAdmin",
                "avatar",
                "department",
                "userid",
                "deviceId",
                "isHide"
        ],
        "auth_org_scopes":{
                "authed_user":[],
                "authed_dept":[
                        1
                ]
        },
        "errmsg":"ok"
}

​
错误码

若调用该接口报错，可根据错误信息在全局错误码文档中查找解决方案。